openapi

type AssetRenderResponse struct {

	// An array of asset resources grouped by render id.
	Data []AssetResponseData `json:"data"`
}

type AssetResponse struct {
	Data AssetResponseData `json:"data"`
}

type AssetResponseAttributes struct {

	// The unique id of the hosted asset in UUID format.
	ID string `json:"id"`

	// The owner id of the render task.
	Owner string `json:"owner"`

	// The region the asset is hosted, currently only `au` (Australia).
	Region string `json:"region,omitempty"`

	// The original render id that created the asset in UUID format. Multiple assets can share the same render id.
	RenderID string `json:"renderId,omitempty"`

	// The third party id of an asset transferred to an external provider, i.e. Mux, YouTube or S3. If the provider is Shotstack, the providerID is the same as the asset id.
	ProviderID string `json:"providerId,omitempty"`

	// The asset file name.
	Filename string `json:"filename"`

	// The asset file name.
	URL string `json:"url,omitempty"`

	// The status of the asset. <ul>   <li>`importing` - the asset is being copied to the hosting service</li>   <li>`ready` - the asset is ready to be served to users</li>   <li>`failed` - the asset failed to copy or delete</li>   <li>`deleted` - the asset has been deleted</li> </ul>
	Status string `json:"status"`

	// The time the asset was created.
	Created string `json:"created"`

	// The time the asset status was last updated.
	Updated string `json:"updated"`
}

type AssetResponseData struct {

	// The type of resource, in this case it is an assets.
	Type string `json:"type"`

	Attributes AssetResponseAttributes `json:"attributes"`
}

type AssetType int64

type AudioAsset struct {

	// The type of asset - set to `audio` for audio assets.
	Type string `json:"type"`

	// The audio source URL. The URL must be publicly accessible or include credentials.
	Src string `json:"src"`

	// The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in trim point. The audio will play until the file ends or the Clip length is reached.
	Trim float32 `json:"trim,omitempty"`

	// Set the volume for the audio clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
	Volume float32 `json:"volume,omitempty"`

	// The effect to apply to the audio asset <ul>   <li>`fadeIn` - fade volume in only</li>   <li>`fadeOut` - fade volume out only</li>   <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
	Effect string `json:"effect,omitempty"`
}

type Clip struct {
	Asset interface{} `json:"asset"`

	// The s{tart position of the Clip on the timeline, in seconds.
	Start float32 `json:"start"`

	// The length, in seconds, the Clip should play for.
	Length float32 `json:"length"`

	// Set how the asset should be scaled to fit the viewport using one of the following options:    <ul>     <li>`cover` - stretch the asset to fill the viewport without maintaining the aspect ratio.</li>     <li>`contain` - fit the entire asset within the viewport while maintaining the original aspect ratio.</li>     <li>`crop` - scale the asset to fill the viewport while maintaining the aspect ratio. The asset will be cropped if it exceeds the bounds of the viewport.</li>     <li>`none` - preserves the original asset dimensions and does not apply any scaling.</li>   </ul>
	Fit string `json:"fit,omitempty"`

	// Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and  scaling images such as logos and watermarks.
	Scale *float32 `json:"scale,omitempty"`

	// Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position. <ul>   <li>`top` - top (center)</li>   <li>`topRight` - top right</li>   <li>`right` - right (center)</li>   <li>`bottomRight` - bottom right</li>   <li>`bottom` - bottom (center)</li>   <li>`bottomLeft` - bottom left</li>   <li>`left` - left (center)</li>   <li>`topLeft` - top left</li>   <li>`center` - center</li> </ul>
	Position string `json:"position,omitempty"`

	Offset *Offset `json:"offset,omitempty"`

	Transition *Transition `json:"transition,omitempty"`

	// A motion effect to apply to the Clip. <ul>   <li>`zoomIn` - slow zoom in</li>   <li>`zoomOut` - slow zoom out</li>   <li>`slideLeft` - slow slide (pan) left</li>   <li>`slideRight` - slow slide (pan) right</li>   <li>`slideUp` - slow slide (pan) up</li>   <li>`slideDown` - slow slide (pan) down</li> </ul>
	Effect string `json:"effect,omitempty"`

	// A filter effect to apply to the Clip. <ul>   <li>`boost` - boost contrast and saturation</li>   <li>`contrast` - increase contrast</li>   <li>`darken` - darken the scene</li>   <li>`greyscale` - remove color</li>   <li>`lighten` - lighten the scene</li>   <li>`muted` - reduce saturation and contrast</li>   <li>`invert` - invert colors</li> </ul>
	Filter string `json:"filter,omitempty"`

	// Sets the opacity of the Clip where 1 is opaque and 0 is transparent.
	Opacity float32 `json:"opacity,omitempty"`

	Transform *Transformation `json:"transform,omitempty"`
}

