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

Add summary feature #94

Merged
merged 1 commit into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
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
14 changes: 14 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Sources/APIs/CaptionsAPI.swift
Sources/APIs/ChaptersAPI.swift
Sources/APIs/LiveStreamsAPI.swift
Sources/APIs/PlayerThemesAPI.swift
Sources/APIs/SummariesAPI.swift
Sources/APIs/TagsAPI.swift
Sources/APIs/UploadTokensAPI.swift
Sources/APIs/VideosAPI.swift
Expand Down Expand Up @@ -47,6 +48,7 @@ Sources/Models/CaptionsListResponse.swift
Sources/Models/CaptionsUpdatePayload.swift
Sources/Models/Chapter.swift
Sources/Models/ChaptersListResponse.swift
Sources/Models/ConflictError.swift
Sources/Models/DiscardedVideoUpdatePayload.swift
Sources/Models/Environment.swift
Sources/Models/FilterBy.swift
Expand Down Expand Up @@ -76,6 +78,11 @@ Sources/Models/Quality.swift
Sources/Models/RefreshTokenPayload.swift
Sources/Models/RestreamsRequestObject.swift
Sources/Models/RestreamsResponseObject.swift
Sources/Models/SummariesListResponse.swift
Sources/Models/Summary.swift
Sources/Models/SummaryCreationPayload.swift
Sources/Models/SummarySource.swift
Sources/Models/SummaryUpdatePayload.swift
Sources/Models/TokenCreationPayload.swift
Sources/Models/TokenListResponse.swift
Sources/Models/TooManyRequests.swift
Expand Down Expand Up @@ -134,6 +141,7 @@ docs/CaptionsUpdatePayload.md
docs/Chapter.md
docs/ChaptersAPI.md
docs/ChaptersListResponse.md
docs/ConflictError.md
docs/DiscardedVideoUpdatePayload.md
docs/FilterBy.md
docs/FilterBy1.md
Expand Down Expand Up @@ -163,6 +171,12 @@ docs/Quality.md
docs/RefreshTokenPayload.md
docs/RestreamsRequestObject.md
docs/RestreamsResponseObject.md
docs/SummariesAPI.md
docs/SummariesListResponse.md
docs/Summary.md
docs/SummaryCreationPayload.md
docs/SummarySource.md
docs/SummaryUpdatePayload.md
docs/TagsAPI.md
docs/TokenCreationPayload.md
docs/TokenListResponse.md
Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
Original file line number Diff line number Diff line change
@@ -1 +1 @@
6f374764cf476ad001123c84953d1980aaf6bc352573020d111594ab74058bf6
fa7f7f8c606b69d3dd31980ebbed0f1f0e18756b7544288b3b919f35d99b61bd
4 changes: 2 additions & 2 deletions ApiVideoClient.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Pod::Spec.new do |s|
s.tvos.deployment_target = '10.0'
# Add back when CocoaPods/CocoaPods#11558 is released
#s.watchos.deployment_target = '3.0'
s.version = '1.3.4'
s.source = { :git => 'https://github.com/apivideo/api.video-swift-client', :tag => 'v1.3.4' }
s.version = '1.3.5'
s.source = { :git => 'https://github.com/apivideo/api.video-swift-client', :tag => 'v1.3.5' }
s.authors = { 'Ecosystem Team' => '[email protected]' }
s.license = { :type => 'MIT' }
s.homepage = 'https://docs.api.video'
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Changelog
All changes to this project will be documented in this file.

## [1.3.5] - 2024-10-21
- Add summary feature
- Add support for Alamofire 5.10

## [1.3.4] - 2024-10-08
- Add transcript feature

Expand Down
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- [ChaptersAPI](#ChaptersAPI)
- [LiveStreamsAPI](#LiveStreamsAPI)
- [PlayerThemesAPI](#PlayerThemesAPI)
- [SummariesAPI](#SummariesAPI)
- [TagsAPI](#TagsAPI)
- [UploadTokensAPI](#UploadTokensAPI)
- [VideosAPI](#VideosAPI)
Expand Down Expand Up @@ -56,14 +57,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.5
```

Run `carthage update`

#### CocoaPods

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

Run `pod install`

Expand Down Expand Up @@ -190,6 +191,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 @@ -310,6 +330,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 @@ -337,6 +358,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
2 changes: 1 addition & 1 deletion Sources/APIs.swift
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import Foundation
public class ApiVideoClient {
public static var apiKey: String? = nil
public static var basePath = "https://ws.api.video"
internal static var customHeaders:[String: String] = ["AV-Origin-Client": "swift:1.3.4"]
internal static var customHeaders:[String: String] = ["AV-Origin-Client": "swift:1.3.5"]
private static var chunkSize: Int = 50 * 1024 * 1024
internal static var requestBuilderFactory: RequestBuilderFactory = AlamofireRequestBuilderFactory()
internal static var credential = ApiVideoCredential()
Expand Down
Loading
Loading