diff --git a/api/openapi.yaml b/api/openapi.yaml index 07a1a4a..1d2ed39 100644 --- a/api/openapi.yaml +++ b/api/openapi.yaml @@ -193,7 +193,7 @@ paths: style: form - description: 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 + [Dynamic Metadata](https://api.video/blog/endpoints/dynamic-metadata/) allows you to define a key that allows any value pair. example: metadata[Author]=John Doe&metadata[Format]=Tutorial explode: true @@ -510,7 +510,7 @@ paths: x-optional-object: true post: description: | - 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). operationId: POST-video requestBody: content: @@ -2843,7 +2843,7 @@ paths: // Documentation: https://github.com/apivideo/api.video-ios-client/blob/main/docs/UploadTokensAPI.md#list post: description: 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) + More information can be found [here](https://docs.api.video/vod/delegated-upload-tokens) operationId: POST_upload-tokens requestBody: content: @@ -5294,7 +5294,7 @@ paths: // Documentation: https://github.com/apivideo/api.video-ios-client/blob/main/docs/CaptionsAPI.md#update post: description: Upload a VTT file to add captions to your video. More information - can be found [here](https://docs.api.video/reference/captions) + can be found [here](https://docs.api.video/vod/add-captions) operationId: POST_videos-videoId-captions-language parameters: - description: The unique identifier for the video you want to add a caption @@ -6014,7 +6014,7 @@ paths: post: description: |- 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. operationId: POST_videos-videoId-chapters-language parameters: - description: The unique identifier for the video you want to upload a chapter @@ -9812,7 +9812,7 @@ components: type: array metadata: description: | - 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. + 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. example: '[{"key":"Author", "value":"John Doe"}, {"key":"Format", "value":"Tutorial"}]' items: $ref: '#/components/schemas/metadata' @@ -9828,7 +9828,7 @@ components: type: string public: description: | - 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). + 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/). example: false type: boolean panoramic: @@ -10260,7 +10260,7 @@ components: public: description: 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). + Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). example: true type: boolean assets: @@ -10655,7 +10655,7 @@ components: public: default: true description: 'Default: True. If set to `false` the video will become private. - More information on private videos can be found [here](https://docs.api.video/docs/private-videos)' + More information on private videos can be found [here](https://docs.api.video/delivery-analytics/video-privacy-access-management)' example: true type: boolean panoramic: @@ -10681,7 +10681,7 @@ components: metadata: description: 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). + your audience. Read more on [dynamic metadata](https://api.video/blog/endpoints/dynamic-metadata/). example: '[{"key": "Author", "value": "John Doe"}]' items: $ref: '#/components/schemas/metadata' @@ -10767,7 +10767,7 @@ components: type: string public: description: 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). + it is set to private. Default is true. Tutorials on [private videos](https://api.video/blog/endpoints/private-videos/). example: true type: boolean panoramic: @@ -10790,7 +10790,7 @@ components: description: 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) + 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. items: $ref: '#/components/schemas/metadata' @@ -10966,7 +10966,7 @@ components: public: description: 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). + Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). type: boolean playerId: description: The unique identifier for the player. @@ -10993,7 +10993,7 @@ components: public: description: 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). + Learn more about the Private Video feature [here](https://docs.api.video/delivery-analytics/video-privacy-access-management). type: boolean playerId: description: The unique ID for the player associated with a live stream diff --git a/api_captions.go b/api_captions.go index 349f55b..8cf794f 100644 --- a/api_captions.go +++ b/api_captions.go @@ -155,7 +155,7 @@ type CaptionsService struct { /* * 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) * @param videoId The unique identifier for the video you want to add a caption to. * @param language A valid BCP 47 language representation. @@ -168,7 +168,7 @@ func (s *CaptionsService) UploadFile(videoId string, language string, file *os.F /* * 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) * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param videoId The unique identifier for the video you want to add a caption to. * @param language A valid BCP 47 language representation. @@ -181,7 +181,7 @@ func (s *CaptionsService) UploadFileWithContext(ctx context.Context, videoId str /* * 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) * @param videoId The unique identifier for the video you want to add a caption to. * @param language A valid BCP 47 language representation. @@ -193,7 +193,7 @@ func (s *CaptionsService) Upload(videoId string, language string, fileName strin /* * 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) * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @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/api_chapters.go b/api_chapters.go index e715931..22a17c0 100644 --- a/api_chapters.go +++ b/api_chapters.go @@ -138,7 +138,7 @@ type ChaptersService struct { * Upload Upload a chapter * 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. * @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. @@ -153,7 +153,7 @@ func (s *ChaptersService) UploadFile(videoId string, language string, file *os.F * Upload Upload a chapter * 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. * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @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. @@ -168,7 +168,7 @@ func (s *ChaptersService) UploadFileWithContext(ctx context.Context, videoId str - Upload Upload a chapter - 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. - @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. @@ -182,7 +182,7 @@ func (s *ChaptersService) Upload(videoId string, language string, fileName strin - Upload Upload a chapter - 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. - @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). - @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/api_upload_tokens.go b/api_upload_tokens.go index 830913e..f4e3f70 100644 --- a/api_upload_tokens.go +++ b/api_upload_tokens.go @@ -120,7 +120,7 @@ type UploadTokensService struct { /* * 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) * @return UploadTokensApiCreateTokenRequest */ @@ -133,7 +133,7 @@ func (s *UploadTokensService) CreateToken(tokenCreationPayload TokenCreationPayl /* * 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) * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @return UploadTokensApiCreateTokenRequest */ diff --git a/api_videos.go b/api_videos.go index 76b4ee5..53c5e09 100644 --- a/api_videos.go +++ b/api_videos.go @@ -334,7 +334,7 @@ type VideosService struct { /* * 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). @@ -349,7 +349,7 @@ func (s *VideosService) Create(videoCreationPayload VideoCreationPayload) (*Vide /* * 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). * @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). diff --git a/docs/LiveStream.md b/docs/LiveStream.md index 896b039..42d5046 100644 --- a/docs/LiveStream.md +++ b/docs/LiveStream.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **LiveStreamId** | **string** | The unique identifier for the live stream. Live stream IDs begin with \"li.\" | **Name** | Pointer to **string** | The name of your live stream. | [optional] **StreamKey** | Pointer to **string** | The unique, private stream key that you use to begin streaming. | [optional] -**Public** | Pointer to **bool** | 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** | Pointer to **bool** | 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** | Pointer to [**LiveStreamAssets**](LiveStreamAssets.md) | | [optional] **PlayerId** | Pointer to **string** | The unique identifier for the player. | [optional] **Broadcasting** | Pointer to **bool** | 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/LiveStreamCreationPayload.md b/docs/LiveStreamCreationPayload.md index 9dc7e79..f396adb 100644 --- a/docs/LiveStreamCreationPayload.md +++ b/docs/LiveStreamCreationPayload.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | Add a name for your live stream here. | -**Public** | Pointer to **bool** | 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** | Pointer to **bool** | 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** | Pointer to **string** | The unique identifier for the player. | [optional] **Restreams** | Pointer to [**[]RestreamsRequestObject**](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/LiveStreamUpdatePayload.md b/docs/LiveStreamUpdatePayload.md index 30d3fa2..9e67c05 100644 --- a/docs/LiveStreamUpdatePayload.md +++ b/docs/LiveStreamUpdatePayload.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | Pointer to **string** | The name you want to use for your live stream. | [optional] -**Public** | Pointer to **bool** | 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** | Pointer to **bool** | 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** | Pointer to **string** | The unique ID for the player associated with a live stream that you want to update. | [optional] **Restreams** | Pointer to [**[]RestreamsRequestObject**](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/Video.md b/docs/Video.md index 67bafcf..9f9c936 100644 --- a/docs/Video.md +++ b/docs/Video.md @@ -11,11 +11,11 @@ Name | Type | Description | Notes **PublishedAt** | Pointer to **string** | The date and time the API created the video. Date and time are provided using ISO-8601 UTC format. | [optional] **UpdatedAt** | Pointer to **string** | The date and time the video was updated. Date and time are provided using ISO-8601 UTC format. | [optional] **Tags** | Pointer to **[]string** | One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces. | [optional] -**Metadata** | Pointer to [**[]Metadata**](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** | Pointer to [**[]Metadata**](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** | Pointer to [**VideoSource**](VideoSource.md) | | [optional] **Assets** | Pointer to [**VideoAssets**](VideoAssets.md) | | [optional] **PlayerId** | Pointer to **string** | The id of the player that will be applied on the video. | [optional] -**Public** | Pointer to **bool** | 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** | Pointer to **bool** | 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** | Pointer to **bool** | Defines if video is panoramic. | [optional] **Mp4Support** | Pointer to **bool** | 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/VideoCreationPayload.md b/docs/VideoCreationPayload.md index d83fa9b..33c6d7a 100644 --- a/docs/VideoCreationPayload.md +++ b/docs/VideoCreationPayload.md @@ -7,12 +7,12 @@ Name | Type | Description | Notes **Title** | **string** | The title of your new video. | **Description** | Pointer to **string** | A brief description of your video. | [optional] **Source** | Pointer to **string** | You can either add a video already on the web, by entering the URL of the video, or you can also enter the `videoId` 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** | Pointer to **bool** | Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/docs/private-videos) | [optional] [default to true] +**Public** | Pointer to **bool** | Default: True. If set to `false` 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] [default to true] **Panoramic** | Pointer to **bool** | Indicates if your video is a 360/immersive video. | [optional] [default to false] **Mp4Support** | Pointer to **bool** | Enables mp4 version in addition to streamed version. | [optional] [default to true] **PlayerId** | Pointer to **string** | The unique identification number for your video player. | [optional] **Tags** | Pointer to **[]string** | A list of tags you want to use to describe your video. | [optional] -**Metadata** | Pointer to [**[]Metadata**](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** | Pointer to [**[]Metadata**](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** | Pointer to [**VideoClip**](VideoClip.md) | | [optional] **Watermark** | Pointer to [**VideoWatermark**](VideoWatermark.md) | | [optional] diff --git a/docs/VideoUpdatePayload.md b/docs/VideoUpdatePayload.md index 3249b4a..c162f7e 100644 --- a/docs/VideoUpdatePayload.md +++ b/docs/VideoUpdatePayload.md @@ -7,11 +7,11 @@ Name | Type | Description | Notes **PlayerId** | Pointer to **NullableString** | The unique ID for the player you want to associate with your video. | [optional] **Title** | Pointer to **string** | The title you want to use for your video. | [optional] **Description** | Pointer to **string** | A brief description of the video. | [optional] -**Public** | Pointer to **bool** | 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** | Pointer to **bool** | 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** | Pointer to **bool** | Whether the video is a 360 degree or immersive video. | [optional] **Mp4Support** | Pointer to **bool** | Whether the player supports the mp4 format. | [optional] **Tags** | Pointer to **[]string** | 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** | Pointer to [**[]Metadata**](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** | Pointer to [**[]Metadata**](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] ## Methods diff --git a/docs/Videos.md b/docs/Videos.md index 5039c53..d6720f7 100644 --- a/docs/Videos.md +++ b/docs/Videos.md @@ -484,7 +484,7 @@ func main() { req.Title("My Video.mp4") // string | 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. req.Tags([]string{"Inner_example"}) // []string | 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. - req.Metadata(map[string]string{"key": "TODO"}) // map[string]string | 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. + req.Metadata(map[string]string{"key": "TODO"}) // map[string]string | 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. req.Description("New Zealand") // string | Retrieve video objects by `description`. req.LiveStreamId("li400mYKSgQ6xs7taUeSaEKr") // string | Retrieve video objects that were recorded from a live stream by `liveStreamId`. req.SortBy("publishedAt") // string | Use this parameter to sort videos by the their created time, published time, updated time, or by title. @@ -514,7 +514,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **title** | **string** | 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** | **[]string** | 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** | [**map[string]**](.md) | 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** | [**map[string]**](.md) | 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** | Retrieve video objects by `description`. | **liveStreamId** | **string** | Retrieve video objects that were recorded from a live stream by `liveStreamId`. | **sortBy** | **string** | Use this parameter to sort videos by the their created time, published time, updated time, or by title. | diff --git a/model_live_stream.go b/model_live_stream.go index a9538f0..16dabbf 100644 --- a/model_live_stream.go +++ b/model_live_stream.go @@ -22,7 +22,7 @@ type LiveStream struct { Name *string `json:"name,omitempty"` // The unique, private stream key that you use to begin streaming. StreamKey *string `json:"streamKey,omitempty"` - // 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). + // 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). Public *bool `json:"public,omitempty"` Assets *LiveStreamAssets `json:"assets,omitempty"` // The unique identifier for the player. diff --git a/model_live_stream_creation_payload.go b/model_live_stream_creation_payload.go index eb3ac0b..62d131a 100644 --- a/model_live_stream_creation_payload.go +++ b/model_live_stream_creation_payload.go @@ -18,7 +18,7 @@ import ( type LiveStreamCreationPayload struct { // Add a name for your live stream here. Name string `json:"name"` - // 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). + // 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). Public *bool `json:"public,omitempty"` // The unique identifier for the player. PlayerId *string `json:"playerId,omitempty"` diff --git a/model_live_stream_update_payload.go b/model_live_stream_update_payload.go index 74fb8d6..15a8ca1 100644 --- a/model_live_stream_update_payload.go +++ b/model_live_stream_update_payload.go @@ -18,7 +18,7 @@ import ( type LiveStreamUpdatePayload struct { // The name you want to use for your live stream. Name *string `json:"name,omitempty"` - // 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). + // 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). Public *bool `json:"public,omitempty"` // The unique ID for the player associated with a live stream that you want to update. PlayerId *string `json:"playerId,omitempty"` diff --git a/model_video.go b/model_video.go index d87cf14..becf8c1 100644 --- a/model_video.go +++ b/model_video.go @@ -30,13 +30,13 @@ type Video struct { UpdatedAt *string `json:"updatedAt,omitempty"` // One array of tags (each tag is a string) in order to categorize a video. Tags may include spaces. Tags *[]string `json:"tags,omitempty"` - // 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. + // 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. Metadata *[]Metadata `json:"metadata,omitempty"` Source *VideoSource `json:"source,omitempty"` Assets *VideoAssets `json:"assets,omitempty"` // The id of the player that will be applied on the video. PlayerId *string `json:"playerId,omitempty"` - // 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). + // 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/). Public *bool `json:"public,omitempty"` // Defines if video is panoramic. Panoramic *bool `json:"panoramic,omitempty"` diff --git a/model_video_creation_payload.go b/model_video_creation_payload.go index 356465b..55c72ac 100644 --- a/model_video_creation_payload.go +++ b/model_video_creation_payload.go @@ -22,7 +22,7 @@ type VideoCreationPayload struct { Description *string `json:"description,omitempty"` // You can either add a video already on the web, by entering the URL of the video, or you can also enter the `videoId` 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. Source *string `json:"source,omitempty"` - // Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/docs/private-videos) + // Default: True. If set to `false` the video will become private. More information on private videos can be found [here](https://docs.api.video/delivery-analytics/video-privacy-access-management) Public *bool `json:"public,omitempty"` // Indicates if your video is a 360/immersive video. Panoramic *bool `json:"panoramic,omitempty"` @@ -32,7 +32,7 @@ type VideoCreationPayload struct { PlayerId *string `json:"playerId,omitempty"` // A list of tags you want to use to describe your video. Tags *[]string `json:"tags,omitempty"` - // 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). + // 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/). Metadata *[]Metadata `json:"metadata,omitempty"` Clip *VideoClip `json:"clip,omitempty"` Watermark *VideoWatermark `json:"watermark,omitempty"` diff --git a/model_video_update_payload.go b/model_video_update_payload.go index ec911c7..b1e59f2 100644 --- a/model_video_update_payload.go +++ b/model_video_update_payload.go @@ -22,7 +22,7 @@ type VideoUpdatePayload struct { Title *string `json:"title,omitempty"` // A brief description of the video. Description *string `json:"description,omitempty"` - // 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). + // 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/). Public *bool `json:"public,omitempty"` // Whether the video is a 360 degree or immersive video. Panoramic *bool `json:"panoramic,omitempty"` @@ -30,7 +30,7 @@ type VideoUpdatePayload struct { Mp4Support *bool `json:"mp4Support,omitempty"` // 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. Tags *[]string `json:"tags,omitempty"` - // 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. + // 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. Metadata *[]Metadata `json:"metadata,omitempty"` }