type Crop struct {

	// Crop from the top of the asset
	Top float32 `json:"top"`

	// Crop from the bottom of the asset
	Bottom float32 `json:"bottom"`

	// Crop from the left of the asset
	Left float32 `json:"left"`

	// Crop from the left of the asset
	Right float32 `json:"right"`
}

type DownloadAPIController struct {
	// contains filtered or unexported fields
}

type DownloadAPIOption func(*DownloadAPIController)

type DownloadAPIRouter interface {
	DownloadByID(http.ResponseWriter, *http.Request)
}

type DownloadAPIService struct {
	// contains filtered or unexported fields
}

type DownloadAPIServicer interface {
	DownloadByID(context.Context, string) (ImplResponse, error)
}

type Edit struct {
	Timeline Timeline `json:"timeline"`

	Output Output `json:"output"`

	// An array of key/value pairs that provides an easy way to create templates with placeholders. The placeholders can be used to find and replace keys with values. For example you can search for the placeholder `{{NAME}}` and replace it with the value `Jane`.
	Merge []MergeField `json:"merge,omitempty"`

	// An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.io/docs/guide/architecting-an-application/webhooks) for  more details.
	Callback string `json:"callback,omitempty"`

	// The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimized for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
	Disk string `json:"disk,omitempty"`
}

type EditAPIController struct {
	// contains filtered or unexported fields
}

type EditAPIOption func(*EditAPIController)

type EditAPIRouter interface {
	DeleteTemplate(http.ResponseWriter, *http.Request)
	GetRender(http.ResponseWriter, *http.Request)
	GetTemplate(http.ResponseWriter, *http.Request)
	GetTemplates(http.ResponseWriter, *http.Request)
	PostRender(http.ResponseWriter, *http.Request)
	PostTemplate(http.ResponseWriter, *http.Request)
	PostTemplateRender(http.ResponseWriter, *http.Request)
	Probe(http.ResponseWriter, *http.Request)
	PutTemplate(http.ResponseWriter, *http.Request)
}

type EditAPIService struct {
	// contains filtered or unexported fields
}

type EditAPIServicer interface {
	DeleteTemplate(context.Context, string) (ImplResponse, error)
	GetRender(context.Context, string, bool, bool) (ImplResponse, error)
	GetTemplate(context.Context, string) (ImplResponse, error)
	GetTemplates(context.Context) (ImplResponse, error)
	PostRender(context.Context, Edit) (ImplResponse, error)
	PostTemplate(context.Context, Template) (ImplResponse, error)
	PostTemplateRender(context.Context, TemplateRender) (ImplResponse, error)
	Probe(context.Context, string) (ImplResponse, error)
	PutTemplate(context.Context, string, Template) (ImplResponse, error)

	GetQueue() []*RenderQueue
	GetQueuePending() []*RenderQueue
}

type EnumError struct {
	Schema string
	Field  string
	Value  interface{}
}

type ErrorHandler func(w http.ResponseWriter, r *http.Request, err error, result *ImplResponse)

type FFMPEG struct {
	// contains filtered or unexported fields
}

