operations

type CreateMediaPlaybackIDAccessPolicy string

type CreateMediaPlaybackIDAccessRestrictions struct {
	Domains    *CreateMediaPlaybackIDDomains    `json:"domains,omitempty"`
	UserAgents *CreateMediaPlaybackIDUserAgents `json:"userAgents,omitempty"`
}

type CreateMediaPlaybackIDDomains struct {
	// Specifies the default access policy for domains.
	// If set to `allow`, all domains are allowed access unless otherwise specified in the `deny` list.
	// If set to `deny`, all domains are denied access unless otherwise specified in the `allow` list.
	//
	DefaultPolicy *CreateMediaPlaybackIDDomainsDefaultPolicy `json:"defaultPolicy,omitempty"`
	// A list of domain names or patterns that are explicitly allowed access.
	// This list is only effective when the `defaultPolicy` is set to `deny`.
	//
	Allow []string `json:"allow,omitempty"`
	// A list of domain names or patterns that are explicitly denied access.
	// This list is only effective when the `defaultPolicy` is set to `allow`.
	//
	Deny []string `json:"deny,omitempty"`
}

type CreateMediaPlaybackIDDomainsDefaultPolicy string

type CreateMediaPlaybackIDRequest struct {
	// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
	MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
	// Request body for creating playback id for an media
	RequestBody *CreateMediaPlaybackIDRequestBody `request:"mediaType=application/json"`
}

type CreateMediaPlaybackIDRequestBody struct {
	// Determines if access to the streamed content is kept private or available to all.
	AccessPolicy       CreateMediaPlaybackIDAccessPolicy        `json:"accessPolicy"`
	AccessRestrictions *CreateMediaPlaybackIDAccessRestrictions `json:"accessRestrictions,omitempty"`
}

type CreateMediaPlaybackIDResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Playback id for an media
	Object *CreateMediaPlaybackIDResponseBody
}

type CreateMediaPlaybackIDResponseBody struct {
	// Demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data *Data `json:"data,omitempty"`
}

type CreateMediaPlaybackIDUserAgents struct {
	// Specifies the default access policy for user agents (browsers, bots, etc.).
	// If set to `allow`, all user agents are allowed access unless otherwise specified in the `deny` list.
	// If set to `deny`, all user agents are denied access unless otherwise specified in the `allow` list.
	//
	DefaultPolicy *CreateMediaPlaybackIDUserAgentsDefaultPolicy `json:"defaultPolicy,omitempty"`
	// A list of user agents (identified by string names or patterns) that are explicitly allowed access.
	// This list is only effective when the `defaultPolicy` is set to `deny`.
	//
	Allow []string `json:"allow,omitempty"`
	// A list of user agents (identified by string names or patterns) that are explicitly denied access.
	// This list is only effective when the `defaultPolicy` is set to `allow`.
	//
	Deny []string `json:"deny,omitempty"`
}

type CreateMediaPlaybackIDUserAgentsDefaultPolicy string

type CreateMediaResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Media is created successfully
	Object *CreateMediaResponseBody
}

type CreateMediaResponseBody struct {
	// Demonstrates whether the request is successful or not.
	Success *bool                           `json:"success,omitempty"`
	Data    *components.CreateMediaResponse `json:"data,omitempty"`
}

type CreateNewStreamResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Stream created successfully
	LiveStreamResponseDTO *components.LiveStreamResponseDTO
}

type CreatePlaybackIDOfStreamRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID          string                        `pathParam:"style=simple,explode=false,name=streamId"`
	PlaybackIDRequest *components.PlaybackIDRequest `request:"mediaType=application/json"`
}

type CreatePlaybackIDOfStreamResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// New PlaybackId created successfully
	PlaybackIDResponse *components.PlaybackIDResponse
}

type CreateSimulcastOfStreamRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID         string                       `pathParam:"style=simple,explode=false,name=streamId"`
	SimulcastRequest *components.SimulcastRequest `request:"mediaType=application/json"`
}

type CreateSimulcastOfStreamResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// New Simulcast created successfully
	SimulcastResponse *components.SimulcastResponse
}

type Data struct {
	// A collection of Playback ID objects utilized for crafting HLS playback URLs.
	PlaybackIds []components.PlaybackID `json:"playbackIds,omitempty"`
}

type DeleteLiveStreamRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
}

type DeleteLiveStreamResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Stream deleted successfully
	LiveStreamDeleteResponse *components.LiveStreamDeleteResponse
}

