Skip to content

Commit e2b23c1

Browse files
authored
Merge pull request #19 from shotstack/latest-updates
Update latest changes to align with API reference docs, including S3 destination
2 parents 763b95d + a95c57a commit e2b23c1

27 files changed

Lines changed: 660 additions & 190 deletions

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "shotstack-sdk",
3-
"version": "0.2.0",
3+
"version": "0.2.1",
44
"description": "Official Node SDK for the Shotstack Cloud Video Editing API",
55
"license": "MIT",
66
"main": "src/index.js",

‎src/index.js‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@
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/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);
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/S3Destination', 'model/S3DestinationOptions', '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/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'));
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/S3Destination'), require('./model/S3DestinationOptions'), 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, Template, TemplateDataResponse, TemplateDataResponseData, TemplateListResponse, TemplateListResponseData, TemplateListResponseItem, TemplateRender, TemplateResponse, TemplateResponseData, 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, S3Destination, S3DestinationOptions, 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
/**
@@ -201,6 +201,16 @@
201201
* @property {module:model/RotateTransformation}
202202
*/
203203
RotateTransformation: RotateTransformation,
204+
/**
205+
* The S3Destination model constructor.
206+
* @property {module:model/S3Destination}
207+
*/
208+
S3Destination: S3Destination,
209+
/**
210+
* The S3DestinationOptions model constructor.
211+
* @property {module:model/S3DestinationOptions}
212+
*/
213+
S3DestinationOptions: S3DestinationOptions,
204214
/**
205215
* The ShotstackDestination model constructor.
206216
* @property {module:model/ShotstackDestination}

‎src/model/Asset.js‎

Lines changed: 49 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040

4141
/**
4242
* Constructs a new <code>Asset</code>.
43-
* The type of asset to display for the duration of this Clip. Value must be one of: &lt;ul&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_videoasset\&quot;&gt;VideoAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_imageasset\&quot;&gt;ImageAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_titleasset\&quot;&gt;TitleAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_htmlasset\&quot;&gt;HtmlAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_audioasset\&quot;&gt;AudioAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_lumaasset\&quot;&gt;LumaAsset&lt;/a&gt;&lt;/li&gt; &lt;/ul&gt;
43+
* The type of asset to display for the duration of the Clip. Value must be one of: &lt;ul&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_videoasset\&quot;&gt;VideoAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_imageasset\&quot;&gt;ImageAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_titleasset\&quot;&gt;TitleAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_htmlasset\&quot;&gt;HtmlAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_audioasset\&quot;&gt;AudioAsset&lt;/a&gt;&lt;/li&gt; &lt;li&gt;&lt;a href&#x3D;\&quot;#tocs_lumaasset\&quot;&gt;LumaAsset&lt;/a&gt;&lt;/li&gt; &lt;/ul&gt;
4444
* @alias module:model/Asset
4545
* @class
4646
* @implements module:model/VideoAsset
@@ -97,6 +97,9 @@
9797
if (data.hasOwnProperty('volume')) {
9898
obj['volume'] = ApiClient.convertToType(data['volume'], 'Number');
9999
}
100+
if (data.hasOwnProperty('volumeEffect')) {
101+
obj['volumeEffect'] = ApiClient.convertToType(data['volumeEffect'], 'String');
102+
}
100103
if (data.hasOwnProperty('crop')) {
101104
obj['crop'] = Crop.constructFromObject(data['crop']);
102105
}
@@ -159,9 +162,13 @@
159162
/**
160163
* Set the volume for the audio clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
161164
* @member {Number} volume
162-
* @default 1
163165
*/
164-
exports.prototype['volume'] = 1;
166+
exports.prototype['volume'] = undefined;
167+
/**
168+
* The volume effect to apply to the video asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
169+
* @member {module:model/Asset.VolumeEffectEnum} volumeEffect
170+
*/
171+
exports.prototype['volumeEffect'] = undefined;
165172
/**
166173
* @member {module:model/Crop} crop
167174
*/
@@ -179,27 +186,23 @@
179186
/**
180187
* Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.
181188
* @member {String} color
182-
* @default '#ffffff'
183189
*/
184-
exports.prototype['color'] = '#ffffff';
190+
exports.prototype['color'] = undefined;
185191
/**
186192
* Set the relative size of the text using predefined sizes from xx-small to xx-large. <ul> <li>`xx-small`</li> <li>`x-small`</li> <li>`small`</li> <li>`medium`</li> <li>`large`</li> <li>`x-large`</li> <li>`xx-large`</li> </ul>
187193
* @member {module:model/Asset.SizeEnum} size
188-
* @default 'medium'
189194
*/
190-
exports.prototype['size'] = 'medium';
195+
exports.prototype['size'] = undefined;
191196
/**
192197
* Apply a background color behind the HTML bounding box using. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.
193198
* @member {String} background
194-
* @default 'transparent'
195199
*/
196-
exports.prototype['background'] = 'transparent';
200+
exports.prototype['background'] = undefined;
197201
/**
198202
* Place the HTML in one of nine predefined positions within the HTML area. <ul> <li>`top` - top (center)</li> <li>`topRight` - top right</li> <li>`right` - right (center)</li> <li>`bottomRight` - bottom right</li> <li>`bottom` - bottom (center)</li> <li>`bottomLeft` - bottom left</li> <li>`left` - left (center)</li> <li>`topLeft` - top left</li> <li>`center` - center</li> </ul>
199203
* @member {module:model/Asset.PositionEnum} position
200-
* @default 'center'
201204
*/
202-
exports.prototype['position'] = 'center';
205+
exports.prototype['position'] = undefined;
203206
/**
204207
* @member {module:model/Offset} offset
205208
*/
@@ -251,11 +254,17 @@ exports.prototype['src'] = undefined;
251254
exports.prototype['trim'] = undefined;
252255