type FFMPEGCommand interface {
	AddSource(string, bool) error
	AddDefaultParams() error
	ToString() []string
	AddTrack(int) error
	CloseTrack(int) error
	AddClip(int, string) error
	ClipTrim(int, int, int, float32, float32) string
	ClipCrop(int, int, int, *Crop) string
	ClipCropOverlayPosition(cropInfos *Crop) string
	ClipImage(int, int, int, float32, float32) string
	ClipMerge(int, int, int, []string) string
	ClipRaw(int, int, int) string
	ClipResize(int, int, int, float32) string
	ClipFillerOverlay(int, int, int, string) string
	ClipSubtitleBurn(int, int, int, int) string

	AddAudioClip(int, string) error
	ClipAudioVolume(int, int, int, float32) string
	ClipAudioDelay(int, int, int, float32) string
	ClipAudioTrim(int, int, int, float32, float32) string
	ClipAudioMerge(int, int, int, []string) string

	SetOutputResolution(string) error
	SetOutputSize(*int32, *int32) error
	SetOutputFormat(string) error
	GetOutputFormat([]string) ([]string, error)
	SetOutputQuality(string) error
	SetDefaultBackground(string) error
	GetResolution() string
	GenerateFiller(string) string
	GenerateBackground() string
	ToFFMPEG(*RenderQueue, *ProcessingQueue) error
	GetOutputName() string
	GetDuration() float32
	OverlayAllTracks([]string) string
}

type FFMPEGSource struct {
	// contains filtered or unexported fields
}

type FFMPEGTrack struct {
	// contains filtered or unexported fields
}

type FlipTransformation struct {

	// Flip a clip horizontally.
	Horizontal bool `json:"horizontal,omitempty"`

	// Flip a clip vertically.
	Vertical bool `json:"vertical,omitempty"`
}

type Font struct {

	// The URL of the font file. The URL must be publicly accessible or include credentials.
	Src string `json:"src"`
}

type HTMLAsset struct {

	// The type of asset - set to `html` for HTML.
	Type string `json:"type"`

	// The HTML text string. See list of [supported HTML tags](https://shotstack.io/docs/guide/architecting-an-application/html-support#supported-html-tags).
	HTML string `json:"html"`

	// The CSS text string to apply styling to the HTML. See list of  [support CSS properties](https://shotstack.io/docs/guide/architecting-an-application/html-support#supported-css-properties).
	CSS string `json:"css,omitempty"`

	// Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box.
	Width int32 `json:"width,omitempty"`

	// Set the width of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the  height of the bounding box.
	Height int32 `json:"height,omitempty"`

	// Apply a background color behind the HTML bounding box using. Set the text color using hexadecimal  color notation. Transparency is supported by setting the first two characters of the hex string  (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.
	Background string `json:"background,omitempty"`

	// Place the HTML in one of nine predefined positions within the HTML area. <ul>   <li>`top` - top (center)</li>   <li>`topRight` - top right</li>   <li>`right` - right (center)</li>   <li>`bottomRight` - bottom right</li>   <li>`bottom` - bottom (center)</li>   <li>`bottomLeft` - bottom left</li>   <li>`left` - left (center)</li>   <li>`topLeft` - top left</li>   <li>`center` - center</li> </ul>
	Position string `json:"position,omitempty"`
}

type ImageAsset struct {

	// The type of asset - set to `image` for images.
	Type string `json:"type"`

	// The image source URL. The URL must be publicly accessible or include credentials.
	Src string `json:"src"`

	Crop *Crop `json:"crop,omitempty"`
}

type ImplResponse struct {
	Code int
	Body interface{}
}

type LocalResource struct {
	Downloaded       time.Time `json:"downloaded"`
	OriginalURL      string
	LocalURL         string
	KeepCache        bool
	IsRemoteResource bool
	Used             []*LocalResourceTrackInfo
}

type LocalResourceTrackInfo struct {
	Track   int
	Clip    int
	Handled bool // Temp Property until all resource are handled (this allow fetching without handling)
}