type DeleteMediaPlaybackIDRequest struct {
	// Return the universal unique identifier for media which can contain a maximum of 255 characters.
	MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
	// Return the universal unique identifier for playbacks  which can contain a maximum of 255 characters.
	PlaybackID string `queryParam:"style=form,explode=true,name=playbackId"`
}

type DeleteMediaPlaybackIDResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Deleted a Playback Id successfully
	Object *DeleteMediaPlaybackIDResponseBody
}

type DeleteMediaPlaybackIDResponseBody struct {
	// Demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
}

type DeleteMediaRequest struct {
	// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
	MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
}

type DeleteMediaResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Delete a video media
	Object *DeleteMediaResponseBody
}

type DeleteMediaResponseBody struct {
	// Demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
}

type DeletePlaybackIDOfStreamRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
	// Unique identifier for the playbackId
	PlaybackID string `queryParam:"style=form,explode=true,name=playbackId"`
}

type DeletePlaybackIDOfStreamResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Stream's playbackId deleted successfully
	LiveStreamDeleteResponse *components.LiveStreamDeleteResponse
}

type DeleteSimulcastOfStreamRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
	// When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
	SimulcastID string `pathParam:"style=simple,explode=false,name=simulcastId"`
}

type DeleteSimulcastOfStreamResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Stream's simulcast deleted successfully
	SimulcastdeleteResponse *components.SimulcastdeleteResponse
}

type DirectUploadVideoMediaAccessPolicy string

type DirectUploadVideoMediaAccessRestrictions struct {
	Domains    *DirectUploadVideoMediaDomains    `json:"domains,omitempty"`
	UserAgents *DirectUploadVideoMediaUserAgents `json:"userAgents,omitempty"`
}

type DirectUploadVideoMediaDomains struct {
	// Specifies the default access policy for domains.
	// If set to `allow`, all domains are allowed access unless otherwise specified in the `deny` list.
	// If set to `deny`, all domains are denied access unless otherwise specified in the `allow` list.
	//
	DefaultPolicy *DirectUploadVideoMediaDomainsDefaultPolicy `json:"defaultPolicy,omitempty"`
	// A list of domain names or patterns that are explicitly allowed access.
	// This list is only effective when the `defaultPolicy` is set to `deny`.
	//
	Allow []string `json:"allow,omitempty"`
	// A list of domain names or patterns that are explicitly denied access.
	// This list is only effective when the `defaultPolicy` is set to `allow`.
	//
	Deny []string `json:"deny,omitempty"`
}

type DirectUploadVideoMediaDomainsDefaultPolicy string

type DirectUploadVideoMediaMetadata struct {
}

type DirectUploadVideoMediaRequest struct {
	// Upload media directly from a device using the URL name or enter '*' to allow all.
	CorsOrigin string `json:"corsOrigin"`
	// Configuration settings for media upload.
	PushMediaSettings *PushMediaSettings `json:"pushMediaSettings,omitempty"`
}

type DirectUploadVideoMediaResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Direct upload created successfully
	Object *DirectUploadVideoMediaResponseBody
}

type DirectUploadVideoMediaResponseBody struct {
	// Demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data *components.DirectUpload `json:"data,omitempty"`
}

type DirectUploadVideoMediaUserAgents struct {
	// Specifies the default access policy for user agents (browsers, bots, etc.).
	// If set to `allow`, all user agents are allowed access unless otherwise specified in the `deny` list.
	// If set to `deny`, all user agents are denied access unless otherwise specified in the `allow` list.
	//
	DefaultPolicy *DirectUploadVideoMediaUserAgentsDefaultPolicy `json:"defaultPolicy,omitempty"`
	// A list of user agents (identified by string names or patterns) that are explicitly allowed access.
	// This list is only effective when the `defaultPolicy` is set to `deny`.
	//
	Allow []string `json:"allow,omitempty"`
	// A list of user agents (identified by string names or patterns) that are explicitly denied access.
	// This list is only effective when the `defaultPolicy` is set to `allow`.
	//
	Deny []string `json:"deny,omitempty"`
}

type DirectUploadVideoMediaUserAgentsDefaultPolicy string

type GetAllStreamsOrderBy string

