Updated Go client to v1.166.0-alpha.0

bitmovin · Jul 5, 2023 · 527bfef · 527bfef
1 parent 2dfe6c5
commit 527bfef
Show file tree

Hide file tree

Showing 37 changed files with 74 additions and 27 deletions.
diff --git a/api/encoding_configurations_audio_ac3_api.go b/api/encoding_configurations_audio_ac3_api.go
@@ -32,7 +32,8 @@ func NewEncodingConfigurationsAudioAc3APIWithClient(apiClient *apiclient.APIClie
 	return a
 }
 
-// Create AC3 Codec Configuration.  Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+// Create AC3 Codec Configuration
+// Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
 func (api *EncodingConfigurationsAudioAc3API) Create(ac3AudioConfiguration model.Ac3AudioConfiguration) (*model.Ac3AudioConfiguration, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}
@@ -42,7 +43,8 @@ func (api *EncodingConfigurationsAudioAc3API) Create(ac3AudioConfiguration model
 	return &responseModel, err
 }
 
-// Delete AC3 Codec Configuration.  Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+// Delete AC3 Codec Configuration
+// Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
 func (api *EncodingConfigurationsAudioAc3API) Delete(configurationId string) (*model.BitmovinResponse, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 		params.PathParams["configuration_id"] = configurationId
@@ -53,7 +55,8 @@ func (api *EncodingConfigurationsAudioAc3API) Delete(configurationId string) (*m
 	return &responseModel, err
 }
 
-// Get AC3 Codec Configuration Details  Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+// Get AC3 Codec Configuration Details
+// Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
 func (api *EncodingConfigurationsAudioAc3API) Get(configurationId string) (*model.Ac3AudioConfiguration, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 		params.PathParams["configuration_id"] = configurationId
@@ -64,7 +67,8 @@ func (api *EncodingConfigurationsAudioAc3API) Get(configurationId string) (*mode
 	return &responseModel, err
 }
 
-// List AC3 Configurations.  Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here:  https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+// List AC3 Configurations
+// Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here:  https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
 func (api *EncodingConfigurationsAudioAc3API) List(queryParams ...func(*EncodingConfigurationsAudioAc3APIListQueryParams)) (*pagination.Ac3AudioConfigurationsListPagination, error) {
 	queryParameters := &EncodingConfigurationsAudioAc3APIListQueryParams{}
 	for _, queryParam := range queryParams {

diff --git a/api/encoding_configurations_audio_eac3_api.go b/api/encoding_configurations_audio_eac3_api.go
@@ -32,7 +32,8 @@ func NewEncodingConfigurationsAudioEac3APIWithClient(apiClient *apiclient.APICli
 	return a
 }
 
-// Create E-AC3 Codec Configuration.  Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+// Create E-AC3 Codec Configuration
+// Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
 func (api *EncodingConfigurationsAudioEac3API) Create(eac3AudioConfiguration model.Eac3AudioConfiguration) (*model.Eac3AudioConfiguration, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}
@@ -42,7 +43,8 @@ func (api *EncodingConfigurationsAudioEac3API) Create(eac3AudioConfiguration mod
 	return &responseModel, err
 }
 
-// Delete E-AC3 Codec Configuration.  Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+// Delete E-AC3 Codec Configuration
+// Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
 func (api *EncodingConfigurationsAudioEac3API) Delete(configurationId string) (*model.BitmovinResponse, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 		params.PathParams["configuration_id"] = configurationId
@@ -53,7 +55,8 @@ func (api *EncodingConfigurationsAudioEac3API) Delete(configurationId string) (*
 	return &responseModel, err
 }
 
-// Get E-AC3 Codec Configuration Details.  Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+// Get E-AC3 Codec Configuration Details
+// Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
 func (api *EncodingConfigurationsAudioEac3API) Get(configurationId string) (*model.Eac3AudioConfiguration, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 		params.PathParams["configuration_id"] = configurationId
@@ -64,7 +67,8 @@ func (api *EncodingConfigurationsAudioEac3API) Get(configurationId string) (*mod
 	return &responseModel, err
 }
 
-// List E-AC3 Configurations.  Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
+// List E-AC3 Configurations
+// Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
 func (api *EncodingConfigurationsAudioEac3API) List(queryParams ...func(*EncodingConfigurationsAudioEac3APIListQueryParams)) (*pagination.Eac3AudioConfigurationsListPagination, error) {
 	queryParameters := &EncodingConfigurationsAudioEac3APIListQueryParams{}
 	for _, queryParam := range queryParams {

diff --git a/api/encoding_encodings_live_insertable_content_api.go b/api/encoding_encodings_live_insertable_content_api.go
@@ -38,7 +38,8 @@ func NewEncodingEncodingsLiveInsertableContentAPIWithClient(apiClient *apiclient
 	return a
 }
 
-// Create Make Insertable Content Available For A Live Encoding
+// Create Insertable Content
+// Make Insertable Content available for a live encoding
 func (api *EncodingEncodingsLiveInsertableContentAPI) Create(encodingId string, insertableContent model.InsertableContent) (*model.InsertableContent, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 		params.PathParams["encoding_id"] = encodingId
@@ -49,7 +50,8 @@ func (api *EncodingEncodingsLiveInsertableContentAPI) Create(encodingId string,
 	return &responseModel, err
 }
 
-// List All Insertable Content Available For A Live Encoding
+// List Insertable Content
+// List all Insertable Content available for a live encoding
 func (api *EncodingEncodingsLiveInsertableContentAPI) List(encodingId string, queryParams ...func(*EncodingEncodingsLiveInsertableContentAPIListQueryParams)) (*pagination.InsertableContentsListPagination, error) {
 	queryParameters := &EncodingEncodingsLiveInsertableContentAPIListQueryParams{}
 	for _, queryParam := range queryParams {

diff --git a/api/encoding_encodings_live_insertable_content_schedule_api.go b/api/encoding_encodings_live_insertable_content_schedule_api.go
@@ -26,7 +26,8 @@ func NewEncodingEncodingsLiveInsertableContentScheduleAPIWithClient(apiClient *a
 	return a
 }
 
-// Create Schedule Insertable Content For a Live Encoding
+// Create Schedule Insertable Content
+// Schedule Insertable Content for a live encoding
 func (api *EncodingEncodingsLiveInsertableContentScheduleAPI) Create(encodingId string, contentId string, scheduledInsertableContent model.ScheduledInsertableContent) (*model.ScheduledInsertableContent, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 		params.PathParams["encoding_id"] = encodingId

diff --git a/api/encoding_encodings_live_insertable_content_scheduled_api.go b/api/encoding_encodings_live_insertable_content_scheduled_api.go
@@ -26,7 +26,8 @@ func NewEncodingEncodingsLiveInsertableContentScheduledAPIWithClient(apiClient *
 	return a
 }
 
-// List All Scheduled Insertable Content For A Live Encoding
+// List Scheduled Insertable Content
+// List all Scheduled Insertable Content for a live encoding
 func (api *EncodingEncodingsLiveInsertableContentScheduledAPI) List(encodingId string, queryParams ...func(*EncodingEncodingsLiveInsertableContentScheduledAPIListQueryParams)) (*pagination.ScheduledInsertableContentsListPagination, error) {
 	queryParameters := &EncodingEncodingsLiveInsertableContentScheduledAPIListQueryParams{}
 	for _, queryParam := range queryParams {

diff --git a/api/encoding_encodings_streams_qc_psnr_api.go b/api/encoding_encodings_streams_qc_psnr_api.go
@@ -27,7 +27,8 @@ func NewEncodingEncodingsStreamsQcPsnrAPIWithClient(apiClient *apiclient.APIClie
 	return a
 }
 
-// Create Activate PSNR quality metrics for the selected stream
+// Create PSNR quality metrics
+// Activates PSNR quality metrics for the selected stream
 func (api *EncodingEncodingsStreamsQcPsnrAPI) Create(encodingId string, streamId string) (*model.BitmovinResponse, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 		params.PathParams["encoding_id"] = encodingId

diff --git a/api/encoding_encodings_transfer_retries_api.go b/api/encoding_encodings_transfer_retries_api.go
@@ -27,7 +27,8 @@ func NewEncodingEncodingsTransferRetriesAPIWithClient(apiClient *apiclient.APICl
 	return a
 }
 
-// Create Starts transfer retry. A transfer retry is only possible within 72 hours.
+// Create Transfer retry
+// Triggers a retry attempt for a failed transfer. This is possible within 72 hours after the initial failure.
 func (api *EncodingEncodingsTransferRetriesAPI) Create(encodingId string) (*model.TransferRetry, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 		params.PathParams["encoding_id"] = encodingId

diff --git a/api/encoding_filters_conform_api.go b/api/encoding_filters_conform_api.go
@@ -32,7 +32,8 @@ func NewEncodingFiltersConformAPIWithClient(apiClient *apiclient.APIClient) *Enc
 	return a
 }
 
-// Create Conform Filter. Keeps all the frames of the input. The playback time of the output will be slower or faster.
+// Create Conform Filter
+// Retains all frames of the input. The playback speed of the output will be slower or faster.
 func (api *EncodingFiltersConformAPI) Create(conformFilter model.ConformFilter) (*model.ConformFilter, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/encoding_manifests_dash_api.go b/api/encoding_manifests_dash_api.go
@@ -39,6 +39,7 @@ func NewEncodingManifestsDashAPIWithClient(apiClient *apiclient.APIClient) *Enco
 }
 
 // Create Custom DASH Manifest
+// A Custom DASH Manifest gives you full control over its contents. Add Periods, Adaptation Sets, Representations, Content Protections or Custom XML Elements via the respective endpoints. If you need a simpler solution, create a Default Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
 func (api *EncodingManifestsDashAPI) Create(dashManifest model.DashManifest) (*model.DashManifest, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/encoding_manifests_dash_default_api.go b/api/encoding_manifests_dash_default_api.go
@@ -27,6 +27,7 @@ func NewEncodingManifestsDashDefaultAPIWithClient(apiClient *apiclient.APIClient
 }
 
 // Create Default DASH Manifest
+// A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
 func (api *EncodingManifestsDashDefaultAPI) Create(dashManifestDefault model.DashManifestDefault) (*model.DashManifestDefault, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/encoding_manifests_hls_api.go b/api/encoding_manifests_hls_api.go
@@ -42,6 +42,7 @@ func NewEncodingManifestsHlsAPIWithClient(apiClient *apiclient.APIClient) *Encod
 }
 
 // Create Custom HLS Manifest
+// A Custom HLS Manifest gives you full control over its contents. Add Variant Streams and Media elements via the respective endpoints. If you need a simpler solution, create a Default Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
 func (api *EncodingManifestsHlsAPI) Create(hlsManifest model.HlsManifest) (*model.HlsManifest, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/encoding_manifests_hls_default_api.go b/api/encoding_manifests_hls_default_api.go
@@ -27,6 +27,7 @@ func NewEncodingManifestsHlsDefaultAPIWithClient(apiClient *apiclient.APIClient)
 }
 
 // Create Default HLS Manifest
+// A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
 func (api *EncodingManifestsHlsDefaultAPI) Create(hlsManifestDefault model.HlsManifestDefault) (*model.HlsManifestDefault, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/encoding_manifests_smooth_api.go b/api/encoding_manifests_smooth_api.go
@@ -42,6 +42,7 @@ func NewEncodingManifestsSmoothAPIWithClient(apiClient *apiclient.APIClient) *En
 }
 
 // Create Smooth Streaming Manifest
+// A Custom Smooth Streaming Manifest gives you full control over its contents. Add Representations and Content Protections via the respective endpoints. If you need a simpler solution, create a Default Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
 func (api *EncodingManifestsSmoothAPI) Create(smoothStreamingManifest model.SmoothStreamingManifest) (*model.SmoothStreamingManifest, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/encoding_manifests_smooth_default_api.go b/api/encoding_manifests_smooth_default_api.go
@@ -27,6 +27,7 @@ func NewEncodingManifestsSmoothDefaultAPIWithClient(apiClient *apiclient.APIClie
 }
 
 // Create Default Smooth Streaming Manifest
+// A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
 func (api *EncodingManifestsSmoothDefaultAPI) Create(smoothManifestDefault model.SmoothManifestDefault) (*model.SmoothManifestDefault, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/encoding_simple_jobs_live_api.go b/api/encoding_simple_jobs_live_api.go
@@ -27,6 +27,7 @@ func NewEncodingSimpleJobsLiveAPIWithClient(apiClient *apiclient.APIClient) *Enc
 }
 
 // Create a Simple Encoding Live Job
+// Check out our [Simple Encoding API Live Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api-live) for additional information about the Simple Encoding API Live.
 func (api *EncodingSimpleJobsLiveAPI) Create(simpleEncodingLiveJobRequest model.SimpleEncodingLiveJobRequest) (*model.SimpleEncodingLiveJobResponse, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/encoding_simple_jobs_vod_api.go b/api/encoding_simple_jobs_vod_api.go
@@ -28,6 +28,7 @@ func NewEncodingSimpleJobsVodAPIWithClient(apiClient *apiclient.APIClient) *Enco
 }
 
 // Create a Simple Encoding VOD Job
+// Check out our [Simple Encoding API Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api) for additional information about the Simple Encoding API.
 func (api *EncodingSimpleJobsVodAPI) Create(simpleEncodingVodJobRequest model.SimpleEncodingVodJobRequest) (*model.SimpleEncodingVodJobResponse, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}
@@ -38,7 +39,7 @@ func (api *EncodingSimpleJobsVodAPI) Create(simpleEncodingVodJobRequest model.Si
 }
 
 // Get Simple Encoding VOD Job details
-// Get the details of a Simple Encoding VOD Job.  Check out our [Simple Encoding API Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api) for additional information about the Simple Encoding API.
+// Get the details of a Simple VOD Encoding Job.  Check out our [Simple Encoding API Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api) for additional information about the Simple Encoding API.
 func (api *EncodingSimpleJobsVodAPI) Get(simpleEncodingJobId string) (*model.SimpleEncodingVodJobResponse, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 		params.PathParams["simple_encoding_job_id"] = simpleEncodingJobId

diff --git a/api/notifications_webhooks_encoding_encodings_error_api.go b/api/notifications_webhooks_encoding_encodings_error_api.go
@@ -33,6 +33,7 @@ func NewNotificationsWebhooksEncodingEncodingsErrorAPIWithClient(apiClient *apic
 }
 
 // Create Add &#39;Encoding Error&#39; Webhook
+// Add a new webhook notification that triggers if an encoding fails. A maximum number of 5 webhooks is allowed
 func (api *NotificationsWebhooksEncodingEncodingsErrorAPI) Create(webhook model.Webhook) (*model.Webhook, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/notifications_webhooks_encoding_encodings_finished_api.go b/api/notifications_webhooks_encoding_encodings_finished_api.go
@@ -33,6 +33,7 @@ func NewNotificationsWebhooksEncodingEncodingsFinishedAPIWithClient(apiClient *a
 }
 
 // Create Add &#39;Encoding Finished&#39; Webhook
+// Add a new webhook notification that triggers if an encoding finishes successfully. A maximum number of 5 webhooks is allowed
 func (api *NotificationsWebhooksEncodingEncodingsFinishedAPI) Create(webhook model.Webhook) (*model.Webhook, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/notifications_webhooks_encoding_encodings_transfer_error_api.go b/api/notifications_webhooks_encoding_encodings_transfer_error_api.go
@@ -33,6 +33,7 @@ func NewNotificationsWebhooksEncodingEncodingsTransferErrorAPIWithClient(apiClie
 }
 
 // Create Add &#39;Encoding Transfer Error&#39; Webhook
+// Add a new webhook notification that triggers if a transfer fails. A maximum number of 5 webhooks is allowed
 func (api *NotificationsWebhooksEncodingEncodingsTransferErrorAPI) Create(webhook model.Webhook) (*model.Webhook, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/api/notifications_webhooks_encoding_manifest_error_api.go b/api/notifications_webhooks_encoding_manifest_error_api.go
@@ -27,6 +27,7 @@ func NewNotificationsWebhooksEncodingManifestErrorAPIWithClient(apiClient *apicl
 }
 
 // Create Add &#39;Manifest Error&#39; Webhook (All Manifests)
+// Add a new webhook notification that triggers if a manifest generation fails. A maximum number of 5 webhooks is allowed
 func (api *NotificationsWebhooksEncodingManifestErrorAPI) Create(webhook model.Webhook) (*model.Webhook, error) {
 	reqParams := func(params *apiclient.RequestParams) {
 	}

diff --git a/apiclient/api_client.go b/apiclient/api_client.go
@@ -63,7 +63,7 @@ type PathParams map[string]interface{}
 const QueryParamTagName = "query"
 const DefaultAPIBaseURL = "https://api.bitmovin.com/v1"
 const ContentTypeJson = "application/json"
-const APIClientVersion = "1.165.0-alpha.0"
+const APIClientVersion = "1.166.0-alpha.0"
 const APIClientName = "bitmovin-api-sdk-go"
 const NoAPIKeyErrorMsg = "there was no api key provided"
 

diff --git a/model/av1_video_configuration.go b/model/av1_video_configuration.go
@@ -35,7 +35,7 @@ type Av1VideoConfiguration struct {
 	SampleAspectRatioDenominator *int32 `json:"sampleAspectRatioDenominator,omitempty"`
 	// Specifies a display aspect ratio (DAR) to be enforced. The sample aspect ratio (SAR) will be adjusted accordingly. If set then sampleAspectRatioNumerator and sampleAspectRatioDenominator are not allowed.
 	DisplayAspectRatio *DisplayAspectRatio `json:"displayAspectRatio,omitempty"`
-	// The mode of the encoding
+	// The mode of the encoding. When this is set, `encodingMode` (`liveEncodingMode`) must not be set in the (live) encoding start request.
 	EncodingMode EncodingMode `json:"encodingMode,omitempty"`
 	// Use a set of well defined configurations preset to support certain use cases. Can be overwritten with more specific values.
 	PresetConfiguration Av1PresetConfiguration `json:"presetConfiguration,omitempty"`