type LumaAsset struct {

	// The type of asset - set to `luma` for luma mattes.
	Type string `json:"type"`

	// The luma matte source URL. The URL must be publicly accessible or include credentials.
	Src string `json:"src"`

	// The start trim point of the luma matte clip, in seconds (defaults to 0). Videos will start from the in trim point. A luma matte video will play until the file ends or the Clip length is reached.
	Trim float32 `json:"trim,omitempty"`
}

type MergeField struct {

	// The string to find <u>without</u> delimiters.
	Find string `json:"find"`

	// The replacement value. The replacement can be any valid JSON type - string, boolean, number, etc...
	Replace *interface{} `json:"replace"`
}

type MuxDestination struct {

	// The destination to send rendered assets to - set to `mux` for Mux.
	Provider string `json:"provider"`

	Options MuxDestinationOptions `json:"options,omitempty"`
}

type MuxDestinationOptions struct {

	// Sets the Mux `playback_policy` option. Value is an array of strings - use `public`, `signed`, or both.
	PlaybackPolicy []string `json:"playbackPolicy,omitempty"`
}

type Offset struct {

	// Offset an asset on the horizontal axis (left or right), range varies from -1 to 1. Positive numbers move the asset right, negative left. For all assets except titles the distance moved is relative to the width  of the viewport - i.e. an X offset of 0.5 will move the asset half the  screen width to the right.
	X float32 `json:"x,omitempty"`

	// Offset an asset on the vertical axis (up or down), range varies from -1 to 1. Positive numbers move the asset up, negative down. For all assets except titles the distance moved is relative to the height  of the viewport - i.e. an Y offset of 0.5 will move the asset up half the  screen height.
	Y float32 `json:"y,omitempty"`
}

type Output struct {

	// The output format and type of media file to generate. <ul>   <li>`mp4` - mp4 video file</li>   <li>`gif` - animated gif</li>   <li>`jpg` - jpg image file</li>   <li>`png` - png image file</li>   <li>`bmp` - bmp image file</li>   <li>`mp3` - mp3 audio file (audio only)</li> </ul>
	Format string `json:"format"`

	// The output resolution of the video or image. <ul>   <li>`preview` - 512px x 288px @ 15fps</li>   <li>`mobile` - 640px x 360px @ 25fps</li>   <li>`sd` - 1024px x 576px @ 25fps</li>   <li>`hd` - 1280px x 720px @ 25fps</li>   <li>`1080` - 1920px x 1080px @ 25fps</li>   <li>`360` - 640px x 360px @ 25fps</li>   <li>`480` - 848px x 480px @ 25fps</li>   <li>`540` - 960px x 540px @ 25fps</li>   <li>`720` - 1280px x 720px @ 25fps</li> </ul>
	Resolution string `json:"resolution,omitempty"`

	// The aspect ratio (shape) of the video or image. Useful for social media output formats. Options are: <ul>   <li>`16:9` - regular landscape/horizontal aspect ratio (default)</li>   <li>`9:16` - vertical/portrait aspect ratio</li>   <li>`1:1` - square aspect ratio</li>   <li>`4:5` - short vertical/portrait aspect ratio</li>   <li>`4:3` - legacy TV aspect ratio</li> </ul>
	AspectRatio string `json:"aspectRatio,omitempty" default:"16:9"`

	Size *Size `json:"size,omitempty"`

	// Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on  mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps. <ul>   <li>`12` - 12fps</li>   <li>`15` - 15fps</li>   <li>`24` - 24fps</li>   <li>`23.976` - 23.976fps</li>   <li>`25` - 25fps</li>   <li>`29.97` - 29.97fps</li>   <li>`30` - 30fps</li> </ul>
	Fps *float32 `json:"fps,omitempty" default:"25"`

	// Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes. <ul>   <li>`preview` - 512px x 288px @ 15fps</li>   <li>`mobile` - 640px x 360px @ 25fps</li>   <li>`sd` - 1024px x 576px @25fps</li>   <li>`hd` - 1280px x 720px @25fps</li>   <li>`1080` - 1920px x 1080px @25fps</li> </ul>
	ScaleTo string `json:"scaleTo,omitempty"`

	// Adjust the output quality of the video, image or audio. Adjusting quality affects  render speed, download speeds and storage requirements due to file size. The default `medium` provides the most optimized choice for all three  factors. <ul>   <li>`low` - slightly reduced quality, smaller file size</li>   <li>`medium` - optimized quality, render speeds and file size</li>   <li>`high` - slightly increased quality, larger file size</li> </ul>
	Quality string `json:"quality,omitempty" default:"medium"`

	// Loop settings for gif files. Set to `true` to loop, `false` to play only once.
	Repeat bool `json:"repeat,omitempty"`

	Range *Range `json:"range,omitempty"`

	Poster *Poster `json:"poster,omitempty"`

	Thumbnail *Thumbnail `json:"thumbnail,omitempty"`

	Destinations []interface{} `json:"destinations,omitempty"`
}