253256
/**
254-
* Set the volume for the video clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 0).
257+
* Set the volume for the video clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
255258
* @member {Number} volume
256259
*/
257260
exports.prototype['volume'] = undefined;
258261

262+
/**
263+
* The volume effect to apply to the video asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
264+
* @member {module:model/VideoAsset.VolumeEffectEnum} volumeEffect
265+
*/
266+
exports.prototype['volumeEffect'] = undefined;
267+
259268
/**
260269
* @member {module:model/Crop} crop
261270
*/
@@ -303,16 +312,14 @@ exports.prototype['style'] = undefined;
303312
/**
304313
* Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.
305314
* @member {String} color
306-
* @default '#ffffff'
307315
*/
308-
exports.prototype['color'] = '#ffffff';
316+
exports.prototype['color'] = undefined;
309317

310318
/**
311319
* Set the relative size of the text using predefined sizes from xx-small to xx-large. <ul> <li>`xx-small`</li> <li>`x-small`</li> <li>`small`</li> <li>`medium`</li> <li>`large`</li> <li>`x-large`</li> <li>`xx-large`</li> </ul>
312320
* @member {module:model/TitleAsset.SizeEnum} size
313-
* @default 'medium'
314321
*/
315-
exports.prototype['size'] = 'medium';
322+
exports.prototype['size'] = undefined;
316323

317324
/**
318325
* Apply a background color behind the text. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency. Omit to use transparent background.
@@ -323,9 +330,8 @@ exports.prototype['background'] = undefined;
323330
/**
324331
* Place the title in one of nine predefined positions of the viewport. <ul> <li>`top` - top (center)</li> <li>`topRight` - top right</li> <li>`right` - right (center)</li> <li>`bottomRight` - bottom right</li> <li>`bottom` - bottom (center)</li> <li>`bottomLeft` - bottom left</li> <li>`left` - left (center)</li> <li>`topLeft` - top left</li> <li>`center` - center</li> </ul>
325332
* @member {module:model/TitleAsset.PositionEnum} position
326-
* @default 'center'
327333
*/
328-
exports.prototype['position'] = 'center';
334+
exports.prototype['position'] = undefined;
329335

