Merge pull request #189 from apivideo/Fix-live-stream-thumbnail-URL

Fix live stream thumbnail URL
apivideo · Oct 6, 2023 · 8d9e293 · 8d9e293
2 parents 0d03a83 + 020bc61
commit 8d9e293
Show file tree

Hide file tree

Showing 25 changed files with 45 additions and 45 deletions.
diff --git a/docs/api/CaptionsApi.md b/docs/api/CaptionsApi.md
@@ -15,7 +15,7 @@ All URIs are relative to *https://ws.api.video*
 ## **`upload()` - Upload a caption**
 
 
-Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/reference/captions)
+Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/vod/add-captions)
 
 ### Parameters
 

diff --git a/docs/api/ChaptersApi.md b/docs/api/ChaptersApi.md
@@ -16,7 +16,7 @@ All URIs are relative to *https://ws.api.video*
 
 Upload a VTT file to add chapters to your video.
 
-Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos) for more details.
+Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos/) for more details.
 
 ### Parameters
 

diff --git a/docs/api/UploadTokensApi.md b/docs/api/UploadTokensApi.md
@@ -14,7 +14,7 @@ All URIs are relative to *https://ws.api.video*
 ## **`createToken()` - Generate an upload token**
 
 
-Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/reference/upload-tokens)
+Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/vod/delegated-upload-tokens)
 
 ### Parameters
 

diff --git a/docs/api/VideosApi.md b/docs/api/VideosApi.md
@@ -20,7 +20,7 @@ All URIs are relative to *https://ws.api.video*
 ## **`create()` - Create a video object**
 
 
-Creates a video object. More information on video objects can be found [here](https://docs.api.video/reference/videos-1).
+Creates a video object. More information on video objects can be found [here](https://docs.api.video/reference/api/Videos).
 
 
 
@@ -247,7 +247,7 @@ This method returns a list of your videos (with all their details). With no para
 | ------------- | ------------- | ------------- | ------------- |
  | **title** | **string**| no| The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles. |
  | **tags** | **Array&lt;string&gt;**| no| A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned. |
- | **metadata** | **{ [key: string]: string; }**| no| Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. |
+ | **metadata** | **{ [key: string]: string; }**| no| Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. |
  | **description** | **string**| no| Retrieve video objects by &#x60;description&#x60;. |
  | **liveStreamId** | **string**| no| Retrieve video objects that were recorded from a live stream by &#x60;liveStreamId&#x60;. |
  | **sortBy** | **&#39;title&#39; \| &#39;createdAt&#39; \| &#39;publishedAt&#39; \| &#39;updatedAt&#39;**| no| Use this parameter to sort videos by the their created time, published time, updated time, or by title. |

diff --git a/docs/model/LiveStream.md b/docs/model/LiveStream.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **liveStreamId** | **string** | The unique identifier for the live stream. Live stream IDs begin with \&quot;li.\&quot; | 
 **name** | **string** | The name of your live stream. |  [optional]
 **streamKey** | **string** | The unique, private stream key that you use to begin streaming. |  [optional]
-**_public** | **boolean** | Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos). |  [optional]
+**_public** | **boolean** | Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). |  [optional]
 **assets** | [**LiveStreamAssets**](LiveStreamAssets.md) |  |  [optional]
 **playerId** | **string** | The unique identifier for the player. |  [optional]
 **broadcasting** | **boolean** | Whether or not you are broadcasting the live video you recorded for others to see. True means you are broadcasting to viewers, false means you are not. |  [optional]

diff --git a/docs/model/LiveStreamCreationPayload.md b/docs/model/LiveStreamCreationPayload.md
@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **string** | Add a name for your live stream here. | 
-**_public** | **boolean** | Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos). |  [optional]
+**_public** | **boolean** | Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). |  [optional]
 **playerId** | **string** | The unique identifier for the player. |  [optional]
 **restreams** | [**Array&lt;RestreamsRequestObject&gt;**](RestreamsRequestObject.md) | Use this parameter to add, edit, or remove RTMP services where you want to restream a live stream. The list can only contain up to 5 destinations. |  [optional]
 