type ParsingError struct {
	Err error
}

type Poster struct {

	// The point on the timeline in seconds to capture a single frame to use as the poster image.
	Capture float32 `json:"capture"`
}

type ProbeResponse struct {

	// `true` if media successfully read, else `false`.
	Success bool `json:"success"`

	// `Created`, `Bad Request` or an error message.
	Message string `json:"message"`

	// The response from FFprobe in JSON format.
	Response map[string]interface{} `json:"response"`
}

type ProcessingQueue struct {
	LocalResources map[string]*LocalResource
	// contains filtered or unexported fields
}

type ProcessingQueuer interface {
	StartProcessQueue(EditAPIServicer)
}

type QueuedResponse struct {

	// `true` if successfully queued, else `false`.
	Success bool `json:"success"`

	// `Created`, `Bad Request` or an error message.
	Message string `json:"message"`

	Response QueuedResponseData `json:"response"`
}

type QueuedResponseData struct {

	// Success response message or error details.
	Message string `json:"message"`

	// The id of the render task in UUID format.
	ID string `json:"id"`
}

type Range struct {

	// The point on the timeline, in seconds, to start the render from - i.e. start at second 3.
	Start *float32 `json:"start,omitempty"`

	// The length of the portion of the video or audio to render - i.e. render 6 seconds of the video.
	Length *float32 `json:"length,omitempty"`
}

type RenderQueue struct {
	// The id of the render task in UUID format.
	ID string `json:"id"`

	Created time.Time `json:"created"`
	Updated time.Time `json:"updated"`

	Data     Edit `json:"data"`
	Status   RenderResponseStatus
	FileName string

	InternalStatus RenderResponseStatus
	FFMPEGCommand  FFMPEGCommand
}

type RenderResponse struct {

	// `true` if status available, else `false`.
	Success bool `json:"success"`

	// `OK` or an error message.
	Message string `json:"message"`

	Response RenderResponseData `json:"response"`
}

type RenderResponseData struct {

	// The id of the render task in UUID format.
	ID string `json:"id"`

	// The owner id of the render task.
	Owner string `json:"owner"`

	// The customer subscription plan.
	Plan string `json:"plan,omitempty"`

	// The status of the render task. <ul>   <li>`queued` - render is queued waiting to be rendered</li>   <li>`fetching` - assets are being fetched</li>   <li>`rendering` - the asset is being rendered</li>   <li>`saving` - the final asset is being saved to storage</li>   <li>`done` - the asset is ready to be downloaded</li>   <li>`failed` - there was an error rendering the asset</li> </ul>
	Status string `json:"status"`

	// An error message, only displayed if an error occurred.
	Error string `json:"error,omitempty"`

	// The output video or audio length in seconds.
	Duration float32 `json:"duration,omitempty"`

	// The time taken to render the asset in milliseconds.
	RenderTime float32 `json:"renderTime,omitempty"`

	// The URL of the final asset. This will only be available if status is done. This is a temporary URL and will be deleted after 24 hours. By default all assets are copied to the Shotstack hosting and CDN destination.
	URL string `json:"url,omitempty"`

	// The URL of the poster image if requested. This will only be available if status is done.
	Poster string `json:"poster,omitempty"`

	// The URL of the thumbnail image if requested. This will only be available if status is done.
	Thumbnail string `json:"thumbnail,omitempty"`

	Data Edit `json:"data"`

	// The time the render task was initially queued.
	Created string `json:"created"`

	// The time the render status was last updated.
	Updated string `json:"updated"`
}

