Add discarded videos feature

apivideo · Sep 16, 2024 · 9757f21 · 9757f21
1 parent 146ccbf
commit 9757f21
Show file tree

Hide file tree

Showing 67 changed files with 801 additions and 103 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -46,6 +46,7 @@ Sources/Models/CaptionsListResponse.swift
 Sources/Models/CaptionsUpdatePayload.swift
 Sources/Models/Chapter.swift
 Sources/Models/ChaptersListResponse.swift
+Sources/Models/DiscardedVideoUpdatePayload.swift
 Sources/Models/Environment.swift
 Sources/Models/FilterBy.swift
 Sources/Models/FilterBy1.swift
@@ -130,6 +131,7 @@ docs/CaptionsUpdatePayload.md
 docs/Chapter.md
 docs/ChaptersAPI.md
 docs/ChaptersListResponse.md
+docs/DiscardedVideoUpdatePayload.md
 docs/FilterBy.md
 docs/FilterBy1.md
 docs/FilterBy2.md

diff --git a/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256 b/.openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
@@ -1 +1 @@
-b89163ac996bc8f2bcaf0a054a6a9c28de9b0cf52e16fbcb17055f42852e2a57
+17ac0a7b292afb851962592fd7280e7727bb901d5d4e2a3f75808aa76a1ecdf5
diff --git a/ApiVideoClient.podspec b/ApiVideoClient.podspec
@@ -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.1'
-  s.source = { :git => 'https://github.com/apivideo/api.video-swift-client', :tag => 'v1.3.1' }
+  s.version = '1.3.2'
+  s.source = { :git => 'https://github.com/apivideo/api.video-swift-client', :tag => 'v1.3.2' }
   s.authors = { 'Ecosystem Team' => 'ecosystem@api.video' }
   s.license = { :type => 'MIT' }
   s.homepage = 'https://docs.api.video'

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.3.2] - 2024-09-16
+- Add discarded video endpoints
+
 ## [1.3.1] - 2024-09-05
 - Add sort parameters in analytics endpoints
 