330336
/**
331337
* @member {module:model/Offset} offset
@@ -367,16 +373,14 @@ exports.prototype['height'] = undefined;
367373
/**
368374
* Apply a background color behind the HTML bounding box using. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.
369375
* @member {String} background
370-
* @default 'transparent'
371376
*/
372-
exports.prototype['background'] = 'transparent';
377+
exports.prototype['background'] = undefined;
373378

374379
/**
375380
* Place the HTML in one of nine predefined positions within the HTML area. <ul> <li>`top` - top (center)</li> <li>`topRight` - top right</li> <li>`right` - right (center)</li> <li>`bottomRight` - bottom right</li> <li>`bottom` - bottom (center)</li> <li>`bottomLeft` - bottom left</li> <li>`left` - left (center)</li> <li>`topLeft` - top left</li> <li>`center` - center</li> </ul>
376381
* @member {module:model/HtmlAsset.PositionEnum} position
377-
* @default 'center'
378382
*/
379-
exports.prototype['position'] = 'center';
383+
exports.prototype['position'] = undefined;
380384

381385
// Implement AudioAsset interface:
382386
/**
@@ -401,9 +405,8 @@ exports.prototype['trim'] = undefined;
401405
/**
402406
* Set the volume for the audio clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
403407
* @member {Number} volume
404-
* @default 1
405408
*/
406-
exports.prototype['volume'] = 1;
409+
exports.prototype['volume'] = undefined;
407410

408411
/**
409412
* The effect to apply to the audio asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
@@ -734,6 +737,28 @@ exports.prototype['trim'] = undefined;
734737
}
735738

736739

740+
/**
741+
* Allowed values for the <code>volumeEffect</code> property.
742+
* @enum {String}
743+
* @readonly
744+
*/
745+
exports.VolumeEffectEnum = {
746+
/**
747+
* value: "fadeIn"
748+
* @const
749+
*/
750+
"fadeIn": "fadeIn",
751+
/**
752+
* value: "fadeOut"
753+
* @const
754+
*/
755+
"fadeOut": "fadeOut",
756+
/**
757+
* value: "fadeInFadeOut"
758+
* @const
759+
*/
760+
"fadeInFadeOut": "fadeInFadeOut" };
761+
737762
/**
738763
* Allowed values for the <code>style</code> property.
739764
* @enum {String}

‎src/model/AssetResponseAttributes.js‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,20 +45,14 @@
4545
* @class
4646
* @param id {String} The unique id of the hosted asset in UUID format.
4747
* @param owner {String} The owner id of the render task.
48-
* @param filename {String} The asset file name.
4948
* @param status {module:model/AssetResponseAttributes.StatusEnum} The status of the asset. <ul> <li>`importing` - the asset is being copied to the hosting service</li> <li>`ready` - the asset is ready to be served to users</li> <li>`failed` - the asset failed to copy or delete</li> <li>`deleted` - the asset has been deleted</li> </ul>
50-
* @param created {String} The time the asset was created.
51-
* @param updated {String} The time the asset status was last updated.
5249
*/
53-
var exports = function(id, owner, filename, status, created, updated) {
50+
var exports = function(id, owner, status) {
5451
var _this = this;
5552

5653
_this['id'] = id;
5754
_this['owner'] = owner;
58-
_this['filename'] = filename;
5955
_this['status'] = status;
60-
_this['created'] = created;
61-
_this['updated'] = updated;
6256
};
6357

6458
/**

‎src/model/AudioAsset.js‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,8 @@
101101
/**
102102
* Set the volume for the audio clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
103103
* @member {Number} volume
104-
* @default 1
105104
*/
106-
exports.prototype['volume'] = 1;
105+
exports.prototype['volume'] = undefined;
107106
/**
108107
* The effect to apply to the audio asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
109108
* @member {module:model/AudioAsset.EffectEnum} effect

0 commit comments

Comments
 (0)