type RenderResponseStatus int64

type RequiredError struct {
	Schema string
	Field  string
}

type RotateTransformation struct {

	// The angle to rotate the clip. Can be 0 to 360, or 0 to -360. Using a positive number rotates the clip clockwise, negative numbers counter-clockwise.
	Angle int32 `json:"angle,omitempty"`
}

type Route struct {
	Name        string
	Method      string
	Pattern     string
	HandlerFunc http.HandlerFunc
}

type Router interface {
	Routes() Routes
}

type Routes []Route

type ServeAPIController struct {
	// contains filtered or unexported fields
}

type ServeAPIOption func(*ServeAPIController)

type ServeAPIRouter interface {
	DeleteAsset(http.ResponseWriter, *http.Request)
	GetAsset(http.ResponseWriter, *http.Request)
	GetAssetByRenderID(http.ResponseWriter, *http.Request)
}

type ServeAPIService struct {
	// contains filtered or unexported fields
}

type ServeAPIServicer interface {
	DeleteAsset(context.Context, string) (ImplResponse, error)
	GetAsset(context.Context, string) (ImplResponse, error)
	GetAssetByRenderID(context.Context, string) (ImplResponse, error)
}

type ShotstackDestination struct {

	// The destination to send rendered assets to - set to `shotstack` for Shotstack hosting and CDN.
	Provider string `json:"provider"`

	// Set to `true` to opt-out from the Shotstack hosting and CDN service. All files must be downloaded within 24 hours of rendering.
	Exclude bool `json:"exclude,omitempty"`
}

type Size struct {

	// Set a custom width for the video or image file. Value must be divisible by 2. Maximum video width is 1920px, maximum image width is 4096px.
	Width *int32 `json:"width,omitempty"`

	// Set a custom height for the video or image file. Value must be divisible by 2. Maximum video height is 1920px, maximum image height is 4096px.
	Height *int32 `json:"height,omitempty"`
}

type SkewTransformation struct {

	// Skew the clip along it's x axis.
	X float32 `json:"x,omitempty"`

	// Skew the clip along it's y axis.
	Y float32 `json:"y,omitempty"`
}

type Soundtrack struct {

	// The URL of the mp3 audio file. The URL must be publicly accessible or include credentials.
	Src string `json:"src"`

	// The effect to apply to the audio file <ul>   <li>`fadeIn` - fade volume in only</li>   <li>`fadeOut` - fade volume out only</li>   <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
	Effect string `json:"effect,omitempty"`

	// Set the volume for the soundtrack between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
	Volume float32 `json:"volume,omitempty" default:"1"`
}

type Subtitle struct {

	// Index of the subtitle stream (Default to 0).
	Index int `json:"index" default:"0"`
}

type Template struct {

	// The template name
	Name string `json:"name"`

	Template Edit `json:"template,omitempty"`
}

type TemplateDataResponse struct {

	// `true` if successfully created, else `false`.
	Success bool `json:"success"`

	// `OK`, `Bad Request` or an error message.
	Message string `json:"message"`

	Response TemplateDataResponseData `json:"response"`
}

type TemplateDataResponseData struct {

	// The unique id of the template in UUID format.
	ID string `json:"id"`

	// The template name.
	Name string `json:"name"`

	// The owner id of the templates.
	Owner string `json:"owner"`

	// The [Edit](#tocs_edit) template.
	Template string `json:"template"`
}

type TemplateListResponse struct {

	// `true` if successfully created, else `false`.
	Success bool `json:"success"`

	// `Created`, `Bad Request` or an error message.
	Message string `json:"message"`

	Response TemplateListResponseData `json:"response"`
}