diff --git a/README.md b/README.md
@@ -55,14 +55,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.1
+github "apivideo/api.video-swift-client" ~> 1.3.2
 ```
 
 Run `carthage update`
 
 #### CocoaPods
 
-Add `pod 'ApiVideoClient', '1.3.1'` in your `Podfile`
+Add `pod 'ApiVideoClient', '1.3.2'` in your `Podfile`
 
 Run `pod install`
 
@@ -228,7 +228,10 @@ Method | HTTP request | Description
 [**list**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#list) | **GET** `/videos` | List all video objects
 [**uploadThumbnail**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#uploadThumbnail) | **POST** `/videos/{videoId}/thumbnail` | Upload a thumbnail
 [**pickThumbnail**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#pickThumbnail) | **PATCH** `/videos/{videoId}/thumbnail` | Set a thumbnail
+[**getDiscarded**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#getDiscarded) | **GET** `/discarded/videos/{videoId}` | Retrieve a discarded video object
 [**getStatus**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#getStatus) | **GET** `/videos/{videoId}/status` | Retrieve video status and details
+[**listDiscarded**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#listDiscarded) | **GET** `/discarded/videos` | List all discarded video objects
+[**updateDiscarded**](https://github.com/apivideo/api.video-swift-client/blob/main/docs/VideosAPI.md#updateDiscarded) | **PATCH** `/discarded/videos/{videoId}` | Update a discarded video object
 
 
 #### WatermarksAPI
@@ -291,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)
+ - [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)
  - [FilterBy2](https://github.com/apivideo/api.video-swift-client/blob/main/docs/FilterBy2.md)

diff --git a/Sources/APIs.swift b/Sources/APIs.swift
@@ -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.1"]
+    internal static var customHeaders:[String: String] = ["AV-Origin-Client": "swift:1.3.2"]
     private static var chunkSize: Int = 50 * 1024 * 1024
     internal static var requestBuilderFactory: RequestBuilderFactory = AlamofireRequestBuilderFactory()
     internal static var credential = ApiVideoCredential()

diff --git a/Sources/APIs/LiveStreamsAPI.swift b/Sources/APIs/LiveStreamsAPI.swift
@@ -282,7 +282,7 @@ open class LiveStreamsAPI {
      
      - parameter streamKey: (query) The unique stream key that allows you to stream videos. (optional)
      - parameter name: (query) You can filter live streams by their name or a part of their name. (optional)
-     - parameter sortBy: (query) Enables you to sort live stream results. Allowed attributes: &#x60;name&#x60;, &#x60;createdAt&#x60;, &#x60;updatedAt&#x60;. &#x60;name&#x60; - the name of the live stream. &#x60;createdAt&#x60; - the time a live stream was created. &#x60;updatedAt&#x60; - the time a live stream was last updated.  When using &#x60;createdAt&#x60; or &#x60;updatedAt&#x60;, the API sorts the results based on the ISO-8601 time format.  (optional)
+     - parameter sortBy: (query) Enables you to sort live stream results. Allowed attributes: &#x60;name&#x60;, &#x60;createdAt&#x60;, &#x60;updatedAt&#x60;. &#x60;name&#x60; - the name of the live stream. &#x60;createdAt&#x60; - the time a live stream was created. &#x60;updatedAt&#x60; - the time a live stream was last updated.  When using &#x60;createdAt&#x60; or &#x60;updatedAt&#x60;, the API sorts the results based on the ATOM UTC time format.  (optional)
      - parameter sortOrder: (query) Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
@@ -306,7 +306,7 @@ open class LiveStreamsAPI {
      
      - parameter streamKey: (query) The unique stream key that allows you to stream videos. (optional)
      - parameter name: (query) You can filter live streams by their name or a part of their name. (optional)
-     - parameter sortBy: (query) Enables you to sort live stream results. Allowed attributes: &#x60;name&#x60;, &#x60;createdAt&#x60;, &#x60;updatedAt&#x60;. &#x60;name&#x60; - the name of the live stream. &#x60;createdAt&#x60; - the time a live stream was created. &#x60;updatedAt&#x60; - the time a live stream was last updated.  When using &#x60;createdAt&#x60; or &#x60;updatedAt&#x60;, the API sorts the results based on the ISO-8601 time format.  (optional)
+     - parameter sortBy: (query) Enables you to sort live stream results. Allowed attributes: &#x60;name&#x60;, &#x60;createdAt&#x60;, &#x60;updatedAt&#x60;. &#x60;name&#x60; - the name of the live stream. &#x60;createdAt&#x60; - the time a live stream was created. &#x60;updatedAt&#x60; - the time a live stream was last updated.  When using &#x60;createdAt&#x60; or &#x60;updatedAt&#x60;, the API sorts the results based on the ATOM UTC time format.  (optional)
      - parameter sortOrder: (query) Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
@@ -326,7 +326,7 @@ open class LiveStreamsAPI {
      - responseHeaders: [X-RateLimit-Limit(Int), X-RateLimit-Remaining(Int), X-RateLimit-Retry-After(Int)]
      - parameter streamKey: (query) The unique stream key that allows you to stream videos. (optional)
      - parameter name: (query) You can filter live streams by their name or a part of their name. (optional)
-     - parameter sortBy: (query) Enables you to sort live stream results. Allowed attributes: &#x60;name&#x60;, &#x60;createdAt&#x60;, &#x60;updatedAt&#x60;. &#x60;name&#x60; - the name of the live stream. &#x60;createdAt&#x60; - the time a live stream was created. &#x60;updatedAt&#x60; - the time a live stream was last updated.  When using &#x60;createdAt&#x60; or &#x60;updatedAt&#x60;, the API sorts the results based on the ISO-8601 time format.  (optional)
+     - parameter sortBy: (query) Enables you to sort live stream results. Allowed attributes: &#x60;name&#x60;, &#x60;createdAt&#x60;, &#x60;updatedAt&#x60;. &#x60;name&#x60; - the name of the live stream. &#x60;createdAt&#x60; - the time a live stream was created. &#x60;updatedAt&#x60; - the time a live stream was last updated.  When using &#x60;createdAt&#x60; or &#x60;updatedAt&#x60;, the API sorts the results based on the ATOM UTC time format.  (optional)
      - parameter sortOrder: (query) Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)

diff --git a/Sources/APIs/PlayerThemesAPI.swift b/Sources/APIs/PlayerThemesAPI.swift
@@ -280,7 +280,7 @@ open class PlayerThemesAPI {
     /**
      List all player themes
      
-     - parameter sortBy: (query) createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. (optional)
+     - parameter sortBy: (query) createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ATOM UTC format. (optional)
      - parameter sortOrder: (query) Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
@@ -302,7 +302,7 @@ open class PlayerThemesAPI {
     /**
      List all player themes
      
-     - parameter sortBy: (query) createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. (optional)
+     - parameter sortBy: (query) createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ATOM UTC format. (optional)
      - parameter sortOrder: (query) Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
@@ -320,7 +320,7 @@ open class PlayerThemesAPI {
      - GET /players
      - Retrieve a list of all the player themes you created, as well as details about each one.
      - responseHeaders: [X-RateLimit-Limit(Int), X-RateLimit-Remaining(Int), X-RateLimit-Retry-After(Int)]
-     - parameter sortBy: (query) createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format. (optional)
+     - parameter sortBy: (query) createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ATOM UTC format. (optional)
      - parameter sortOrder: (query) Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)

diff --git a/Sources/APIs/UploadTokensAPI.swift b/Sources/APIs/UploadTokensAPI.swift
@@ -214,7 +214,7 @@ open class UploadTokensAPI {
     /**
      List all active upload tokens
      
-     - parameter sortBy: (query) Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ISO-8601 format. (optional)
+     - parameter sortBy: (query) Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ATOM UTC format. (optional)
      - parameter sortOrder: (query) Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
@@ -236,7 +236,7 @@ open class UploadTokensAPI {
     /**
      List all active upload tokens
      
-     - parameter sortBy: (query) Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ISO-8601 format. (optional)
+     - parameter sortBy: (query) Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ATOM UTC format. (optional)
      - parameter sortOrder: (query) Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)
@@ -254,7 +254,7 @@ open class UploadTokensAPI {
      - GET /upload-tokens
      - Retrieve a list of all currently active delegated tokens.
      - responseHeaders: [X-RateLimit-Limit(Int), X-RateLimit-Remaining(Int), X-RateLimit-Retry-After(Int)]
-     - parameter sortBy: (query) Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ISO-8601 format. (optional)
+     - parameter sortBy: (query) Allowed: createdAt, ttl. You can use these to sort by when a token was created, or how much longer the token will be active (ttl - time to live). Date and time is presented in ATOM UTC format. (optional)
      - parameter sortOrder: (query) Allowed: asc, desc. Ascending is 0-9 or A-Z. Descending is 9-0 or Z-A. (optional)
      - parameter currentPage: (query) Choose the number of search results to return per page. Minimum value: 1 (optional, default to 1)
      - parameter pageSize: (query) Results per page. Allowed values 1-100, default is 25. (optional, default to 25)