Skip to content

Commit e02461b

Browse files
committed
Add Templates to SDK
- Add Template models - Update model set functions to return object references
1 parent 72b289d commit e02461b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1812
-72
lines changed

src/ApiClient.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* 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: <b>https://api.shotstack.io/{version}</b> The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b>
3+
* 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: <b>https://api.shotstack.io/{version}</b> The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b>
44
*
55
* The version of the OpenAPI document: v1
66
*

src/api/EditApi.js

Lines changed: 308 additions & 11 deletions
Large diffs are not rendered by default.

src/api/ServeApi.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* 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: <b>https://api.shotstack.io/{version}</b> The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b>
3+
* 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: <b>https://api.shotstack.io/{version}</b> The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b>
44
*
55
* The version of the OpenAPI document: v1
66
*
@@ -50,7 +50,7 @@
5050

5151
/**
5252
* Delete Asset
53-
* 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}
53+
* 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}
5454
* @param {String} id The id of the asset in UUID format
5555
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
5656
*/
@@ -86,7 +86,7 @@
8686

8787
/**
8888
* Delete Asset
89-
* 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}
89+
* 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}
9090
* @param {String} id The id of the asset in UUID format
9191
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
9292
*/
@@ -100,7 +100,7 @@
100100

101101
/**
102102
* Get Asset
103-
* 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}
103+
* 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}
104104
* @param {String} id The id of the asset in UUID format
105105
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AssetResponse} and HTTP response
106106
*/
@@ -136,7 +136,7 @@
136136

137137
/**
138138
* Get Asset
139-
* 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}
139+
* 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}
140140
* @param {String} id The id of the asset in UUID format
141141
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AssetResponse}
142142
*/
@@ -150,7 +150,7 @@
150150

151151
/**
152152
* Get Asset by Render ID
153-
* 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}
153+
* 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}
154154
* @param {String} id The render id associated with the asset in UUID format
155155
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AssetRenderResponse} and HTTP response
156156
*/
@@ -186,7 +186,7 @@
186186

187187
/**
188188
* Get Asset by Render ID
189-
* 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}
189+
* 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}
190190
* @param {String} id The render id associated with the asset in UUID format
191191
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AssetRenderResponse}
192192
*/

src/index.js

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* 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: <b>https://api.shotstack.io/{version}</b> The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b>
3+
* 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: <b>https://api.shotstack.io/{version}</b> The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b>
44
*
55
* The version of the OpenAPI document: v1
66
*
@@ -16,16 +16,16 @@
1616
(function(factory) {
1717
if (typeof define === 'function' && define.amd) {
1818
// AMD. Register as an anonymous module.
19-
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);
19+
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);
2020
} else if (typeof module === 'object' && module.exports) {
2121
// CommonJS-like environments that support module.exports, like Node.
22-
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'));
22+
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'));
2323
}
24-
}(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) {
24+
}(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) {
2525
'use strict';
2626

2727
/**
28-
* 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.<br>
28+
* 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.<br>
2929
* The <code>index</code> module provides access to constructors for all the classes which comprise the public API.
3030
* <p>
3131
* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:
@@ -221,6 +221,51 @@
221221
* @property {module:model/Soundtrack}
222222
*/
223223
Soundtrack: Soundtrack,
224+
/**
225+
* The Template model constructor.
226+
* @property {module:model/Template}
227+
*/
228+
Template: Template,
229+
/**
230+
* The TemplateDataResponse model constructor.
231+
* @property {module:model/TemplateDataResponse}
232+
*/
233+
TemplateDataResponse: TemplateDataResponse,
234+
/**
235+
* The TemplateDataResponseData model constructor.
236+
* @property {module:model/TemplateDataResponseData}
237+
*/
238+
TemplateDataResponseData: TemplateDataResponseData,
239+
/**
240+
* The TemplateListResponse model constructor.
241+
* @property {module:model/TemplateListResponse}
242+
*/
243+
TemplateListResponse: TemplateListResponse,
244+
/**
245+
* The TemplateListResponseData model constructor.
246+
* @property {module:model/TemplateListResponseData}
247+
*/
248+
TemplateListResponseData: TemplateListResponseData,
249+
/**
250+
* The TemplateListResponseItem model constructor.
251+
* @property {module:model/TemplateListResponseItem}
252+
*/
253+
TemplateListResponseItem: TemplateListResponseItem,
254+
/**
255+
* The TemplateRender model constructor.
256+
* @property {module:model/TemplateRender}
257+
*/
258+
TemplateRender: TemplateRender,
259+
/**
260+
* The TemplateResponse model constructor.
261+
* @property {module:model/TemplateResponse}
262+
*/
263+
TemplateResponse: TemplateResponse,
264+
/**
265+
* The TemplateResponseData model constructor.
266+
* @property {module:model/TemplateResponseData}
267+
*/
268+
TemplateResponseData: TemplateResponseData,
224269
/**
225270
* The Thumbnail model constructor.
226271
* @property {module:model/Thumbnail}

0 commit comments

Comments
 (0)