type TemplateListResponseData struct {

	// The owner id of the templates.
	Owner string `json:"owner"`

	// The list of templates.
	Templates []TemplateListResponseItem `json:"templates"`
}

type TemplateListResponseItem struct {

	// The unique id of the template in UUID format.
	ID string `json:"id"`

	// The template name
	Name string `json:"name"`

	// The time the template was created.
	Created string `json:"created"`

	// The time the template was last updated.
	Updated string `json:"updated"`
}

type TemplateRender struct {

	// The id of the template to render in UUID format.
	ID string `json:"id"`

	// An array of key/value pairs that provides an easy way to create templates with placeholders. The placeholders can be used to find and replace keys with values. For example you can search for the placeholder `{{NAME}}` and replace it with the value `Jane`.
	Merge []MergeField `json:"merge,omitempty"`
}

type TemplateResponse struct {

	// `true` if successfully created, else `false`.
	Success bool `json:"success"`

	// `Created`, `Bad Request` or an error message.
	Message string `json:"message"`

	Response TemplateResponseData `json:"response"`
}

type TemplateResponseData struct {

	// Success response message or error details.
	Message string `json:"message"`

	// The unique id of the template in UUID format.
	ID string `json:"id"`
}

type Thumbnail struct {

	// The point on the timeline in seconds to capture a single frame to use as the thumbnail image.
	Capture float32 `json:"capture"`

	// Scale the thumbnail size to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale  the thumbnail to half the size of the viewport.
	Scale float32 `json:"scale"`
}

type Timeline struct {
	Soundtrack *Soundtrack `json:"soundtrack,omitempty"`

	// A hexadecimal value for the timeline background color. Defaults to #000000 (black).
	Background string `json:"background,omitempty" default:"#000000"`

	// An array of custom fonts to be downloaded for use by the HTML assets.
	Fonts []Font `json:"fonts,omitempty"`

	// A timeline consists of an array of tracks, each track containing clips. Tracks are layered on top of each other in the same order they are added to the array with the top most track layered over the top of those below it. Ensure that a track containing titles is the top most track so that it is displayed above videos and images.
	Tracks []Track `json:"tracks"`

	// Disable the caching of ingested source footage and assets. See  [caching](https://shotstack.io/docs/guide/architecting-an-application/caching) for more details.
	Cache bool `json:"cache,omitempty" default:"true"`
}

type TitleAsset struct {

	// The type of asset - set to `title` for titles.
	Type string `json:"type"`

	// The title text string - i.e. \"My Title\".
	Text string `json:"text"`

	// Uses a preset to apply font properties and styling to the title. <ul>   <li>`minimal`</li>   <li>`blockbuster`</li>   <li>`vogue`</li>   <li>`sketchy`</li>   <li>`skinny`</li>   <li>`chunk`</li>   <li>`chunkLight`</li>   <li>`marker`</li>   <li>`future`</li>   <li>`subtitle`</li> </ul>
	Style string `json:"style,omitempty"`

	// Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML),  i.e. #80ffffff will be white with  50% transparency.
	Color string `json:"color,omitempty"`

	// Set the relative size of the text using predefined sizes from xx-small to xx-large. <ul>   <li>`xx-small`</li>   <li>`x-small`</li>   <li>`small`</li>   <li>`medium`</li>   <li>`large`</li>   <li>`x-large`</li>   <li>`xx-large`</li> </ul>
	Size string `json:"size,omitempty"`

	// Apply a background color behind the text. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML),  i.e. #80ffffff will be white with 50% transparency. Omit to use transparent background.
	Background string `json:"background,omitempty"`

	// Place the title in one of nine predefined positions of the viewport. <ul>   <li>`top` - top (center)</li>   <li>`topRight` - top right</li>   <li>`right` - right (center)</li>   <li>`bottomRight` - bottom right</li>   <li>`bottom` - bottom (center)</li>   <li>`bottomLeft` - bottom left</li>   <li>`left` - left (center)</li>   <li>`topLeft` - top left</li>   <li>`center` - center</li> </ul>
	Position string `json:"position,omitempty"`

	Offset *Offset `json:"offset,omitempty"`
}