diff --git a/docs/model/LiveStreamUpdatePayload.md b/docs/model/LiveStreamUpdatePayload.md
@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **string** | The name you want to use for your live stream. |  [optional]
-**_public** | **boolean** | Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/docs/private-videos). |  [optional]
+**_public** | **boolean** | Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view. Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). |  [optional]
 **playerId** | **string** | The unique ID for the player associated with a live stream that you want to update. |  [optional]
 **restreams** | [**Array&lt;RestreamsRequestObject&gt;**](RestreamsRequestObject.md) | Use this parameter to add, edit, or remove RTMP services where you want to restream a live stream. The list can only contain up to 5 destinations. This operation updates all restream destinations in the same request. If you do not want to modify an existing restream destination, you need to include it in your request, otherwise it is removed. |  [optional]
 

diff --git a/docs/model/Video.md b/docs/model/Video.md
@@ -12,11 +12,11 @@ Name | Type | Description | Notes
 **publishedAt** | **Date** | The date and time the API created the video. Date and time are provided using ISO-8601 UTC format. |  [optional]
 **updatedAt** | **Date** | The date and time the video was updated. Date and time are provided using ISO-8601 UTC format. |  [optional]
 **tags** | **Array&lt;string&gt;** | One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces.   |  [optional]
-**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair.  |  [optional]
+**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | Metadata you can use to categorise and filter videos. Metadata is a list of dictionaries, where each dictionary represents a key value pair for categorising a video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair.  |  [optional]
 **source** | [**VideoSource**](VideoSource.md) |  |  [optional]
 **assets** | [**VideoAssets**](VideoAssets.md) |  |  [optional]
 **playerId** | **string** | The id of the player that will be applied on the video.  |  [optional]
-**_public** | **boolean** | Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos).  |  [optional]
+**_public** | **boolean** | Defines if the content is publicly reachable or if a unique token is needed for each play session. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos/).  |  [optional]
 **panoramic** | **boolean** | Defines if video is panoramic.  |  [optional]
 **mp4Support** | **boolean** | This lets you know whether mp4 is supported. If enabled, an mp4 URL will be provided in the response for the video.  |  [optional]
 

diff --git a/docs/model/VideoCreationPayload.md b/docs/model/VideoCreationPayload.md
@@ -8,12 +8,12 @@ Name | Type | Description | Notes
 **title** | **string** | The title of your new video. | 
 **description** | **string** | A brief description of your video. |  [optional]
 **source** | **string** | You can either add a video already on the web, by entering the URL of the video, or you can also enter the &#x60;videoId&#x60; of one of the videos you already have on your api.video acccount, and this will generate a copy of your video. Creating a copy of a video can be especially useful if you want to keep your original video and trim or apply a watermark onto the copy you would create. |  [optional]
-**_public** | **boolean** | Default: True. If set to &#x60;false&#x60; the video will become private. More information on private videos can be found [here](https://docs.api.video/docs/private-videos) |  [optional]
+**_public** | **boolean** | Default: True. If set to &#x60;false&#x60; the video will become private. More information on private videos can be found [here](https://docs.api.video/delivery-analytics/video-privacy-access-management) |  [optional]
 **panoramic** | **boolean** | Indicates if your video is a 360/immersive video. |  [optional]
 **mp4Support** | **boolean** | Enables mp4 version in addition to streamed version. |  [optional]
 **playerId** | **string** | The unique identification number for your video player. |  [optional]
 **tags** | **Array&lt;string&gt;** | A list of tags you want to use to describe your video. |  [optional]
-**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | A list of key value pairs that you use to provide metadata for your video. These pairs can be made dynamic, allowing you to segment your audience. Read more on [dynamic metadata](https://api.video/blog/endpoints/dynamic-metadata). |  [optional]
+**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | A list of key value pairs that you use to provide metadata for your video. These pairs can be made dynamic, allowing you to segment your audience. Read more on [dynamic metadata](https://api.video/blog/endpoints/dynamic-metadata/). |  [optional]
 **clip** | [**VideoClip**](VideoClip.md) |  |  [optional]
 **watermark** | [**VideoWatermark**](VideoWatermark.md) |  |  [optional]
 

diff --git a/docs/model/VideoUpdatePayload.md b/docs/model/VideoUpdatePayload.md
@@ -8,11 +8,11 @@ Name | Type | Description | Notes
 **playerId** | **string** \| **null** | The unique ID for the player you want to associate with your video. |  [optional]
 **title** | **string** | The title you want to use for your video. |  [optional]
 **description** | **string** | A brief description of the video. |  [optional]
-**_public** | **boolean** | Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos). |  [optional]
+**_public** | **boolean** | Whether the video is publicly available or not. False means it is set to private. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos/). |  [optional]
 **panoramic** | **boolean** | Whether the video is a 360 degree or immersive video. |  [optional]
 **mp4Support** | **boolean** | Whether the player supports the mp4 format. |  [optional]
 **tags** | **Array&lt;string&gt;** | A list of terms or words you want to tag the video with. Make sure the list includes all the tags you want as whatever you send in this list will overwrite the existing list for the video. |  [optional]
