Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SDK README - api.video-swift-client] Update Summary endpoints #478

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions sdks/api-clients/apivideo-swift5-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ api.video's Swift API client for iOS, macOS and tvOS streamlines the coding proc
Specify it in your `Cartfile`:

```
github "apivideo/api.video-swift-client" ~> 1.3.4
github "apivideo/api.video-swift-client" ~> 1.3.7
```

Run `carthage update`

#### CocoaPods

Add `pod 'ApiVideoClient', '1.3.4'` in your `Podfile`
Add `pod 'ApiVideoClient', '1.3.7'` in your `Podfile`

Run `pod install`

Expand Down Expand Up @@ -155,6 +155,25 @@ Method | HTTP request | Description
[**deleteLogo**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/PlayerThemesAPI.md#deleteLogo) | **DELETE** `/players/\{playerId}/logo` | Delete logo


#### SummariesAPI

##### Retrieve an instance of SummariesAPI:

```swift
SummariesAPI
```

##### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/SummariesAPI.md#create) | **POST** `/summaries` | Generate video summary
[**update**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/SummariesAPI.md#update) | **PATCH** `/summaries/\{summaryId}/source` | Update summary details
[**delete**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/SummariesAPI.md#delete) | **DELETE** `/summaries/{summaryId}` | Delete video summary
[**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/SummariesAPI.md#list) | **GET** `/summaries` | List summaries
[**getSummarySource**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/SummariesAPI.md#getSummarySource) | **GET** `/summaries/\{summaryId}/source` | Get summary details


#### TagsAPI

##### Retrieve an instance of TagsAPI:
Expand Down Expand Up @@ -275,6 +294,7 @@ Method | HTTP request | Description
- [CaptionsUpdatePayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/CaptionsUpdatePayload.md)
- [Chapter](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Chapter.md)
- [ChaptersListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/ChaptersListResponse.md)
- [ConflictError](https://github.com/apivideo/api.video-swift-client/blob/main/docs/ConflictError.md)
- [DiscardedVideoUpdatePayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/DiscardedVideoUpdatePayload.md)
- [FilterBy](https://github.com/apivideo/api.video-swift-client/blob/main/docs/FilterBy.md)
- [FilterBy1](https://github.com/apivideo/api.video-swift-client/blob/main/docs/FilterBy1.md)
Expand Down Expand Up @@ -302,6 +322,11 @@ Method | HTTP request | Description
- [RefreshTokenPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/RefreshTokenPayload.md)
- [RestreamsRequestObject](https://github.com/apivideo/api.video-swift-client/blob/main/docs/RestreamsRequestObject.md)
- [RestreamsResponseObject](https://github.com/apivideo/api.video-swift-client/blob/main/docs/RestreamsResponseObject.md)
- [SummariesListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/SummariesListResponse.md)
- [Summary](https://github.com/apivideo/api.video-swift-client/blob/main/docs/Summary.md)
- [SummaryCreationPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/SummaryCreationPayload.md)
- [SummarySource](https://github.com/apivideo/api.video-swift-client/blob/main/docs/SummarySource.md)
- [SummaryUpdatePayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/SummaryUpdatePayload.md)
- [TokenCreationPayload](https://github.com/apivideo/api.video-swift-client/blob/main/docs/TokenCreationPayload.md)
- [TokenListResponse](https://github.com/apivideo/api.video-swift-client/blob/main/docs/TokenListResponse.md)
- [TooManyRequests](https://github.com/apivideo/api.video-swift-client/blob/main/docs/TooManyRequests.md)
Expand Down
Loading