type GetAllStreamsRequest struct {
	// Limit specifies the maximum number of items to display per page.
	Limit *string `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Offset determines the starting point for data retrieval within a paginated list.
	Offset *string `default:"1" queryParam:"style=form,explode=true,name=offset"`
	// The list of value can be order in two ways DESC (Descending) or ASC (Ascending). In case not specified, by default it will be DESC.
	OrderBy *GetAllStreamsOrderBy `default:"desc" queryParam:"style=form,explode=true,name=orderBy"`
}

type GetAllStreamsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// All streams retrieved sucessfully
	GetStreamsResponse *components.GetStreamsResponse
}

type GetLiveStreamByIDRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
}

type GetLiveStreamByIDResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Stream details retrieved successfully
	LivestreamgetResponse *components.LivestreamgetResponse
}

type GetLiveStreamPlaybackIDRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
	// Upon creating a new playbackId, FastPix assigns a unique identifier to the playback.
	PlaybackID string `pathParam:"style=simple,explode=false,name=playbackId"`
}

type GetLiveStreamPlaybackIDResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Stream details retrieved successfully
	PlaybackIDResponse *components.PlaybackIDResponse
}

type GetMediaRequest struct {
	// The Media Id is assigned a universal unique identifier, which can contain a maximum of 255 characters.
	MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
}

type GetMediaResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Get a video media by id
	Object *GetMediaResponseBody
}

type GetMediaResponseBody struct {
	// Demonstrates whether the request is successful or not.
	Success *bool             `json:"success,omitempty"`
	Data    *components.Media `json:"data,omitempty"`
}

type GetSpecificSimulcastOfStreamRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
	// When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
	SimulcastID string `pathParam:"style=simple,explode=false,name=simulcastId"`
}

type GetSpecificSimulcastOfStreamResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Stream's simulcast details fetched successfully
	SimulcastResponse *components.SimulcastResponse
}

type Input struct {
	VideoInput     *components.VideoInput     `queryParam:"inline"`
	WatermarkInput *components.WatermarkInput `queryParam:"inline"`
	AudioInput     *components.AudioInput     `queryParam:"inline"`
	SubtitleInput  *components.SubtitleInput  `queryParam:"inline"`

	Type InputType
}

type InputType string

type LanguageCode string

type ListMediaOrderBy string

type ListMediaRequest struct {
	// Limit specifies the maximum number of items to display per page.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Offset determines the starting point for data retrieval within a paginated list.
	Offset *int64 `default:"1" queryParam:"style=form,explode=true,name=offset"`
	// The values in the list can be arranged in two ways: DESC (Descending) or ASC (Ascending).
	OrderBy *ListMediaOrderBy `default:"desc" queryParam:"style=form,explode=true,name=orderBy"`
}

type ListMediaResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// List of video media
	Object *ListMediaResponseBody
}

type ListMediaResponseBody struct {
	// Demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data []components.Media `json:"data,omitempty"`
	// Pagination organizes content into pages for better readability and navigation.
	Pagination *components.Pagination `json:"pagination,omitempty"`
}

type MaxResolution string

type Moderation struct {
	// Defines the type of input. Possible values include video, audio, av.
	//
	Type *Type `json:"type,omitempty"`
}

type Mp4Support string

type Option func(*Options, ...string) error

type Options struct {
	ServerURL   *string
	Retries     *retry.Config
	Timeout     *time.Duration
	URLOverride *string
	SetHeaders  map[string]string
}

type PushMediaSettings struct {
	// Determines if access to the streamed content is kept private or available to all.
	AccessPolicy DirectUploadVideoMediaAccessPolicy `json:"accessPolicy"`
	// Start time indicates where encoding should begin within the video file, in seconds.
	StartTime *float64 `json:"startTime,omitempty"`
	// End time indicates where encoding should end within the video file, in seconds.
	EndTime *float64 `json:"endTime,omitempty"`
	Inputs  []Input  `json:"inputs,omitempty"`
	// Tag a video in "key" : "value" pairs for searchable metadata. Maximum 10 entries, 255 characters each.
	Metadata *DirectUploadVideoMediaMetadata `json:"metadata,omitempty"`
	// Generates subtitle files for audio/video files.
	//
	Subtitles *Subtitles `json:"subtitles,omitempty"`
	// Enhance the quality and volume of the audio track. This is available for pre-recorded content only.
	//
	OptimizeAudio *bool `default:"true" json:"optimizeAudio"`
	// Determines the highest quality resolution available.
	//
	MaxResolution *MaxResolution `default:"1080p" json:"maxResolution"`
	// The sourceAccess parameter determines whether the original media file is accessible. Set to true to enable access or false to restrict it
	SourceAccess *bool `json:"sourceAccess,omitempty"`
	// Generates MP4 video up to 4K ("capped_4k"), m4a audio only ("audioOnly"), or both for offline viewing.
	//
	Mp4Support *Mp4Support `json:"mp4Support,omitempty"`
	Summary    *Summary    `json:"summary,omitempty"`
	// Enable or disable the chapters feature for the media. Set to `true` to enable chapters or `false` to disable.
	//
	Chapters *bool `json:"chapters,omitempty"`
	// Enable or disable named entity extraction. Set to `true` to enable or `false` to disable.
	//
	NamedEntities      *bool                                     `json:"namedEntities,omitempty"`
	Moderation         *Moderation                               `json:"moderation,omitempty"`
	AccessRestrictions *DirectUploadVideoMediaAccessRestrictions `json:"accessRestrictions,omitempty"`
}

type RetrieveMediaInputInfoRequest struct {
	// Pass the list of the input objects used to create the media, along with applied settings.
	MediaID string `pathParam:"style=simple,explode=false,name=mediaId"`
}

type RetrieveMediaInputInfoResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Get video media input information
	Object *RetrieveMediaInputInfoResponseBody
}

type RetrieveMediaInputInfoResponseBody struct {
	// Demonstrates whether the request is successful or not.
	Success *bool `json:"success,omitempty"`
	// Displays the result of the request.
	Data any `json:"data,omitempty"`
}

type Subtitles struct {
	// Name of the language for the subtitles.
	LanguageName *string `json:"languageName,omitempty"`
	// Searchable metadata tags for the video in key-value pairs.
	Metadata *SubtitlesMetadata `json:"metadata,omitempty"`
	// Language codes (BCP 47 compliant) used for text files.
	//
	LanguageCode *LanguageCode `json:"languageCode,omitempty"`
}

type SubtitlesMetadata struct {
}

type Summary struct {
	// Enable or disable the summary feature for the media. Set to true to enable summary or false to disable.
	//
	Generate *bool `json:"generate,omitempty"`
	// Specifies the desired word count for the generated summary.
	// - The value must be between **30** and **250** words.
	//
	SummaryLength *int64 `default:"100" json:"summaryLength"`
}

type Type string

type UpdateLiveStreamRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID               string                             `pathParam:"style=simple,explode=false,name=streamId"`
	PatchLiveStreamRequest *components.PatchLiveStreamRequest `request:"mediaType=application/json"`
}

type UpdateLiveStreamResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Stream details updated successfully
	PatchResponseDTO *components.PatchResponseDTO
}

type UpdateSpecificSimulcastOfStreamRequest struct {
	// Upon creating a new live stream, FastPix assigns a unique identifier to the stream.
	StreamID string `pathParam:"style=simple,explode=false,name=streamId"`
	// When you create the new simulcast, FastPix assign a universal unique identifier which can contain a maximum of 255 characters.
	SimulcastID            string                             `pathParam:"style=simple,explode=false,name=simulcastId"`
	SimulcastUpdateRequest *components.SimulcastUpdateRequest `request:"mediaType=application/json"`
}

type UpdateSpecificSimulcastOfStreamResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Stream's simulcast details fetched successfully
	SimulcastUpdateResponse *components.SimulcastUpdateResponse
}

type UpdatedMediaMetadata struct {
}

type UpdatedMediaRequest struct {
	// When creating the media, FastPix assigns a universally unique identifier with a maximum length of 255 characters.
	MediaID     string                   `pathParam:"style=simple,explode=false,name=mediaId"`
	RequestBody *UpdatedMediaRequestBody `request:"mediaType=application/json"`
}

type UpdatedMediaRequestBody struct {
	// You can search for videos with specific key value pairs using metadata, when you tag a video in "key" : "value" pairs. Dynamic Metadata allows you to define a key that allows any value pair. You can have maximum of 255 characters and upto 10 entries are allowed.
	Metadata *UpdatedMediaMetadata `json:"metadata,omitempty"`
}

type UpdatedMediaResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Media details updated successfully
	Object *UpdatedMediaResponseBody
}

type UpdatedMediaResponseBody struct {
	// Demonstrates whether the request is successful or not.
	Success *bool             `json:"success,omitempty"`
	Data    *components.Media `json:"data,omitempty"`
}