-**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | A list (array) of dictionaries where each dictionary contains a key value pair that describes the video. As with tags, you must send the complete list of metadata you want as whatever you send here will overwrite the existing metadata for the video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair. |  [optional]
+**metadata** | [**Array&lt;Metadata&gt;**](Metadata.md) | A list (array) of dictionaries where each dictionary contains a key value pair that describes the video. As with tags, you must send the complete list of metadata you want as whatever you send here will overwrite the existing metadata for the video. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. |  [optional]
 
 
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/api/CaptionsApi.ts b/src/api/CaptionsApi.ts
@@ -32,7 +32,7 @@ export default class CaptionsApi {
   }
 
   /**
-   * Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/reference/captions)
+   * Upload a VTT file to add captions to your video. More information can be found [here](https://docs.api.video/vod/add-captions)
    * Upload a caption
    * @param videoId The unique identifier for the video you want to add a caption to.
    * @param language A valid BCP 47 language representation.

diff --git a/src/api/ChaptersApi.ts b/src/api/ChaptersApi.ts
@@ -31,7 +31,7 @@ export default class ChaptersApi {
   }
 
   /**
-   * Upload a VTT file to add chapters to your video. Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos) for more details.
+   * Upload a VTT file to add chapters to your video. Chapters help break the video into sections. Read our [tutorial](https://api.video/blog/tutorials/adding-chapters-to-your-videos/) for more details.
    * Upload a chapter
    * @param videoId The unique identifier for the video you want to upload a chapter for.
    * @param language A valid [BCP 47](https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers) language representation.

diff --git a/src/api/UploadTokensApi.ts b/src/api/UploadTokensApi.ts
@@ -27,7 +27,7 @@ export default class UploadTokensApi {
   }
 
   /**
-   * Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/reference/upload-tokens)
+   * Generates an upload token that can be used to replace the API Key. More information can be found [here](https://docs.api.video/vod/delegated-upload-tokens)
    * Generate an upload token
    * @param tokenCreationPayload
    */

diff --git a/src/api/VideosApi.ts b/src/api/VideosApi.ts
@@ -37,7 +37,7 @@ export default class VideosApi {
   }
 
   /**
-   * Creates a video object. More information on video objects can be found [here](https://docs.api.video/reference/videos-1).
+   * Creates a video object. More information on video objects can be found [here](https://docs.api.video/reference/api/Videos).
    * Create a video object
    * @param videoCreationPayload video to create
    */
@@ -735,7 +735,7 @@ NOTE: If you are updating an array, you must provide the entire array as what yo
    * @param {Object} searchParams
    * @param { string } searchParams.title The title of a specific video you want to find. The search will match exactly to what term you provide and return any videos that contain the same term as part of their titles.
    * @param { Array&lt;string&gt; } searchParams.tags A tag is a category you create and apply to videos. You can search for videos with particular tags by listing one or more here. Only videos that have all the tags you list will be returned.
-   * @param { { [key: string]: string; } } searchParams.metadata Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata) allows you to define a key that allows any value pair.
+   * @param { { [key: string]: string; } } searchParams.metadata Videos can be tagged with metadata tags in key:value pairs. You can search for videos with specific key value pairs using this parameter. [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair.
    * @param { string } searchParams.description Retrieve video objects by &#x60;description&#x60;.
    * @param { string } searchParams.liveStreamId Retrieve video objects that were recorded from a live stream by &#x60;liveStreamId&#x60;.
    * @param { &#39;title&#39; | &#39;createdAt&#39; | &#39;publishedAt&#39; | &#39;updatedAt&#39; } searchParams.sortBy Use this parameter to sort videos by the their created time, published time, updated time, or by title.