type Track struct {

	// An array of Clips comprising of TitleClip, ImageClip or VideoClip.
	Clips []Clip `json:"clips"`
}

type Transformation struct {
	Rotate RotateTransformation `json:"rotate,omitempty"`

	Skew SkewTransformation `json:"skew,omitempty"`

	Flip FlipTransformation `json:"flip,omitempty"`
}

type Transition struct {

	// The transition in. Available transitions are:   <ul>     <li>`fade` - fade in</li>     <li>`reveal` - reveal from left to right</li>     <li>`wipeLeft` - fade across screen to the left</li>     <li>`wipeRight` - fade across screen to the right</li>     <li>`slideLeft` - move slightly left and fade in</li>     <li>`slideRight` - move slightly right and fade in</li>     <li>`slideUp` - move slightly up and fade in</li>     <li>`slideDown` - move slightly down and fade in</li>     <li>`carouselLeft` - slide in from right to left</li>     <li>`carouselRight` - slide in from left to right</li>     <li>`carouselUp` - slide in from bottom to top</li>     <li>`carouselDown` - slide in from top to bottom</li>     <li>`shuffleTopRight` - rotate in from top right</li>     <li>`shuffleRightTop` - rotate in from right top</li>     <li>`shuffleRightBottom` - rotate in from right bottom</li>     <li>`shuffleBottomRight` - rotate in from bottom right</li>     <li>`shuffleBottomLeft` - rotate in from bottom left</li>     <li>`shuffleLeftBottom` - rotate in from left bottom</li>     <li>`shuffleLeftTop` - rotate in from left top</li>     <li>`shuffleTopLeft` - rotate in from top left</li>     <li>`zoom` - fast zoom in</li>   </ul> The transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.
	In string `json:"in,omitempty"`

	// The transition out. Available transitions are:   <ul>     <li>`fade` - fade out</li>     <li>`reveal` - reveal from right to left</li>     <li>`wipeLeft` - fade across screen to the left</li>     <li>`wipeRight` - fade across screen to the right</li>     <li>`slideLeft` - move slightly left and fade out</li>     <li>`slideRight` - move slightly right and fade out</li>     <li>`slideUp` - move slightly up and fade out</li>     <li>`slideDown` - move slightly down and fade out</li>     <li>`carouselLeft` - slide out from right to left</li>     <li>`carouselRight` - slide out from left to right</li>     <li>`carouselUp` - slide out from bottom to top</li>     <li>`carouselDown` - slide out from top  to bottom</li>     <li>`shuffleTopRight` - rotate out from top right</li>     <li>`shuffleRightTop` - rotate out from right top</li>     <li>`shuffleRightBottom` - rotate out from right bottom</li>     <li>`shuffleBottomRight` - rotate out from bottom right</li>     <li>`shuffleBottomLeft` - rotate out from bottom left</li>     <li>`shuffleLeftBottom` - rotate out from left bottom</li>     <li>`shuffleLeftTop` - rotate out from left top</li>     <li>`shuffleTopLeft` - rotate out from top left</li>     <li>`zoom` - fast zoom out</li>   </ul> The transition speed can also be controlled by appending `Fast` or `Slow` to the transition, e.g. `fadeFast` or `CarouselLeftSlow`.
	Out string `json:"out,omitempty"`
}

type VideoAsset struct {

	// The type of asset - set to `video` for videos.
	Type string `json:"type"`

	// The video source URL. The URL must be publicly accessible or include credentials.
	Src string `json:"src"`

	// The start trim point of the video clip, in seconds (defaults to 0). Videos will start from the in trim point. The video will play until the file ends or the Clip length is reached.
	Trim float32 `json:"trim,omitempty" default:"0"`

	// Set the volume for the video clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 0).
	Volume float32 `json:"volume,omitempty" default:"0"`

	Crop *Crop `json:"crop,omitempty"`

	Subtitle *Subtitle `json:"subtitle,omitempty"`
}