From e02461b5b6ea52e98e7ea086b7f845c24834ca3a Mon Sep 17 00:00:00 2001 From: The Jay Date: Wed, 29 Jun 2022 14:37:29 +1000 Subject: [PATCH] Add Templates to SDK - Add Template models - Update model set functions to return object references --- src/ApiClient.js | 2 +- src/api/EditApi.js | 319 +++++++++++++++++++++++++- src/api/ServeApi.js | 14 +- src/index.js | 55 ++++- src/model/Asset.js | 19 +- src/model/AssetRenderResponse.js | 6 +- src/model/AssetResponse.js | 6 +- src/model/AssetResponseAttributes.js | 42 +++- src/model/AssetResponseData.js | 8 +- src/model/AudioAsset.js | 2 +- src/model/Clip.js | 2 +- src/model/Crop.js | 2 +- src/model/Destinations.js | 5 +- src/model/Edit.js | 2 +- src/model/FlipTransformation.js | 2 +- src/model/Font.js | 2 +- src/model/HtmlAsset.js | 2 +- src/model/ImageAsset.js | 2 +- src/model/LumaAsset.js | 2 +- src/model/MergeField.js | 2 +- src/model/MuxDestination.js | 2 +- src/model/MuxDestinationOptions.js | 2 +- src/model/Offset.js | 2 +- src/model/Output.js | 2 +- src/model/Poster.js | 2 +- src/model/ProbeResponse.js | 10 +- src/model/QueuedResponse.js | 4 +- src/model/QueuedResponseData.js | 2 +- src/model/Range.js | 2 +- src/model/RenderResponse.js | 2 +- src/model/RenderResponseData.js | 2 +- src/model/RotateTransformation.js | 2 +- src/model/ShotstackDestination.js | 2 +- src/model/Size.js | 2 +- src/model/SkewTransformation.js | 2 +- src/model/Soundtrack.js | 2 +- src/model/Template.js | 123 ++++++++++ src/model/TemplateDataResponse.js | 153 ++++++++++++ src/model/TemplateDataResponseData.js | 184 +++++++++++++++ src/model/TemplateListResponse.js | 153 ++++++++++++ src/model/TemplateListResponseData.js | 128 +++++++++++ src/model/TemplateListResponseItem.js | 184 +++++++++++++++ src/model/TemplateRender.js | 126 ++++++++++ src/model/TemplateResponse.js | 153 ++++++++++++ src/model/TemplateResponseData.js | 128 +++++++++++ src/model/Thumbnail.js | 2 +- src/model/Timeline.js | 2 +- src/model/TitleAsset.js | 2 +- src/model/Track.js | 2 +- src/model/Transformation.js | 2 +- src/model/Transition.js | 2 +- src/model/VideoAsset.js | 2 +- 52 files changed, 1812 insertions(+), 72 deletions(-) create mode 100644 src/model/Template.js create mode 100644 src/model/TemplateDataResponse.js create mode 100644 src/model/TemplateDataResponseData.js create mode 100644 src/model/TemplateListResponse.js create mode 100644 src/model/TemplateListResponseData.js create mode 100644 src/model/TemplateListResponseItem.js create mode 100644 src/model/TemplateRender.js create mode 100644 src/model/TemplateResponse.js create mode 100644 src/model/TemplateResponseData.js diff --git a/src/ApiClient.js b/src/ApiClient.js index 5690aaf..aebe242 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/api/EditApi.js b/src/api/EditApi.js index 8e0b312..0d6ffc9 100644 --- a/src/api/EditApi.js +++ b/src/api/EditApi.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -16,18 +16,18 @@ (function(root, factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Edit', 'model/ProbeResponse', 'model/QueuedResponse', 'model/RenderResponse'], factory); + define(['ApiClient', 'model/Edit', 'model/ProbeResponse', 'model/QueuedResponse', 'model/RenderResponse', 'model/Template', 'model/TemplateDataResponse', 'model/TemplateListResponse', 'model/TemplateRender', 'model/TemplateResponse'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('../ApiClient'), require('../model/Edit'), require('../model/ProbeResponse'), require('../model/QueuedResponse'), require('../model/RenderResponse')); + module.exports = factory(require('../ApiClient'), require('../model/Edit'), require('../model/ProbeResponse'), require('../model/QueuedResponse'), require('../model/RenderResponse'), require('../model/Template'), require('../model/TemplateDataResponse'), require('../model/TemplateListResponse'), require('../model/TemplateRender'), require('../model/TemplateResponse')); } else { // Browser globals (root is window) if (!root.ShotstackSdk) { root.ShotstackSdk = {}; } - root.ShotstackSdk.EditApi = factory(root.ShotstackSdk.ApiClient, root.ShotstackSdk.Edit, root.ShotstackSdk.ProbeResponse, root.ShotstackSdk.QueuedResponse, root.ShotstackSdk.RenderResponse); + root.ShotstackSdk.EditApi = factory(root.ShotstackSdk.ApiClient, root.ShotstackSdk.Edit, root.ShotstackSdk.ProbeResponse, root.ShotstackSdk.QueuedResponse, root.ShotstackSdk.RenderResponse, root.ShotstackSdk.Template, root.ShotstackSdk.TemplateDataResponse, root.ShotstackSdk.TemplateListResponse, root.ShotstackSdk.TemplateRender, root.ShotstackSdk.TemplateResponse); } -}(this, function(ApiClient, Edit, ProbeResponse, QueuedResponse, RenderResponse) { +}(this, function(ApiClient, Edit, ProbeResponse, QueuedResponse, RenderResponse, Template, TemplateDataResponse, TemplateListResponse, TemplateRender, TemplateResponse) { 'use strict'; /** @@ -48,9 +48,59 @@ + /** + * Delete Template + * Delete a template by its template id. **Base URL:** https://api.shotstack.io/{version} + * @param {String} id The id of the template in UUID format + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response + */ + this.deleteTemplateWithHttpInfo = function(id) { + var postBody = null; + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling deleteTemplate"); + } + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var collectionQueryParams = { + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = ['DeveloperKey']; + var contentTypes = []; + var accepts = []; + var returnType = null; + return this.apiClient.callApi( + '/templates/{id}', 'DELETE', + pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * Delete Template + * Delete a template by its template id. **Base URL:** https://api.shotstack.io/{version} + * @param {String} id The id of the template in UUID format + * @return {Promise} a {@link https://www.promisejs.org/|Promise} + */ + this.deleteTemplate = function(id) { + return this.deleteTemplateWithHttpInfo(id) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * Get Render Status - * Get the rendering status, temporary asset url and details of a render by ID. **Base URL:** https://api.shotstack.io/{version} + * Get the rendering status, temporary asset url and details of a render by ID. **Base URL:** https://api.shotstack.io/{version} * @param {String} id The id of the timeline render task in UUID format * @param {Object} opts Optional parameters * @param {Boolean} opts.data Include the data parameter in the response. The data parameter includes the original timeline, output and other settings sent to the API.

Note: the default is currently `true`, this is deprecated and the default will soon be `false`. If you rely on the data being returned in the response you should explicitly set the parameter to `true`. @@ -92,7 +142,7 @@ /** * Get Render Status - * Get the rendering status, temporary asset url and details of a render by ID. **Base URL:** https://api.shotstack.io/{version} + * Get the rendering status, temporary asset url and details of a render by ID. **Base URL:** https://api.shotstack.io/{version} * @param {String} id The id of the timeline render task in UUID format * @param {Object} opts Optional parameters * @param {Boolean} opts.data Include the data parameter in the response. The data parameter includes the original timeline, output and other settings sent to the API.

Note: the default is currently `true`, this is deprecated and the default will soon be `false`. If you rely on the data being returned in the response you should explicitly set the parameter to `true`. @@ -107,9 +157,102 @@ } + /** + * Retrieve Template + * Retrieve a template by template id. **Base URL:** https://api.shotstack.io/{version} + * @param {String} id The id of the template in UUID format + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TemplateDataResponse} and HTTP response + */ + this.getTemplateWithHttpInfo = function(id) { + var postBody = null; + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling getTemplate"); + } + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var collectionQueryParams = { + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = ['DeveloperKey']; + var contentTypes = []; + var accepts = ['application/json']; + var returnType = TemplateDataResponse; + return this.apiClient.callApi( + '/templates/{id}', 'GET', + pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * Retrieve Template + * Retrieve a template by template id. **Base URL:** https://api.shotstack.io/{version} + * @param {String} id The id of the template in UUID format + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TemplateDataResponse} + */ + this.getTemplate = function(id) { + return this.getTemplateWithHttpInfo(id) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * List Templates + * Retrieve a list of templates stored against a users account. The API key is used to determine which templates are associated to the user. **Base URL:** https://api.shotstack.io/{version} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TemplateListResponse} and HTTP response + */ + this.getTemplatesWithHttpInfo = function() { + var postBody = null; + + var pathParams = { + }; + var queryParams = { + }; + var collectionQueryParams = { + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = ['DeveloperKey']; + var contentTypes = []; + var accepts = ['application/json']; + var returnType = TemplateListResponse; + return this.apiClient.callApi( + '/templates', 'GET', + pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * List Templates + * Retrieve a list of templates stored against a users account. The API key is used to determine which templates are associated to the user. **Base URL:** https://api.shotstack.io/{version} + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TemplateListResponse} + */ + this.getTemplates = function() { + return this.getTemplatesWithHttpInfo() + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * Render Asset - * Queue and render the contents of a timeline as a video, image or audio file. **Base URL:** https://api.shotstack.io/{version} + * Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file. **Base URL:** https://api.shotstack.io/{version} * @param {module:model/Edit} edit The video, image or audio edit specified using JSON. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueuedResponse} and HTTP response */ @@ -144,7 +287,7 @@ /** * Render Asset - * Queue and render the contents of a timeline as a video, image or audio file. **Base URL:** https://api.shotstack.io/{version} + * Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file. **Base URL:** https://api.shotstack.io/{version} * @param {module:model/Edit} edit The video, image or audio edit specified using JSON. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/QueuedResponse} */ @@ -156,9 +299,107 @@ } + /** + * Create Template + * Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request. **Base URL:** https://api.shotstack.io/{version} + * @param {module:model/Template} template Create a template with a name and [Edit](#tocs_edit). + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TemplateResponse} and HTTP response + */ + this.postTemplateWithHttpInfo = function(template) { + var postBody = template; + // verify the required parameter 'template' is set + if (template === undefined || template === null) { + throw new Error("Missing the required parameter 'template' when calling postTemplate"); + } + + var pathParams = { + }; + var queryParams = { + }; + var collectionQueryParams = { + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = ['DeveloperKey']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = TemplateResponse; + return this.apiClient.callApi( + '/templates', 'POST', + pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * Create Template + * Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request. **Base URL:** https://api.shotstack.io/{version} + * @param {module:model/Template} template Create a template with a name and [Edit](#tocs_edit). + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TemplateResponse} + */ + this.postTemplate = function(template) { + return this.postTemplateWithHttpInfo(template) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * Render Template + * Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit). **Base URL:** https://api.shotstack.io/{version} + * @param {module:model/TemplateRender} templateRender Render a template by template id. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QueuedResponse} and HTTP response + */ + this.postTemplateRenderWithHttpInfo = function(templateRender) { + var postBody = templateRender; + // verify the required parameter 'templateRender' is set + if (templateRender === undefined || templateRender === null) { + throw new Error("Missing the required parameter 'templateRender' when calling postTemplateRender"); + } + + var pathParams = { + }; + var queryParams = { + }; + var collectionQueryParams = { + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = ['DeveloperKey']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = QueuedResponse; + return this.apiClient.callApi( + '/templates/render', 'POST', + pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * Render Template + * Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit). **Base URL:** https://api.shotstack.io/{version} + * @param {module:model/TemplateRender} templateRender Render a template by template id. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/QueuedResponse} + */ + this.postTemplateRender = function(templateRender) { + return this.postTemplateRenderWithHttpInfo(templateRender) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * Inspect Media - * Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc... **Base URL:** https://api.shotstack.io/{version} + * Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc... **Base URL:** https://api.shotstack.io/{version} * @param {String} url The URL of the media to inspect, must be **URL encoded**. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ProbeResponse} and HTTP response */ @@ -194,7 +435,7 @@ /** * Inspect Media - * Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc... **Base URL:** https://api.shotstack.io/{version} + * Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc... **Base URL:** https://api.shotstack.io/{version} * @param {String} url The URL of the media to inspect, must be **URL encoded**. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ProbeResponse} */ @@ -204,6 +445,62 @@ return response_and_data.data; }); } + + + /** + * Update Template + * Update an existing template by template id. **Base URL:** https://api.shotstack.io/{version} + * @param {String} id The id of the template in UUID format + * @param {module:model/Template} template Update an individual templates name and [Edit](#tocs_edit). Both template name and template must be provided. If the template parameter is omitted a blank template will be saved. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TemplateResponse} and HTTP response + */ + this.putTemplateWithHttpInfo = function(id, template) { + var postBody = template; + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling putTemplate"); + } + // verify the required parameter 'template' is set + if (template === undefined || template === null) { + throw new Error("Missing the required parameter 'template' when calling putTemplate"); + } + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var collectionQueryParams = { + }; + var headerParams = { + }; + var formParams = { + }; + + var authNames = ['DeveloperKey']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = TemplateResponse; + return this.apiClient.callApi( + '/templates/{id}', 'PUT', + pathParams, queryParams, collectionQueryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null + ); + } + + /** + * Update Template + * Update an existing template by template id. **Base URL:** https://api.shotstack.io/{version} + * @param {String} id The id of the template in UUID format + * @param {module:model/Template} template Update an individual templates name and [Edit](#tocs_edit). Both template name and template must be provided. If the template parameter is omitted a blank template will be saved. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TemplateResponse} + */ + this.putTemplate = function(id, template) { + return this.putTemplateWithHttpInfo(id, template) + .then(function(response_and_data) { + return response_and_data.data; + }); + } }; return exports; diff --git a/src/api/ServeApi.js b/src/api/ServeApi.js index 31f1d31..70ef296 100644 --- a/src/api/ServeApi.js +++ b/src/api/ServeApi.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -50,7 +50,7 @@ /** * Delete Asset - * Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id. **Base URL:** https://api.shotstack.io/serve/{version} + * Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id. **Base URL:** https://api.shotstack.io/serve/{version} * @param {String} id The id of the asset in UUID format * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ @@ -86,7 +86,7 @@ /** * Delete Asset - * Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id. **Base URL:** https://api.shotstack.io/serve/{version} + * Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id. **Base URL:** https://api.shotstack.io/serve/{version} * @param {String} id The id of the asset in UUID format * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ @@ -100,7 +100,7 @@ /** * Get Asset - * The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id. **Base URL:** https://api.shotstack.io/serve/{version} + * The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id. **Base URL:** https://api.shotstack.io/serve/{version} * @param {String} id The id of the asset in UUID format * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AssetResponse} and HTTP response */ @@ -136,7 +136,7 @@ /** * Get Asset - * The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id. **Base URL:** https://api.shotstack.io/serve/{version} + * The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id. **Base URL:** https://api.shotstack.io/serve/{version} * @param {String} id The id of the asset in UUID format * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AssetResponse} */ @@ -150,7 +150,7 @@ /** * Get Asset by Render ID - * A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status request or webhook. This endpoint lets you look up one or more assets by the render id. **Base URL:** https://api.shotstack.io/serve/{version} + * A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status request or webhook. This endpoint lets you look up one or more assets by the render id. **Base URL:** https://api.shotstack.io/serve/{version} * @param {String} id The render id associated with the asset in UUID format * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AssetRenderResponse} and HTTP response */ @@ -186,7 +186,7 @@ /** * Get Asset by Render ID - * A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status request or webhook. This endpoint lets you look up one or more assets by the render id. **Base URL:** https://api.shotstack.io/serve/{version} + * A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status request or webhook. This endpoint lets you look up one or more assets by the render id. **Base URL:** https://api.shotstack.io/serve/{version} * @param {String} id The render id associated with the asset in UUID format * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AssetRenderResponse} */ diff --git a/src/index.js b/src/index.js index 855e14d..f109a6f 100644 --- a/src/index.js +++ b/src/index.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -16,16 +16,16 @@ (function(factory) { if (typeof define === 'function' && define.amd) { // AMD. Register as an anonymous module. - define(['ApiClient', 'model/Asset', 'model/AssetRenderResponse', 'model/AssetResponse', 'model/AssetResponseAttributes', 'model/AssetResponseData', 'model/AudioAsset', 'model/Clip', 'model/Crop', 'model/Destinations', 'model/Edit', 'model/FlipTransformation', 'model/Font', 'model/HtmlAsset', 'model/ImageAsset', 'model/LumaAsset', 'model/MergeField', 'model/MuxDestination', 'model/MuxDestinationOptions', 'model/Offset', 'model/Output', 'model/Poster', 'model/ProbeResponse', 'model/QueuedResponse', 'model/QueuedResponseData', 'model/Range', 'model/RenderResponse', 'model/RenderResponseData', 'model/RotateTransformation', 'model/ShotstackDestination', 'model/Size', 'model/SkewTransformation', 'model/Soundtrack', 'model/Thumbnail', 'model/Timeline', 'model/TitleAsset', 'model/Track', 'model/Transformation', 'model/Transition', 'model/VideoAsset', 'api/EditApi', 'api/ServeApi'], factory); + define(['ApiClient', 'model/Asset', 'model/AssetRenderResponse', 'model/AssetResponse', 'model/AssetResponseAttributes', 'model/AssetResponseData', 'model/AudioAsset', 'model/Clip', 'model/Crop', 'model/Destinations', 'model/Edit', 'model/FlipTransformation', 'model/Font', 'model/HtmlAsset', 'model/ImageAsset', 'model/LumaAsset', 'model/MergeField', 'model/MuxDestination', 'model/MuxDestinationOptions', 'model/Offset', 'model/Output', 'model/Poster', 'model/ProbeResponse', 'model/QueuedResponse', 'model/QueuedResponseData', 'model/Range', 'model/RenderResponse', 'model/RenderResponseData', 'model/RotateTransformation', 'model/ShotstackDestination', 'model/Size', 'model/SkewTransformation', 'model/Soundtrack', 'model/Template', 'model/TemplateDataResponse', 'model/TemplateDataResponseData', 'model/TemplateListResponse', 'model/TemplateListResponseData', 'model/TemplateListResponseItem', 'model/TemplateRender', 'model/TemplateResponse', 'model/TemplateResponseData', 'model/Thumbnail', 'model/Timeline', 'model/TitleAsset', 'model/Track', 'model/Transformation', 'model/Transition', 'model/VideoAsset', 'api/EditApi', 'api/ServeApi'], factory); } else if (typeof module === 'object' && module.exports) { // CommonJS-like environments that support module.exports, like Node. - module.exports = factory(require('./ApiClient'), require('./model/Asset'), require('./model/AssetRenderResponse'), require('./model/AssetResponse'), require('./model/AssetResponseAttributes'), require('./model/AssetResponseData'), require('./model/AudioAsset'), require('./model/Clip'), require('./model/Crop'), require('./model/Destinations'), require('./model/Edit'), require('./model/FlipTransformation'), require('./model/Font'), require('./model/HtmlAsset'), require('./model/ImageAsset'), require('./model/LumaAsset'), require('./model/MergeField'), require('./model/MuxDestination'), require('./model/MuxDestinationOptions'), require('./model/Offset'), require('./model/Output'), require('./model/Poster'), require('./model/ProbeResponse'), require('./model/QueuedResponse'), require('./model/QueuedResponseData'), require('./model/Range'), require('./model/RenderResponse'), require('./model/RenderResponseData'), require('./model/RotateTransformation'), require('./model/ShotstackDestination'), require('./model/Size'), require('./model/SkewTransformation'), require('./model/Soundtrack'), require('./model/Thumbnail'), require('./model/Timeline'), require('./model/TitleAsset'), require('./model/Track'), require('./model/Transformation'), require('./model/Transition'), require('./model/VideoAsset'), require('./api/EditApi'), require('./api/ServeApi')); + module.exports = factory(require('./ApiClient'), require('./model/Asset'), require('./model/AssetRenderResponse'), require('./model/AssetResponse'), require('./model/AssetResponseAttributes'), require('./model/AssetResponseData'), require('./model/AudioAsset'), require('./model/Clip'), require('./model/Crop'), require('./model/Destinations'), require('./model/Edit'), require('./model/FlipTransformation'), require('./model/Font'), require('./model/HtmlAsset'), require('./model/ImageAsset'), require('./model/LumaAsset'), require('./model/MergeField'), require('./model/MuxDestination'), require('./model/MuxDestinationOptions'), require('./model/Offset'), require('./model/Output'), require('./model/Poster'), require('./model/ProbeResponse'), require('./model/QueuedResponse'), require('./model/QueuedResponseData'), require('./model/Range'), require('./model/RenderResponse'), require('./model/RenderResponseData'), require('./model/RotateTransformation'), require('./model/ShotstackDestination'), require('./model/Size'), require('./model/SkewTransformation'), require('./model/Soundtrack'), require('./model/Template'), require('./model/TemplateDataResponse'), require('./model/TemplateDataResponseData'), require('./model/TemplateListResponse'), require('./model/TemplateListResponseData'), require('./model/TemplateListResponseItem'), require('./model/TemplateRender'), require('./model/TemplateResponse'), require('./model/TemplateResponseData'), require('./model/Thumbnail'), require('./model/Timeline'), require('./model/TitleAsset'), require('./model/Track'), require('./model/Transformation'), require('./model/Transition'), require('./model/VideoAsset'), require('./api/EditApi'), require('./api/ServeApi')); } -}(function(ApiClient, Asset, AssetRenderResponse, AssetResponse, AssetResponseAttributes, AssetResponseData, AudioAsset, Clip, Crop, Destinations, Edit, FlipTransformation, Font, HtmlAsset, ImageAsset, LumaAsset, MergeField, MuxDestination, MuxDestinationOptions, Offset, Output, Poster, ProbeResponse, QueuedResponse, QueuedResponseData, Range, RenderResponse, RenderResponseData, RotateTransformation, ShotstackDestination, Size, SkewTransformation, Soundtrack, Thumbnail, Timeline, TitleAsset, Track, Transformation, Transition, VideoAsset, EditApi, ServeApi) { +}(function(ApiClient, Asset, AssetRenderResponse, AssetResponse, AssetResponseAttributes, AssetResponseData, AudioAsset, Clip, Crop, Destinations, Edit, FlipTransformation, Font, HtmlAsset, ImageAsset, LumaAsset, MergeField, MuxDestination, MuxDestinationOptions, Offset, Output, Poster, ProbeResponse, QueuedResponse, QueuedResponseData, Range, RenderResponse, RenderResponseData, RotateTransformation, ShotstackDestination, Size, SkewTransformation, Soundtrack, Template, TemplateDataResponse, TemplateDataResponseData, TemplateListResponse, TemplateListResponseData, TemplateListResponseItem, TemplateRender, TemplateResponse, TemplateResponseData, Thumbnail, Timeline, TitleAsset, Track, Transformation, Transition, VideoAsset, EditApi, ServeApi) { 'use strict'; /** - * Shotstack_is_a_video_image_and_audio_editing_service_that_allows_for_the_automated_generation_of_videos_images_and_audio_using_JSON_and_a_RESTful_API_You_arrange_and_configure_an_edit_and_POST_it_to_the_API_which_will_render_your_media_and_provide_a_file__location_when_complete_For_more_details_visit__shotstack_io_https__shotstack_io_or_checkout_our__getting_started_https__shotstack_io_docs_guide__documentation_There_are_two_main_APIs_one_for_editing_and_generating_assets__Edit_API_and_one_for_managing_hosted_assets__Serve_API_The_Edit_API_base_URL_is_bhttps__api_shotstack_io_version_bThe_Serve_API_base_URL_is_bhttps__api_shotstack_io_serve_version_b.
+ * Shotstack_is_a_video_image_and_audio_editing_service_that_allows_for_the_automatedgeneration_of_videos_images_and_audio_using_JSON_and_a_RESTful_API_You_arrange_and_configure_an_edit_and_POST_it_to_the_API_which_will_render_your_media_and_provide_a_file_location_when_complete_For_more_details_visit__shotstack_io_https__shotstack_io_or_checkout_our_getting_started_https__shotstack_io_docs_guide__documentation_There_are_two_main_APIs_one_for_editing_and_generating_assets__Edit_API_and_one_for_managing_hosted_assets_Serve_API_The_Edit_API_base_URL_is_bhttps__api_shotstack_io_version_bThe_Serve_API_base_URL_is_bhttps__api_shotstack_io_serve_version_b.
* The index module provides access to constructors for all the classes which comprise the public API. *

* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: @@ -221,6 +221,51 @@ * @property {module:model/Soundtrack} */ Soundtrack: Soundtrack, + /** + * The Template model constructor. + * @property {module:model/Template} + */ + Template: Template, + /** + * The TemplateDataResponse model constructor. + * @property {module:model/TemplateDataResponse} + */ + TemplateDataResponse: TemplateDataResponse, + /** + * The TemplateDataResponseData model constructor. + * @property {module:model/TemplateDataResponseData} + */ + TemplateDataResponseData: TemplateDataResponseData, + /** + * The TemplateListResponse model constructor. + * @property {module:model/TemplateListResponse} + */ + TemplateListResponse: TemplateListResponse, + /** + * The TemplateListResponseData model constructor. + * @property {module:model/TemplateListResponseData} + */ + TemplateListResponseData: TemplateListResponseData, + /** + * The TemplateListResponseItem model constructor. + * @property {module:model/TemplateListResponseItem} + */ + TemplateListResponseItem: TemplateListResponseItem, + /** + * The TemplateRender model constructor. + * @property {module:model/TemplateRender} + */ + TemplateRender: TemplateRender, + /** + * The TemplateResponse model constructor. + * @property {module:model/TemplateResponse} + */ + TemplateResponse: TemplateResponse, + /** + * The TemplateResponseData model constructor. + * @property {module:model/TemplateResponseData} + */ + TemplateResponseData: TemplateResponseData, /** * The Thumbnail model constructor. * @property {module:model/Thumbnail} diff --git a/src/model/Asset.js b/src/model/Asset.js index 8f64350..6eab4a8 100644 --- a/src/model/Asset.js +++ b/src/model/Asset.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -446,6 +446,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setType = function(type) { this['type'] = type; + return this; } @@ -463,6 +464,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setSrc = function(src) { this['src'] = src; + return this; } @@ -480,6 +482,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setTrim = function(trim) { this['trim'] = trim; + return this; } @@ -497,6 +500,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setVolume = function(volume) { this['volume'] = volume; + return this; } @@ -512,6 +516,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setCrop = function(crop) { this['crop'] = crop; + return this; } @@ -529,6 +534,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setText = function(text) { this['text'] = text; + return this; } @@ -546,6 +552,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setStyle = function(style) { this['style'] = style; + return this; } @@ -563,6 +570,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setColor = function(color) { this['color'] = color; + return this; } @@ -580,6 +588,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setSize = function(size) { this['size'] = size; + return this; } @@ -597,6 +606,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setBackground = function(background) { this['background'] = background; + return this; } @@ -614,6 +624,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setPosition = function(position) { this['position'] = position; + return this; } @@ -629,6 +640,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setOffset = function(offset) { this['offset'] = offset; + return this; } @@ -646,6 +658,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setHtml = function(html) { this['html'] = html; + return this; } @@ -663,6 +676,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setCss = function(css) { this['css'] = css; + return this; } @@ -680,6 +694,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setWidth = function(width) { this['width'] = width; + return this; } @@ -697,6 +712,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setHeight = function(height) { this['height'] = height; + return this; } @@ -714,6 +730,7 @@ exports.prototype['trim'] = undefined; */ exports.prototype.setEffect = function(effect) { this['effect'] = effect; + return this; } diff --git a/src/model/AssetRenderResponse.js b/src/model/AssetRenderResponse.js index 039a712..f635a43 100644 --- a/src/model/AssetRenderResponse.js +++ b/src/model/AssetRenderResponse.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -43,10 +43,12 @@ * The response returned by the Serve API [get asset by render id](#get-asset-by-render-id) request. The response is an array of asset resources, including video, image, audio, thumbnail and poster image. The response follows the [json:api](https://jsonapi.org/) specification. * @alias module:model/AssetRenderResponse * @class + * @param data {Array.} An array of asset resources grouped by render id. */ - var exports = function() { + var exports = function(data) { var _this = this; + _this['data'] = data; }; /** diff --git a/src/model/AssetResponse.js b/src/model/AssetResponse.js index c1eb6e3..6eb3f49 100644 --- a/src/model/AssetResponse.js +++ b/src/model/AssetResponse.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -43,10 +43,12 @@ * The response returned by the Serve API [get asset](#get-asset) request. Includes details of a hosted video, image, audio file, thumbnail or poster image. The response follows the [json:api](https://jsonapi.org/) specification. * @alias module:model/AssetResponse * @class + * @param data {module:model/AssetResponseData} */ - var exports = function() { + var exports = function(data) { var _this = this; + _this['data'] = data; }; /** diff --git a/src/model/AssetResponseAttributes.js b/src/model/AssetResponseAttributes.js index 6a68554..46a9aac 100644 --- a/src/model/AssetResponseAttributes.js +++ b/src/model/AssetResponseAttributes.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -43,10 +43,22 @@ * The list of asset attributes and their values. * @alias module:model/AssetResponseAttributes * @class + * @param id {String} The unique id of the hosted asset in UUID format. + * @param owner {String} The owner id of the render task. + * @param filename {String} The asset file name. + * @param status {module:model/AssetResponseAttributes.StatusEnum} The status of the asset.

+ * @param created {String} The time the asset was created. + * @param updated {String} The time the asset status was last updated. */ - var exports = function() { + var exports = function(id, owner, filename, status, created, updated) { var _this = this; + _this['id'] = id; + _this['owner'] = owner; + _this['filename'] = filename; + _this['status'] = status; + _this['created'] = created; + _this['updated'] = updated; }; /** @@ -71,6 +83,9 @@ if (data.hasOwnProperty('renderId')) { obj['renderId'] = ApiClient.convertToType(data['renderId'], 'String'); } + if (data.hasOwnProperty('providerId')) { + obj['providerId'] = ApiClient.convertToType(data['providerId'], 'String'); + } if (data.hasOwnProperty('filename')) { obj['filename'] = ApiClient.convertToType(data['filename'], 'String'); } @@ -110,6 +125,11 @@ * @member {String} renderId */ exports.prototype['renderId'] = undefined; + /** + * 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. + * @member {String} providerId + */ + exports.prototype['providerId'] = undefined; /** * The asset file name. * @member {String} filename @@ -209,6 +229,24 @@ } + /** + * Returns 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. + * @return {String} + */ + exports.prototype.getProviderId = function() { + return this['providerId']; + } + + /** + * Sets 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. + * @param {String} providerId 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. + */ + exports.prototype.setProviderId = function(providerId) { + this['providerId'] = providerId; + return this; + } + + /** * Returns The asset file name. * @return {String} diff --git a/src/model/AssetResponseData.js b/src/model/AssetResponseData.js index 4d494df..f1f28c9 100644 --- a/src/model/AssetResponseData.js +++ b/src/model/AssetResponseData.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -43,10 +43,14 @@ * The type of resource (an asset) and attributes of the asset. * @alias module:model/AssetResponseData * @class + * @param type {String} The type of resource, in this case it is an assets. + * @param attributes {module:model/AssetResponseAttributes} */ - var exports = function() { + var exports = function(type, attributes) { var _this = this; + _this['type'] = type; + _this['attributes'] = attributes; }; /** diff --git a/src/model/AudioAsset.js b/src/model/AudioAsset.js index 10e9b13..a32fb6b 100644 --- a/src/model/AudioAsset.js +++ b/src/model/AudioAsset.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Clip.js b/src/model/Clip.js index fcc7d32..1662d53 100644 --- a/src/model/Clip.js +++ b/src/model/Clip.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Crop.js b/src/model/Crop.js index 8ac9d86..0ce5b7a 100644 --- a/src/model/Crop.js +++ b/src/model/Crop.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Destinations.js b/src/model/Destinations.js index 6a91a96..129c3bf 100644 --- a/src/model/Destinations.js +++ b/src/model/Destinations.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -140,6 +140,7 @@ exports.prototype['options'] = undefined; */ exports.prototype.setProvider = function(provider) { this['provider'] = provider; + return this; } @@ -157,6 +158,7 @@ exports.prototype['options'] = undefined; */ exports.prototype.setExclude = function(exclude) { this['exclude'] = exclude; + return this; } @@ -172,6 +174,7 @@ exports.prototype['options'] = undefined; */ exports.prototype.setOptions = function(options) { this['options'] = options; + return this; } diff --git a/src/model/Edit.js b/src/model/Edit.js index 6ba813d..d9f9766 100644 --- a/src/model/Edit.js +++ b/src/model/Edit.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/FlipTransformation.js b/src/model/FlipTransformation.js index e2479ee..23bbd8f 100644 --- a/src/model/FlipTransformation.js +++ b/src/model/FlipTransformation.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Font.js b/src/model/Font.js index bae8bb2..39f27fd 100644 --- a/src/model/Font.js +++ b/src/model/Font.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/HtmlAsset.js b/src/model/HtmlAsset.js index 06c8bc1..6a57d33 100644 --- a/src/model/HtmlAsset.js +++ b/src/model/HtmlAsset.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/ImageAsset.js b/src/model/ImageAsset.js index 24add2b..909b5a5 100644 --- a/src/model/ImageAsset.js +++ b/src/model/ImageAsset.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/LumaAsset.js b/src/model/LumaAsset.js index 7a04b25..34ffe63 100644 --- a/src/model/LumaAsset.js +++ b/src/model/LumaAsset.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/MergeField.js b/src/model/MergeField.js index 100bd58..e2789e1 100644 --- a/src/model/MergeField.js +++ b/src/model/MergeField.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/MuxDestination.js b/src/model/MuxDestination.js index c1631b4..6c3e206 100644 --- a/src/model/MuxDestination.js +++ b/src/model/MuxDestination.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/MuxDestinationOptions.js b/src/model/MuxDestinationOptions.js index a64ca95..0c0d553 100644 --- a/src/model/MuxDestinationOptions.js +++ b/src/model/MuxDestinationOptions.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Offset.js b/src/model/Offset.js index 1fa31de..686c6a8 100644 --- a/src/model/Offset.js +++ b/src/model/Offset.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Output.js b/src/model/Output.js index 99cbf3b..c354548 100644 --- a/src/model/Output.js +++ b/src/model/Output.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Poster.js b/src/model/Poster.js index cbb1846..698ae85 100644 --- a/src/model/Poster.js +++ b/src/model/Poster.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/ProbeResponse.js b/src/model/ProbeResponse.js index 01a2f08..fa54822 100644 --- a/src/model/ProbeResponse.js +++ b/src/model/ProbeResponse.js @@ -45,7 +45,7 @@ * @class * @param success {Boolean} `true` if media successfully read, else `false`. * @param message {String} `Created`, `Bad Request` or an error message. - * @param response {Object} The response from FFprobe in JSON format + * @param response {Object} The response from FFprobe in JSON format. */ var exports = function(success, message, response) { var _this = this; @@ -89,7 +89,7 @@ */ exports.prototype['message'] = undefined; /** - * The response from FFprobe in JSON format + * The response from FFprobe in JSON format. * @member {Object} response */ exports.prototype['response'] = undefined; @@ -132,7 +132,7 @@ /** - * Returns The response from FFprobe in JSON format + * Returns The response from FFprobe in JSON format. * @return {Object} */ exports.prototype.getResponse = function() { @@ -140,8 +140,8 @@ } /** - * Sets The response from FFprobe in JSON format - * @param {Object} response The response from FFprobe in JSON format + * Sets The response from FFprobe in JSON format. + * @param {Object} response The response from FFprobe in JSON format. */ exports.prototype.setResponse = function(response) { this['response'] = response; diff --git a/src/model/QueuedResponse.js b/src/model/QueuedResponse.js index 109aafe..f6b9970 100644 --- a/src/model/QueuedResponse.js +++ b/src/model/QueuedResponse.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * @@ -40,7 +40,7 @@ /** * Constructs a new QueuedResponse. - * The response received after a [render request](#render-asset) is submitted. The render task is queued for rendering and a unique render id is returned. + * The response received after a [render request](#render-asset) or [template render](#render-template) is submitted. The render task is queued for rendering and a unique render id is returned. * @alias module:model/QueuedResponse * @class * @param success {Boolean} `true` if successfully queued, else `false`. diff --git a/src/model/QueuedResponseData.js b/src/model/QueuedResponseData.js index e58a1e7..e9a9550 100644 --- a/src/model/QueuedResponseData.js +++ b/src/model/QueuedResponseData.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Range.js b/src/model/Range.js index 172302a..20e842d 100644 --- a/src/model/Range.js +++ b/src/model/Range.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/RenderResponse.js b/src/model/RenderResponse.js index 93bc592..d64f4e0 100644 --- a/src/model/RenderResponse.js +++ b/src/model/RenderResponse.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/RenderResponseData.js b/src/model/RenderResponseData.js index e8ec223..6f668f0 100644 --- a/src/model/RenderResponseData.js +++ b/src/model/RenderResponseData.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/RotateTransformation.js b/src/model/RotateTransformation.js index 4cb2bd1..cc2ae55 100644 --- a/src/model/RotateTransformation.js +++ b/src/model/RotateTransformation.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/ShotstackDestination.js b/src/model/ShotstackDestination.js index 85ac039..7efedb5 100644 --- a/src/model/ShotstackDestination.js +++ b/src/model/ShotstackDestination.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Size.js b/src/model/Size.js index 66a0a31..de6f81d 100644 --- a/src/model/Size.js +++ b/src/model/Size.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/SkewTransformation.js b/src/model/SkewTransformation.js index c8a4297..51d6b90 100644 --- a/src/model/SkewTransformation.js +++ b/src/model/SkewTransformation.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Soundtrack.js b/src/model/Soundtrack.js index 4c46148..95511f0 100644 --- a/src/model/Soundtrack.js +++ b/src/model/Soundtrack.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Template.js b/src/model/Template.js new file mode 100644 index 0000000..121a699 --- /dev/null +++ b/src/model/Template.js @@ -0,0 +1,123 @@ +/** + * Shotstack + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * + * The version of the OpenAPI document: v1 + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * + * OpenAPI Generator version: 5.4.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient', 'model/Edit'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient'), require('./Edit')); + } else { + // Browser globals (root is window) + if (!root.ShotstackSdk) { + root.ShotstackSdk = {}; + } + root.ShotstackSdk.Template = factory(root.ShotstackSdk.ApiClient, root.ShotstackSdk.Edit); + } +}(this, function(ApiClient, Edit) { + 'use strict'; + + + + /** + * The Template model module. + * @module model/Template + * @version v1 + */ + + /** + * Constructs a new Template. + * A template is a saved [Edit](#tocs_edit) than can be loaded and re-used. + * @alias module:model/Template + * @class + * @param name {String} The template name + */ + var exports = function(name) { + var _this = this; + + _this['name'] = name; + }; + + /** + * Constructs a Template from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/Template} obj Optional instance to populate. + * @return {module:model/Template} The populated Template instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('template')) { + obj['template'] = Edit.constructFromObject(data['template']); + } + } + return obj; + } + + /** + * The template name + * @member {String} name + */ + exports.prototype['name'] = undefined; + /** + * @member {module:model/Edit} template + */ + exports.prototype['template'] = undefined; + + + /** + * Returns The template name + * @return {String} + */ + exports.prototype.getName = function() { + return this['name']; + } + + /** + * Sets The template name + * @param {String} name The template name + */ + exports.prototype.setName = function(name) { + this['name'] = name; + return this; + } + + + /** + * @return {module:model/Edit} + */ + exports.prototype.getTemplate = function() { + return this['template']; + } + + /** + * @param {module:model/Edit} template + */ + exports.prototype.setTemplate = function(template) { + this['template'] = template; + return this; + } + + + + return exports; +})); + + diff --git a/src/model/TemplateDataResponse.js b/src/model/TemplateDataResponse.js new file mode 100644 index 0000000..fd72891 --- /dev/null +++ b/src/model/TemplateDataResponse.js @@ -0,0 +1,153 @@ +/** + * Shotstack + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * + * The version of the OpenAPI document: v1 + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * + * OpenAPI Generator version: 5.4.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient', 'model/TemplateDataResponseData'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient'), require('./TemplateDataResponseData')); + } else { + // Browser globals (root is window) + if (!root.ShotstackSdk) { + root.ShotstackSdk = {}; + } + root.ShotstackSdk.TemplateDataResponse = factory(root.ShotstackSdk.ApiClient, root.ShotstackSdk.TemplateDataResponseData); + } +}(this, function(ApiClient, TemplateDataResponseData) { + 'use strict'; + + + + /** + * The TemplateDataResponse model module. + * @module model/TemplateDataResponse + * @version v1 + */ + + /** + * Constructs a new TemplateDataResponse. + * The template data including the template name and Edit. + * @alias module:model/TemplateDataResponse + * @class + * @param success {Boolean} `true` if successfully created, else `false`. + * @param message {String} `OK`, `Bad Request` or an error message. + * @param response {module:model/TemplateDataResponseData} + */ + var exports = function(success, message, response) { + var _this = this; + + _this['success'] = success; + _this['message'] = message; + _this['response'] = response; + }; + + /** + * Constructs a TemplateDataResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TemplateDataResponse} obj Optional instance to populate. + * @return {module:model/TemplateDataResponse} The populated TemplateDataResponse instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + if (data.hasOwnProperty('success')) { + obj['success'] = ApiClient.convertToType(data['success'], 'Boolean'); + } + if (data.hasOwnProperty('message')) { + obj['message'] = ApiClient.convertToType(data['message'], 'String'); + } + if (data.hasOwnProperty('response')) { + obj['response'] = TemplateDataResponseData.constructFromObject(data['response']); + } + } + return obj; + } + + /** + * `true` if successfully created, else `false`. + * @member {Boolean} success + */ + exports.prototype['success'] = undefined; + /** + * `OK`, `Bad Request` or an error message. + * @member {String} message + */ + exports.prototype['message'] = undefined; + /** + * @member {module:model/TemplateDataResponseData} response + */ + exports.prototype['response'] = undefined; + + + /** + * Returns `true` if successfully created, else `false`. + * @return {Boolean} + */ + exports.prototype.getSuccess = function() { + return this['success']; + } + + /** + * Sets `true` if successfully created, else `false`. + * @param {Boolean} success `true` if successfully created, else `false`. + */ + exports.prototype.setSuccess = function(success) { + this['success'] = success; + return this; + } + + + /** + * Returns `OK`, `Bad Request` or an error message. + * @return {String} + */ + exports.prototype.getMessage = function() { + return this['message']; + } + + /** + * Sets `OK`, `Bad Request` or an error message. + * @param {String} message `OK`, `Bad Request` or an error message. + */ + exports.prototype.setMessage = function(message) { + this['message'] = message; + return this; + } + + + /** + * @return {module:model/TemplateDataResponseData} + */ + exports.prototype.getResponse = function() { + return this['response']; + } + + /** + * @param {module:model/TemplateDataResponseData} response + */ + exports.prototype.setResponse = function(response) { + this['response'] = response; + return this; + } + + + + return exports; +})); + + diff --git a/src/model/TemplateDataResponseData.js b/src/model/TemplateDataResponseData.js new file mode 100644 index 0000000..d3663fd --- /dev/null +++ b/src/model/TemplateDataResponseData.js @@ -0,0 +1,184 @@ +/** + * Shotstack + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * + * The version of the OpenAPI document: v1 + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * + * OpenAPI Generator version: 5.4.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient')); + } else { + // Browser globals (root is window) + if (!root.ShotstackSdk) { + root.ShotstackSdk = {}; + } + root.ShotstackSdk.TemplateDataResponseData = factory(root.ShotstackSdk.ApiClient); + } +}(this, function(ApiClient) { + 'use strict'; + + + + /** + * The TemplateDataResponseData model module. + * @module model/TemplateDataResponseData + * @version v1 + */ + + /** + * Constructs a new TemplateDataResponseData. + * The response data returned with the [TemplateDataResponse](#tocs_templatedataresponse). + * @alias module:model/TemplateDataResponseData + * @class + * @param id {String} The unique id of the template in UUID format. + * @param name {String} The template name. + * @param owner {String} The owner id of the templates. + * @param template {String} The [Edit](#tocs_edit) template. + */ + var exports = function(id, name, owner, template) { + var _this = this; + + _this['id'] = id; + _this['name'] = name; + _this['owner'] = owner; + _this['template'] = template; + }; + + /** + * Constructs a TemplateDataResponseData from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TemplateDataResponseData} obj Optional instance to populate. + * @return {module:model/TemplateDataResponseData} The populated TemplateDataResponseData instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'String'); + } + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('owner')) { + obj['owner'] = ApiClient.convertToType(data['owner'], 'String'); + } + if (data.hasOwnProperty('template')) { + obj['template'] = ApiClient.convertToType(data['template'], 'String'); + } + } + return obj; + } + + /** + * The unique id of the template in UUID format. + * @member {String} id + */ + exports.prototype['id'] = undefined; + /** + * The template name. + * @member {String} name + */ + exports.prototype['name'] = undefined; + /** + * The owner id of the templates. + * @member {String} owner + */ + exports.prototype['owner'] = undefined; + /** + * The [Edit](#tocs_edit) template. + * @member {String} template + */ + exports.prototype['template'] = undefined; + + + /** + * Returns The unique id of the template in UUID format. + * @return {String} + */ + exports.prototype.getId = function() { + return this['id']; + } + + /** + * Sets The unique id of the template in UUID format. + * @param {String} id The unique id of the template in UUID format. + */ + exports.prototype.setId = function(id) { + this['id'] = id; + return this; + } + + + /** + * Returns The template name. + * @return {String} + */ + exports.prototype.getName = function() { + return this['name']; + } + + /** + * Sets The template name. + * @param {String} name The template name. + */ + exports.prototype.setName = function(name) { + this['name'] = name; + return this; + } + + + /** + * Returns The owner id of the templates. + * @return {String} + */ + exports.prototype.getOwner = function() { + return this['owner']; + } + + /** + * Sets The owner id of the templates. + * @param {String} owner The owner id of the templates. + */ + exports.prototype.setOwner = function(owner) { + this['owner'] = owner; + return this; + } + + + /** + * Returns The [Edit](#tocs_edit) template. + * @return {String} + */ + exports.prototype.getTemplate = function() { + return this['template']; + } + + /** + * Sets The [Edit](#tocs_edit) template. + * @param {String} template The [Edit](#tocs_edit) template. + */ + exports.prototype.setTemplate = function(template) { + this['template'] = template; + return this; + } + + + + return exports; +})); + + diff --git a/src/model/TemplateListResponse.js b/src/model/TemplateListResponse.js new file mode 100644 index 0000000..1e6b12b --- /dev/null +++ b/src/model/TemplateListResponse.js @@ -0,0 +1,153 @@ +/** + * Shotstack + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * + * The version of the OpenAPI document: v1 + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * + * OpenAPI Generator version: 5.4.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient', 'model/TemplateListResponseData'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient'), require('./TemplateListResponseData')); + } else { + // Browser globals (root is window) + if (!root.ShotstackSdk) { + root.ShotstackSdk = {}; + } + root.ShotstackSdk.TemplateListResponse = factory(root.ShotstackSdk.ApiClient, root.ShotstackSdk.TemplateListResponseData); + } +}(this, function(ApiClient, TemplateListResponseData) { + 'use strict'; + + + + /** + * The TemplateListResponse model module. + * @module model/TemplateListResponse + * @version v1 + */ + + /** + * Constructs a new TemplateListResponse. + * A list of previously saved templates. + * @alias module:model/TemplateListResponse + * @class + * @param success {Boolean} `true` if successfully created, else `false`. + * @param message {String} `Created`, `Bad Request` or an error message. + * @param response {module:model/TemplateListResponseData} + */ + var exports = function(success, message, response) { + var _this = this; + + _this['success'] = success; + _this['message'] = message; + _this['response'] = response; + }; + + /** + * Constructs a TemplateListResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TemplateListResponse} obj Optional instance to populate. + * @return {module:model/TemplateListResponse} The populated TemplateListResponse instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + if (data.hasOwnProperty('success')) { + obj['success'] = ApiClient.convertToType(data['success'], 'Boolean'); + } + if (data.hasOwnProperty('message')) { + obj['message'] = ApiClient.convertToType(data['message'], 'String'); + } + if (data.hasOwnProperty('response')) { + obj['response'] = TemplateListResponseData.constructFromObject(data['response']); + } + } + return obj; + } + + /** + * `true` if successfully created, else `false`. + * @member {Boolean} success + */ + exports.prototype['success'] = undefined; + /** + * `Created`, `Bad Request` or an error message. + * @member {String} message + */ + exports.prototype['message'] = undefined; + /** + * @member {module:model/TemplateListResponseData} response + */ + exports.prototype['response'] = undefined; + + + /** + * Returns `true` if successfully created, else `false`. + * @return {Boolean} + */ + exports.prototype.getSuccess = function() { + return this['success']; + } + + /** + * Sets `true` if successfully created, else `false`. + * @param {Boolean} success `true` if successfully created, else `false`. + */ + exports.prototype.setSuccess = function(success) { + this['success'] = success; + return this; + } + + + /** + * Returns `Created`, `Bad Request` or an error message. + * @return {String} + */ + exports.prototype.getMessage = function() { + return this['message']; + } + + /** + * Sets `Created`, `Bad Request` or an error message. + * @param {String} message `Created`, `Bad Request` or an error message. + */ + exports.prototype.setMessage = function(message) { + this['message'] = message; + return this; + } + + + /** + * @return {module:model/TemplateListResponseData} + */ + exports.prototype.getResponse = function() { + return this['response']; + } + + /** + * @param {module:model/TemplateListResponseData} response + */ + exports.prototype.setResponse = function(response) { + this['response'] = response; + return this; + } + + + + return exports; +})); + + diff --git a/src/model/TemplateListResponseData.js b/src/model/TemplateListResponseData.js new file mode 100644 index 0000000..83a3062 --- /dev/null +++ b/src/model/TemplateListResponseData.js @@ -0,0 +1,128 @@ +/** + * Shotstack + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * + * The version of the OpenAPI document: v1 + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * + * OpenAPI Generator version: 5.4.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient', 'model/TemplateListResponseItem'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient'), require('./TemplateListResponseItem')); + } else { + // Browser globals (root is window) + if (!root.ShotstackSdk) { + root.ShotstackSdk = {}; + } + root.ShotstackSdk.TemplateListResponseData = factory(root.ShotstackSdk.ApiClient, root.ShotstackSdk.TemplateListResponseItem); + } +}(this, function(ApiClient, TemplateListResponseItem) { + 'use strict'; + + + + /** + * The TemplateListResponseData model module. + * @module model/TemplateListResponseData + * @version v1 + */ + + /** + * Constructs a new TemplateListResponseData. + * The response data returned with the [TemplateListResponse](#tocs_templatelistresponse). + * @alias module:model/TemplateListResponseData + * @class + * @param owner {String} The owner id of the templates. + * @param templates {Array.} The list of templates. + */ + var exports = function(owner, templates) { + var _this = this; + + _this['owner'] = owner; + _this['templates'] = templates; + }; + + /** + * Constructs a TemplateListResponseData from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TemplateListResponseData} obj Optional instance to populate. + * @return {module:model/TemplateListResponseData} The populated TemplateListResponseData instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + if (data.hasOwnProperty('owner')) { + obj['owner'] = ApiClient.convertToType(data['owner'], 'String'); + } + if (data.hasOwnProperty('templates')) { + obj['templates'] = ApiClient.convertToType(data['templates'], [TemplateListResponseItem]); + } + } + return obj; + } + + /** + * The owner id of the templates. + * @member {String} owner + */ + exports.prototype['owner'] = undefined; + /** + * The list of templates. + * @member {Array.} templates + */ + exports.prototype['templates'] = undefined; + + + /** + * Returns The owner id of the templates. + * @return {String} + */ + exports.prototype.getOwner = function() { + return this['owner']; + } + + /** + * Sets The owner id of the templates. + * @param {String} owner The owner id of the templates. + */ + exports.prototype.setOwner = function(owner) { + this['owner'] = owner; + return this; + } + + + /** + * Returns The list of templates. + * @return {Array.} + */ + exports.prototype.getTemplates = function() { + return this['templates']; + } + + /** + * Sets The list of templates. + * @param {Array.} templates The list of templates. + */ + exports.prototype.setTemplates = function(templates) { + this['templates'] = templates; + return this; + } + + + + return exports; +})); + + diff --git a/src/model/TemplateListResponseItem.js b/src/model/TemplateListResponseItem.js new file mode 100644 index 0000000..ce91d23 --- /dev/null +++ b/src/model/TemplateListResponseItem.js @@ -0,0 +1,184 @@ +/** + * Shotstack + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * + * The version of the OpenAPI document: v1 + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * + * OpenAPI Generator version: 5.4.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient')); + } else { + // Browser globals (root is window) + if (!root.ShotstackSdk) { + root.ShotstackSdk = {}; + } + root.ShotstackSdk.TemplateListResponseItem = factory(root.ShotstackSdk.ApiClient); + } +}(this, function(ApiClient) { + 'use strict'; + + + + /** + * The TemplateListResponseItem model module. + * @module model/TemplateListResponseItem + * @version v1 + */ + + /** + * Constructs a new TemplateListResponseItem. + * The individual template item returned with the [TemplateListResponseData](#tocs_templatelistresponsedata) templates list. + * @alias module:model/TemplateListResponseItem + * @class + * @param id {String} The unique id of the template in UUID format. + * @param name {String} The template name + * @param created {String} The time the template was created. + * @param updated {String} The time the template was last updated. + */ + var exports = function(id, name, created, updated) { + var _this = this; + + _this['id'] = id; + _this['name'] = name; + _this['created'] = created; + _this['updated'] = updated; + }; + + /** + * Constructs a TemplateListResponseItem from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TemplateListResponseItem} obj Optional instance to populate. + * @return {module:model/TemplateListResponseItem} The populated TemplateListResponseItem instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'String'); + } + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('created')) { + obj['created'] = ApiClient.convertToType(data['created'], 'String'); + } + if (data.hasOwnProperty('updated')) { + obj['updated'] = ApiClient.convertToType(data['updated'], 'String'); + } + } + return obj; + } + + /** + * The unique id of the template in UUID format. + * @member {String} id + */ + exports.prototype['id'] = undefined; + /** + * The template name + * @member {String} name + */ + exports.prototype['name'] = undefined; + /** + * The time the template was created. + * @member {String} created + */ + exports.prototype['created'] = undefined; + /** + * The time the template was last updated. + * @member {String} updated + */ + exports.prototype['updated'] = undefined; + + + /** + * Returns The unique id of the template in UUID format. + * @return {String} + */ + exports.prototype.getId = function() { + return this['id']; + } + + /** + * Sets The unique id of the template in UUID format. + * @param {String} id The unique id of the template in UUID format. + */ + exports.prototype.setId = function(id) { + this['id'] = id; + return this; + } + + + /** + * Returns The template name + * @return {String} + */ + exports.prototype.getName = function() { + return this['name']; + } + + /** + * Sets The template name + * @param {String} name The template name + */ + exports.prototype.setName = function(name) { + this['name'] = name; + return this; + } + + + /** + * Returns The time the template was created. + * @return {String} + */ + exports.prototype.getCreated = function() { + return this['created']; + } + + /** + * Sets The time the template was created. + * @param {String} created The time the template was created. + */ + exports.prototype.setCreated = function(created) { + this['created'] = created; + return this; + } + + + /** + * Returns The time the template was last updated. + * @return {String} + */ + exports.prototype.getUpdated = function() { + return this['updated']; + } + + /** + * Sets The time the template was last updated. + * @param {String} updated The time the template was last updated. + */ + exports.prototype.setUpdated = function(updated) { + this['updated'] = updated; + return this; + } + + + + return exports; +})); + + diff --git a/src/model/TemplateRender.js b/src/model/TemplateRender.js new file mode 100644 index 0000000..43f6a00 --- /dev/null +++ b/src/model/TemplateRender.js @@ -0,0 +1,126 @@ +/** + * Shotstack + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * + * The version of the OpenAPI document: v1 + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * + * OpenAPI Generator version: 5.4.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient', 'model/MergeField'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient'), require('./MergeField')); + } else { + // Browser globals (root is window) + if (!root.ShotstackSdk) { + root.ShotstackSdk = {}; + } + root.ShotstackSdk.TemplateRender = factory(root.ShotstackSdk.ApiClient, root.ShotstackSdk.MergeField); + } +}(this, function(ApiClient, MergeField) { + 'use strict'; + + + + /** + * The TemplateRender model module. + * @module model/TemplateRender + * @version v1 + */ + + /** + * Constructs a new TemplateRender. + * Render a template by it's id and optional merge fields. + * @alias module:model/TemplateRender + * @class + * @param id {String} The id of the template to render in UUID format. + */ + var exports = function(id) { + var _this = this; + + _this['id'] = id; + }; + + /** + * Constructs a TemplateRender from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TemplateRender} obj Optional instance to populate. + * @return {module:model/TemplateRender} The populated TemplateRender instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'String'); + } + if (data.hasOwnProperty('merge')) { + obj['merge'] = ApiClient.convertToType(data['merge'], [MergeField]); + } + } + return obj; + } + + /** + * The id of the template to render in UUID format. + * @member {String} id + */ + exports.prototype['id'] = undefined; + /** + * 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`. + * @member {Array.} merge + */ + exports.prototype['merge'] = undefined; + + + /** + * Returns The id of the template to render in UUID format. + * @return {String} + */ + exports.prototype.getId = function() { + return this['id']; + } + + /** + * Sets The id of the template to render in UUID format. + * @param {String} id The id of the template to render in UUID format. + */ + exports.prototype.setId = function(id) { + this['id'] = id; + return this; + } + + + /** + * Returns 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`. + * @return {Array.} + */ + exports.prototype.getMerge = function() { + return this['merge']; + } + + /** + * Sets 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`. + * @param {Array.} merge 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`. + */ + exports.prototype.setMerge = function(merge) { + this['merge'] = merge; + return this; + } + + + + return exports; +})); + + diff --git a/src/model/TemplateResponse.js b/src/model/TemplateResponse.js new file mode 100644 index 0000000..853e743 --- /dev/null +++ b/src/model/TemplateResponse.js @@ -0,0 +1,153 @@ +/** + * Shotstack + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * + * The version of the OpenAPI document: v1 + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * + * OpenAPI Generator version: 5.4.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient', 'model/TemplateResponseData'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient'), require('./TemplateResponseData')); + } else { + // Browser globals (root is window) + if (!root.ShotstackSdk) { + root.ShotstackSdk = {}; + } + root.ShotstackSdk.TemplateResponse = factory(root.ShotstackSdk.ApiClient, root.ShotstackSdk.TemplateResponseData); + } +}(this, function(ApiClient, TemplateResponseData) { + 'use strict'; + + + + /** + * The TemplateResponse model module. + * @module model/TemplateResponse + * @version v1 + */ + + /** + * Constructs a new TemplateResponse. + * The response received after a [template](#create-a-template) is submitted. The template is saved and a unique template id is returned. + * @alias module:model/TemplateResponse + * @class + * @param success {Boolean} `true` if successfully created, else `false`. + * @param message {String} `Created`, `Bad Request` or an error message. + * @param response {module:model/TemplateResponseData} + */ + var exports = function(success, message, response) { + var _this = this; + + _this['success'] = success; + _this['message'] = message; + _this['response'] = response; + }; + + /** + * Constructs a TemplateResponse from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TemplateResponse} obj Optional instance to populate. + * @return {module:model/TemplateResponse} The populated TemplateResponse instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + if (data.hasOwnProperty('success')) { + obj['success'] = ApiClient.convertToType(data['success'], 'Boolean'); + } + if (data.hasOwnProperty('message')) { + obj['message'] = ApiClient.convertToType(data['message'], 'String'); + } + if (data.hasOwnProperty('response')) { + obj['response'] = TemplateResponseData.constructFromObject(data['response']); + } + } + return obj; + } + + /** + * `true` if successfully created, else `false`. + * @member {Boolean} success + */ + exports.prototype['success'] = undefined; + /** + * `Created`, `Bad Request` or an error message. + * @member {String} message + */ + exports.prototype['message'] = undefined; + /** + * @member {module:model/TemplateResponseData} response + */ + exports.prototype['response'] = undefined; + + + /** + * Returns `true` if successfully created, else `false`. + * @return {Boolean} + */ + exports.prototype.getSuccess = function() { + return this['success']; + } + + /** + * Sets `true` if successfully created, else `false`. + * @param {Boolean} success `true` if successfully created, else `false`. + */ + exports.prototype.setSuccess = function(success) { + this['success'] = success; + return this; + } + + + /** + * Returns `Created`, `Bad Request` or an error message. + * @return {String} + */ + exports.prototype.getMessage = function() { + return this['message']; + } + + /** + * Sets `Created`, `Bad Request` or an error message. + * @param {String} message `Created`, `Bad Request` or an error message. + */ + exports.prototype.setMessage = function(message) { + this['message'] = message; + return this; + } + + + /** + * @return {module:model/TemplateResponseData} + */ + exports.prototype.getResponse = function() { + return this['response']; + } + + /** + * @param {module:model/TemplateResponseData} response + */ + exports.prototype.setResponse = function(response) { + this['response'] = response; + return this; + } + + + + return exports; +})); + + diff --git a/src/model/TemplateResponseData.js b/src/model/TemplateResponseData.js new file mode 100644 index 0000000..9e79c33 --- /dev/null +++ b/src/model/TemplateResponseData.js @@ -0,0 +1,128 @@ +/** + * Shotstack + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * + * The version of the OpenAPI document: v1 + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * + * OpenAPI Generator version: 5.4.0 + * + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(['ApiClient'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + module.exports = factory(require('../ApiClient')); + } else { + // Browser globals (root is window) + if (!root.ShotstackSdk) { + root.ShotstackSdk = {}; + } + root.ShotstackSdk.TemplateResponseData = factory(root.ShotstackSdk.ApiClient); + } +}(this, function(ApiClient) { + 'use strict'; + + + + /** + * The TemplateResponseData model module. + * @module model/TemplateResponseData + * @version v1 + */ + + /** + * Constructs a new TemplateResponseData. + * The response data returned with the [TemplateResponse](#tocs_templateresponse). + * @alias module:model/TemplateResponseData + * @class + * @param message {String} Success response message or error details. + * @param id {String} The unique id of the template in UUID format. + */ + var exports = function(message, id) { + var _this = this; + + _this['message'] = message; + _this['id'] = id; + }; + + /** + * Constructs a TemplateResponseData from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/TemplateResponseData} obj Optional instance to populate. + * @return {module:model/TemplateResponseData} The populated TemplateResponseData instance. + */ + exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + if (data.hasOwnProperty('message')) { + obj['message'] = ApiClient.convertToType(data['message'], 'String'); + } + if (data.hasOwnProperty('id')) { + obj['id'] = ApiClient.convertToType(data['id'], 'String'); + } + } + return obj; + } + + /** + * Success response message or error details. + * @member {String} message + */ + exports.prototype['message'] = undefined; + /** + * The unique id of the template in UUID format. + * @member {String} id + */ + exports.prototype['id'] = undefined; + + + /** + * Returns Success response message or error details. + * @return {String} + */ + exports.prototype.getMessage = function() { + return this['message']; + } + + /** + * Sets Success response message or error details. + * @param {String} message Success response message or error details. + */ + exports.prototype.setMessage = function(message) { + this['message'] = message; + return this; + } + + + /** + * Returns The unique id of the template in UUID format. + * @return {String} + */ + exports.prototype.getId = function() { + return this['id']; + } + + /** + * Sets The unique id of the template in UUID format. + * @param {String} id The unique id of the template in UUID format. + */ + exports.prototype.setId = function(id) { + this['id'] = id; + return this; + } + + + + return exports; +})); + + diff --git a/src/model/Thumbnail.js b/src/model/Thumbnail.js index 1d5f451..9905060 100644 --- a/src/model/Thumbnail.js +++ b/src/model/Thumbnail.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Timeline.js b/src/model/Timeline.js index 8143a17..b5ba8cc 100644 --- a/src/model/Timeline.js +++ b/src/model/Timeline.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/TitleAsset.js b/src/model/TitleAsset.js index 0cf9fbe..4ad6b72 100644 --- a/src/model/TitleAsset.js +++ b/src/model/TitleAsset.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Track.js b/src/model/Track.js index e567255..ff2d577 100644 --- a/src/model/Track.js +++ b/src/model/Track.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Transformation.js b/src/model/Transformation.js index a4bce0c..371ca1b 100644 --- a/src/model/Transformation.js +++ b/src/model/Transformation.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/Transition.js b/src/model/Transition.js index b90a7cd..0d5c140 100644 --- a/src/model/Transition.js +++ b/src/model/Transition.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 * diff --git a/src/model/VideoAsset.js b/src/model/VideoAsset.js index 0a79bcd..0daf256 100644 --- a/src/model/VideoAsset.js +++ b/src/model/VideoAsset.js @@ -1,6 +1,6 @@ /** * Shotstack - * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} + * Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API. You arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation. There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API). The Edit API base URL is: https://api.shotstack.io/{version} The Serve API base URL is: https://api.shotstack.io/serve/{version} * * The version of the OpenAPI document: v1 *