import * as z from "zod/v3"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; export type PutMediasMediaIdCustomizationsVideoThumbnailRequest = { /** * If set to false, removes the “Click to Play” button on video thumbnails. */ clickToPlayButton?: boolean | undefined; }; export type PutMediasMediaIdCustomizationsSocialbarV1Request = { buttons?: string | undefined; showTweetCount?: boolean | undefined; tweetText?: string | undefined; height?: number | undefined; }; export type PutMediasMediaIdCustomizationsChapterListRequest = { id?: string | undefined; title?: string | undefined; time?: string | undefined; deleted?: string | undefined; }; export type PutMediasMediaIdCustomizationsChaptersRequest = { visibleOnLoad?: boolean | undefined; chapterList?: Array | undefined; on?: boolean | undefined; }; /** * The time when the post-roll should be displayed. Can be a string like "end" or a number representing seconds. */ export type PutMediasMediaIdCustomizationsTime = string | number; export type PutMediasMediaIdCustomizationsStyleRequest = { /** * The background color of the post-roll. */ backgroundColor?: string | undefined; }; /** * Adds a Call To Action to your Video */ export type PutMediasMediaIdCustomizationsPostRollV1Request = { /** * If set to true, allows the video to be rewatched. */ rewatch?: boolean | undefined; /** * The URL of the text to be displayed. */ text?: string | undefined; /** * The URL of the link to be displayed. */ link?: string | undefined; /** * The time when the post-roll should be displayed. Can be a string like "end" or a number representing seconds. */ time?: string | number | undefined; /** * If set to true, the post-roll will automatically adjust its size. */ autoSize?: boolean | undefined; style?: PutMediasMediaIdCustomizationsStyleRequest | undefined; /** * The type of call-to-action to be displayed. Typically set to "text". Other options are "image" which allows for "altText", and "html". */ ctaType?: string | undefined; /** * If set to true, the post-roll is enabled. */ on?: boolean | undefined; /** * The key used for tracking conversion opportunities. */ conversionOpportunityKey?: string | undefined; }; /** * Enables closed captions for the video */ export type PutMediasMediaIdCustomizationsCaptionsV1Request = { /** * If set to true, the captions plugin is enabled and captions controls will be available to viewers. */ on?: boolean | undefined; /** * If set to true, captions will be turned on automatically when the video loads. Only takes effect when the captions plugin is enabled. */ onByDefault?: boolean | undefined; }; export type PutMediasMediaIdCustomizationsPluginRequest = { videoThumbnail?: PutMediasMediaIdCustomizationsVideoThumbnailRequest | undefined; socialbarV1?: PutMediasMediaIdCustomizationsSocialbarV1Request | undefined; chapters?: PutMediasMediaIdCustomizationsChaptersRequest | undefined; /** * Adds a Call To Action to your Video */ postRollV1?: PutMediasMediaIdCustomizationsPostRollV1Request | undefined; /** * Enables closed captions for the video */ captionsV1?: PutMediasMediaIdCustomizationsCaptionsV1Request | undefined; }; /** * Examples: * * @remarks * ```json * { * "minWidth": 400, * "maxWidth": 960 * } * ``` * ```json * { * "minHeight": 300, * "maxHeight": 450 * } * ``` */ export type PutMediasMediaIdCustomizationsVideoFoam = { /** * Minimum width the video can be resized to. */ minWidth?: number | undefined; /** * Maximum width the video can be resized to. */ maxWidth?: number | undefined; /** * Minimum height the video can be resized to. */ minHeight?: number | undefined; /** * Maximum height the video can be resized to. */ maxHeight?: number | undefined; }; /** * When set to true, the video will adjust its size according to its parent element. It can also be an object specifying min/max width or height. */ export type PutMediasMediaIdCustomizationsVideoFoamUnion = boolean | PutMediasMediaIdCustomizationsVideoFoam; /** * A collection of settings you can apply to a video to change its appearance and * * @remarks * behavior. */ export type PutMediasMediaIdCustomizationsRequestBody = { /** * If set to true, the video will play as soon as it’s ready. Note that autoplay might not work on some devices and browsers. */ autoPlay?: boolean | undefined; /** * If set to true, controls like the big play button, playbar, volume, etc. will be visible as soon as the video is embedded. */ controlsVisibleOnLoad?: boolean | undefined; /** * If set to false, the option to “Copy Link and Thumbnail” will be removed when right-clicking on the video. */ copyLinkAndThumbnailEnabled?: boolean | undefined; /** * If set to true, data for each viewing session will not be tracked. */ doNotTrack?: boolean | undefined; /** * Associate a specific email address with this video’s viewing sessions. */ email?: string | undefined; /** * Determines what happens when the video ends. Options are default (stays on the last frame), reset (shows thumbnail and controls), and loop (plays again from the start). */ endVideoBehavior?: string | undefined; /** * If set to true, the video will try to play in a pseudo-fullscreen mode on certain mobile devices. */ fakeFullscreen?: boolean | undefined; /** * Resizes the video when there's a discrepancy between its aspect ratio and that of its parent container. Options are contain, cover, fill, and none. */ fitStrategy?: string | undefined; /** * If set to true, the fullscreen button will be available as a video control. */ fullscreenButton?: boolean | undefined; /** * If set to false, the video will not automatically go to fullscreen mode on mobile when rotated to landscape. */ fullscreenOnRotateToLandscape?: boolean | undefined; /** * If set to false, the key moments feature will be disabled. */ keyMoments?: boolean | undefined; /** * If set to true, the video will start in a muted state. */ muted?: boolean | undefined; /** * If set to false, the playback speed controls in the settings menu will be hidden. */ playbackRateControl?: boolean | undefined; /** * If set to true, the playbar will be available. If set to false, it will be hidden. */ playbar?: boolean | undefined; /** * Indicates if the play button is visible. */ playButton?: boolean | undefined; /** * Changes the base color of the player. Expects a hexadecimal rgb string. */ playerColor?: string | undefined; /** * Enables the use of specially crafted links on the page to associate with a video, turning them into a playlist. */ playlistLinks?: boolean | undefined; /** * If set to true and this video has a playlist, it will loop back to the first video after the last one has finished. */ playlistLoop?: boolean | undefined; /** * If set to false, videos will play within the native mobile player. */ playsinline?: boolean | undefined; /** * If set to false, animations for the Pause and Play symbols will be removed. */ playPauseNotifier?: boolean | undefined; /** * If set to false for a muted autoplay video, the video won't pause when out of view. */ playSuspendedOffScreen?: boolean | undefined; plugin?: PutMediasMediaIdCustomizationsPluginRequest | undefined; /** * Sets the video’s preload property. Possible values are metadata, auto, none, true, and false. */ preload?: string | undefined; /** * If set to false, the video quality selector in the settings menu will be hidden. */ qualityControl?: boolean | undefined; /** * Specifies the maximum quality the video will play at. */ qualityMax?: number | undefined; /** * Specifies the minimum quality the video will play at. */ qualityMin?: number | undefined; /** * Determines if the video should resume from where the viewer left off. Options are true, false, and auto. */ resumable?: string | undefined; /** * If set to true, the video’s metadata will be injected into the page’s markup for SEO. */ seo?: boolean | undefined; /** * If set to true, the settings control will be available. */ settingsControl?: boolean | undefined; /** * Determines how videos handle autoplay in contexts where normal autoplay might be blocked. Options are true, allow, and false. */ silentAutoPlay?: string | undefined; smallPlayButton?: boolean | undefined; /** * Overrides the thumbnail image that appears before the video plays. */ stillUrl?: string | undefined; /** * Sets the starting time of the video. */ time?: string | undefined; /** * Sets the Thumbnail Alt Text for the media. */ thumbnailAltText?: string | undefined; /** * When set to true, the video will adjust its size according to its parent element. It can also be an object specifying min/max width or height. */ videoFoam?: boolean | PutMediasMediaIdCustomizationsVideoFoam | undefined; /** * Sets the volume of the video. */ volume?: number | undefined; /** * When set to true, a volume control is available over the video. */ volumeControl?: boolean | undefined; /** * If set to transparent, the background behind the player will be transparent instead of black. */ wmode?: string | undefined; }; export type PutMediasMediaIdCustomizationsRequest = { /** * The hashed ID of the video to be customized. */ mediaId: string; requestBody: PutMediasMediaIdCustomizationsRequestBody; }; export type PutMediasMediaIdCustomizationsPasswordProtectedVideo = { on?: string | undefined; src?: string | undefined; challenge?: string | undefined; async?: string | undefined; }; export type PutMediasMediaIdCustomizationsVideoThumbnailResponse = { clickToPlayButton?: string | undefined; }; export type PutMediasMediaIdCustomizationsSocialbarV1Response = { buttons?: string | undefined; showTweetCount?: string | undefined; tweetText?: string | undefined; height?: string | undefined; }; export type PutMediasMediaIdCustomizationsChapterListResponse = { id?: string | undefined; title?: string | undefined; time?: string | undefined; deleted?: string | undefined; }; export type PutMediasMediaIdCustomizationsChaptersResponse = { visibleOnLoad?: string | undefined; chapterList?: Array | undefined; on?: string | undefined; }; export type PutMediasMediaIdCustomizationsStyleResponse = { /** * The background color of the post-roll. */ backgroundColor?: string | undefined; }; /** * Adds a Call To Action to your Video (response format) */ export type PutMediasMediaIdCustomizationsPostRollV1Response = { /** * String representation of whether the video can be rewatched. */ rewatch?: string | undefined; /** * The URL of the text to be displayed. */ text?: string | undefined; /** * The URL of the link to be displayed. */ link?: string | undefined; /** * The time when the post-roll should be displayed as a string. */ time?: string | undefined; /** * String representation of whether the post-roll will automatically adjust its size. */ autoSize?: string | undefined; style?: PutMediasMediaIdCustomizationsStyleResponse | undefined; /** * The type of call-to-action to be displayed. */ ctaType?: string | undefined; /** * String representation of whether the post-roll is enabled. */ on?: string | undefined; /** * The key used for tracking conversion opportunities. */ conversionOpportunityKey?: string | undefined; }; /** * Captions plugin configuration (response format) */ export type PutMediasMediaIdCustomizationsCaptionsV1Response = { /** * String representation of whether the captions plugin is enabled ("true" or "false"). */ on?: string | undefined; /** * String representation of whether captions are turned on by default ("true" or "false"). */ onByDefault?: string | undefined; }; export type PutMediasMediaIdCustomizationsPluginResponse = { passwordProtectedVideo?: PutMediasMediaIdCustomizationsPasswordProtectedVideo | undefined; videoThumbnail?: PutMediasMediaIdCustomizationsVideoThumbnailResponse | undefined; socialbarV1?: PutMediasMediaIdCustomizationsSocialbarV1Response | undefined; chapters?: PutMediasMediaIdCustomizationsChaptersResponse | undefined; /** * Adds a Call To Action to your Video (response format) */ postRollV1?: PutMediasMediaIdCustomizationsPostRollV1Response | undefined; /** * Captions plugin configuration (response format) */ captionsV1?: PutMediasMediaIdCustomizationsCaptionsV1Response | undefined; }; export type PutMediasMediaIdCustomizationsPrivate = { passwordProtectOn?: string | undefined; showComments?: string | undefined; }; export type PutMediasMediaIdCustomizationsEncrypted = { passwordProtectPassword?: string | undefined; }; /** * Video customization update successful */ export type PutMediasMediaIdCustomizationsResponse = { /** * The color of the video player. */ playerColor?: string | undefined; stillUrl?: string | undefined; /** * Whether the video should auto play or not. */ autoPlay?: string | undefined; bpbTime?: string | undefined; controlsVisibleOnLoad?: string | undefined; /** * Behavior of the video at the end. */ endVideoBehavior?: string | undefined; fullscreenButton?: string | undefined; branding?: string | undefined; playbar?: string | undefined; /** * Indicates if the play button is visible. */ playButton?: string | undefined; settingsControl?: string | undefined; showCustomerLogo?: string | undefined; qualityControl?: string | undefined; playbackRateControl?: string | undefined; smallPlayButton?: string | undefined; spherical?: string | undefined; volumeControl?: string | undefined; copyLinkAndThumbnailEnabled?: string | undefined; doNotTrack?: string | undefined; email?: string | undefined; fitStrategy?: string | undefined; fullscreenOnRotateToLandscape?: string | undefined; muted?: string | undefined; playlistLinks?: string | undefined; playlistLoop?: string | undefined; playsinline?: string | undefined; playPauseNotifier?: string | undefined; playSuspendedOffScreen?: string | undefined; preload?: string | undefined; qualityMax?: string | undefined; qualityMin?: string | undefined; resumable?: string | undefined; seo?: string | undefined; silentAutoPlay?: string | undefined; time?: string | undefined; thumbnailAltText?: string | undefined; videoFoam?: string | undefined; volume?: string | undefined; wmode?: string | undefined; /** * String representation of whether the key moments feature is enabled. */ keyMoments?: string | undefined; plugin?: PutMediasMediaIdCustomizationsPluginResponse | undefined; private?: PutMediasMediaIdCustomizationsPrivate | undefined; encrypted?: PutMediasMediaIdCustomizationsEncrypted | undefined; }; /** @internal */ export type PutMediasMediaIdCustomizationsVideoThumbnailRequest$Outbound = { clickToPlayButton?: boolean | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsVideoThumbnailRequest$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsVideoThumbnailRequestToJSON(putMediasMediaIdCustomizationsVideoThumbnailRequest: PutMediasMediaIdCustomizationsVideoThumbnailRequest): string; /** @internal */ export type PutMediasMediaIdCustomizationsSocialbarV1Request$Outbound = { buttons?: string | undefined; showTweetCount?: boolean | undefined; tweetText?: string | undefined; height?: number | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsSocialbarV1Request$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsSocialbarV1RequestToJSON(putMediasMediaIdCustomizationsSocialbarV1Request: PutMediasMediaIdCustomizationsSocialbarV1Request): string; /** @internal */ export type PutMediasMediaIdCustomizationsChapterListRequest$Outbound = { id?: string | undefined; title?: string | undefined; time?: string | undefined; deleted?: string | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsChapterListRequest$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsChapterListRequestToJSON(putMediasMediaIdCustomizationsChapterListRequest: PutMediasMediaIdCustomizationsChapterListRequest): string; /** @internal */ export type PutMediasMediaIdCustomizationsChaptersRequest$Outbound = { visibleOnLoad?: boolean | undefined; chapterList?: Array | undefined; on?: boolean | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsChaptersRequest$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsChaptersRequestToJSON(putMediasMediaIdCustomizationsChaptersRequest: PutMediasMediaIdCustomizationsChaptersRequest): string; /** @internal */ export type PutMediasMediaIdCustomizationsTime$Outbound = string | number; /** @internal */ export declare const PutMediasMediaIdCustomizationsTime$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsTimeToJSON(putMediasMediaIdCustomizationsTime: PutMediasMediaIdCustomizationsTime): string; /** @internal */ export type PutMediasMediaIdCustomizationsStyleRequest$Outbound = { backgroundColor?: string | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsStyleRequest$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsStyleRequestToJSON(putMediasMediaIdCustomizationsStyleRequest: PutMediasMediaIdCustomizationsStyleRequest): string; /** @internal */ export type PutMediasMediaIdCustomizationsPostRollV1Request$Outbound = { rewatch?: boolean | undefined; text?: string | undefined; link?: string | undefined; time?: string | number | undefined; autoSize?: boolean | undefined; style?: PutMediasMediaIdCustomizationsStyleRequest$Outbound | undefined; ctaType?: string | undefined; on?: boolean | undefined; conversionOpportunityKey?: string | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsPostRollV1Request$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsPostRollV1RequestToJSON(putMediasMediaIdCustomizationsPostRollV1Request: PutMediasMediaIdCustomizationsPostRollV1Request): string; /** @internal */ export type PutMediasMediaIdCustomizationsCaptionsV1Request$Outbound = { on?: boolean | undefined; onByDefault?: boolean | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsCaptionsV1Request$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsCaptionsV1RequestToJSON(putMediasMediaIdCustomizationsCaptionsV1Request: PutMediasMediaIdCustomizationsCaptionsV1Request): string; /** @internal */ export type PutMediasMediaIdCustomizationsPluginRequest$Outbound = { videoThumbnail?: PutMediasMediaIdCustomizationsVideoThumbnailRequest$Outbound | undefined; "socialbar-v1"?: PutMediasMediaIdCustomizationsSocialbarV1Request$Outbound | undefined; chapters?: PutMediasMediaIdCustomizationsChaptersRequest$Outbound | undefined; "postRoll-v1"?: PutMediasMediaIdCustomizationsPostRollV1Request$Outbound | undefined; "captions-v1"?: PutMediasMediaIdCustomizationsCaptionsV1Request$Outbound | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsPluginRequest$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsPluginRequestToJSON(putMediasMediaIdCustomizationsPluginRequest: PutMediasMediaIdCustomizationsPluginRequest): string; /** @internal */ export type PutMediasMediaIdCustomizationsVideoFoam$Outbound = { minWidth?: number | undefined; maxWidth?: number | undefined; minHeight?: number | undefined; maxHeight?: number | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsVideoFoam$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsVideoFoamToJSON(putMediasMediaIdCustomizationsVideoFoam: PutMediasMediaIdCustomizationsVideoFoam): string; /** @internal */ export type PutMediasMediaIdCustomizationsVideoFoamUnion$Outbound = boolean | PutMediasMediaIdCustomizationsVideoFoam$Outbound; /** @internal */ export declare const PutMediasMediaIdCustomizationsVideoFoamUnion$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsVideoFoamUnionToJSON(putMediasMediaIdCustomizationsVideoFoamUnion: PutMediasMediaIdCustomizationsVideoFoamUnion): string; /** @internal */ export type PutMediasMediaIdCustomizationsRequestBody$Outbound = { autoPlay?: boolean | undefined; controlsVisibleOnLoad?: boolean | undefined; copyLinkAndThumbnailEnabled?: boolean | undefined; doNotTrack?: boolean | undefined; email?: string | undefined; endVideoBehavior?: string | undefined; fakeFullscreen?: boolean | undefined; fitStrategy?: string | undefined; fullscreenButton?: boolean | undefined; fullscreenOnRotateToLandscape?: boolean | undefined; keyMoments?: boolean | undefined; muted?: boolean | undefined; playbackRateControl?: boolean | undefined; playbar?: boolean | undefined; playButton?: boolean | undefined; playerColor?: string | undefined; playlistLinks?: boolean | undefined; playlistLoop?: boolean | undefined; playsinline?: boolean | undefined; playPauseNotifier?: boolean | undefined; playSuspendedOffScreen?: boolean | undefined; plugin?: PutMediasMediaIdCustomizationsPluginRequest$Outbound | undefined; preload?: string | undefined; qualityControl?: boolean | undefined; qualityMax?: number | undefined; qualityMin?: number | undefined; resumable?: string | undefined; seo?: boolean | undefined; settingsControl?: boolean | undefined; silentAutoPlay?: string | undefined; smallPlayButton?: boolean | undefined; stillUrl?: string | undefined; time?: string | undefined; thumbnailAltText?: string | undefined; videoFoam?: boolean | PutMediasMediaIdCustomizationsVideoFoam$Outbound | undefined; volume?: number | undefined; volumeControl?: boolean | undefined; wmode?: string | undefined; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsRequestBody$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsRequestBodyToJSON(putMediasMediaIdCustomizationsRequestBody: PutMediasMediaIdCustomizationsRequestBody): string; /** @internal */ export type PutMediasMediaIdCustomizationsRequest$Outbound = { mediaId: string; RequestBody: PutMediasMediaIdCustomizationsRequestBody$Outbound; }; /** @internal */ export declare const PutMediasMediaIdCustomizationsRequest$outboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsRequestToJSON(putMediasMediaIdCustomizationsRequest: PutMediasMediaIdCustomizationsRequest): string; /** @internal */ export declare const PutMediasMediaIdCustomizationsPasswordProtectedVideo$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsPasswordProtectedVideoFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsVideoThumbnailResponse$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsVideoThumbnailResponseFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsSocialbarV1Response$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsSocialbarV1ResponseFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsChapterListResponse$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsChapterListResponseFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsChaptersResponse$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsChaptersResponseFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsStyleResponse$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsStyleResponseFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsPostRollV1Response$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsPostRollV1ResponseFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsCaptionsV1Response$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsCaptionsV1ResponseFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsPluginResponse$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsPluginResponseFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsPrivate$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsPrivateFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsEncrypted$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsEncryptedFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const PutMediasMediaIdCustomizationsResponse$inboundSchema: z.ZodType; export declare function putMediasMediaIdCustomizationsResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=putmediasmediaidcustomizations.d.ts.map