Skip to content

Commit e1a04ee

Browse files
committed
Add diska nd cache settings plus copy updates
1 parent 734a410 commit e1a04ee

27 files changed

Lines changed: 115 additions & 53 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.0.21",
3+
"version": "0.0.22",
44
"description": "Official Node SDK for the Shotstack Cloud Video Editing API",
55
"license": "MIT",
66
"main": "src/index.js",

‎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-
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
3+
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
44
*
55
* The version of the OpenAPI document: v1
66
*

‎src/api/EndpointsApi.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
3+
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
44
*
55
* The version of the OpenAPI document: v1
66
*

‎src/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
3+
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
44
*
55
* The version of the OpenAPI document: v1
66
*

‎src/model/AudioAsset.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
3+
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
44
*
55
* The version of the OpenAPI document: v1
66
*

‎src/model/Clip.js‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
3+
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
44
*
55
* The version of the OpenAPI document: v1
66
*
@@ -476,11 +476,6 @@
476476
* @readonly
477477
*/
478478
exports.FilterEnum = {
479-
/**
480-
* value: "blur"
481-
* @const
482-
*/
483-
"blur": "blur",
484479
/**
485480
* value: "boost"
486481
* @const

‎src/model/Crop.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
3+
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
44
*
55
* The version of the OpenAPI document: v1
66
*

‎src/model/Edit.js‎

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
3+
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
44
*
55
* The version of the OpenAPI document: v1
66
*
@@ -72,6 +72,9 @@
7272
if (data.hasOwnProperty('callback')) {
7373
obj['callback'] = ApiClient.convertToType(data['callback'], 'String');
7474
}
75+
if (data.hasOwnProperty('disk')) {
76+
obj['disk'] = ApiClient.convertToType(data['disk'], 'String');
77+
}
7578
}
7679
return obj;
7780
}
@@ -85,10 +88,16 @@
8588
*/
8689
exports.prototype['output'] = undefined;
8790
/**
88-
* An optional webhook callback URL used to receive status notifications when a render completes or fails.
91+
* An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details.
8992
* @member {String} callback
9093
*/
9194
exports.prototype['callback'] = undefined;
95+
/**
96+
* The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimised for high speed rendering with up to 512MB storage</li> <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
97+
* @member {module:model/Edit.DiskEnum} disk
98+
* @default 'local'
99+
*/
100+
exports.prototype['disk'] = 'local';
92101

93102

94103
/**
@@ -124,23 +133,57 @@
124133

125134

126135
/**
127-
* Returns An optional webhook callback URL used to receive status notifications when a render completes or fails.
136+
* Returns An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details.
128137
* @return {String}
129138
*/
130139
exports.prototype.getCallback = function() {
131140
return this['callback'];
132141
}
133142

134143
/**
135-
* Sets An optional webhook callback URL used to receive status notifications when a render completes or fails.
136-
* @param {String} callback An optional webhook callback URL used to receive status notifications when a render completes or fails.
144+
* Sets An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details.
145+
* @param {String} callback An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for more details.
137146
*/
138147
exports.prototype.setCallback = function(callback) {
139148
this['callback'] = callback;
140149
return this;
141150
}
142151

143152

153+
/**
154+
* Returns The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimised for high speed rendering with up to 512MB storage</li> <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
155+
* @return {module:model/Edit.DiskEnum}
156+
*/
157+
exports.prototype.getDisk = function() {
158+
return this['disk'];
159+
}
160+
161+
/**
162+
* Sets The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimised for high speed rendering with up to 512MB storage</li> <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
163+
* @param {module:model/Edit.DiskEnum} disk The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul> <li>`local` - optimised for high speed rendering with up to 512MB storage</li> <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
164+
*/
165+
exports.prototype.setDisk = function(disk) {
166+
this['disk'] = disk;
167+
}
168+
169+
170+
/**
171+
* Allowed values for the <code>disk</code> property.
172+
* @enum {String}
173+
* @readonly
174+
*/
175+
exports.DiskEnum = {
176+
/**
177+
* value: "local"
178+
* @const
179+
*/
180+
"local": "local",
181+
/**
182+
* value: "mount"
183+
* @const
184+
*/
185+
"mount": "mount" };
186+
144187

145188
return exports;
146189
}));

‎src/model/Font.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
3+
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
44
*
55
* The version of the OpenAPI document: v1
66
*
@@ -40,7 +40,7 @@
4040

4141
/**
4242
* Constructs a new <code>Font</code>.
43-
* Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag.
43+
* Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag. See our [custom fonts](https://shotstack.io/learn/html-custom-fonts/) getting started guide for more details.
4444
* @alias module:model/Font
4545
* @class
4646
* @param src {String} The URL of the font file. The URL must be publicly accessible or include credentials.

‎src/model/HtmlAsset.js‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Shotstack
3-
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
3+
* The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
44
*
55
* The version of the OpenAPI document: v1
66
*
@@ -44,7 +44,7 @@
4444
* @alias module:model/HtmlAsset
4545
* @class
4646
* @param type {String} The type of asset - set to `html` for HTML.
47-
* @param html {String} The HTML text string.
47+
* @param html {String} The HTML text string. See list of [supported HTML tags](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
4848
*/
4949
var exports = function(type, html) {
5050
var _this = this;
@@ -95,12 +95,12 @@
9595
*/
9696
exports.prototype['type'] = 'html';
9797
/**
98-
* The HTML text string.
98+
* The HTML text string. See list of [supported HTML tags](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
9999
* @member {String} html
100100
*/
101101
exports.prototype['html'] = undefined;
102102
/**
103-
* The CSS text string to apply styling to the HTML.
103+
* The CSS text string to apply styling to the HTML. See list of [support CSS properties](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
104104
* @member {String} css
105105
*/
106106
exports.prototype['css'] = undefined;
@@ -147,16 +147,16 @@
147147

148148

149149
/**
150-
* Returns The HTML text string.
150+
* Returns The HTML text string. See list of [supported HTML tags](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
151151
* @return {String}
152152
*/
153153
exports.prototype.getHtml = function() {
154154
return this['html'];
155155
}
156156

157157
/**
158-
* Sets The HTML text string.
159-
* @param {String} html The HTML text string.
158+
* Sets The HTML text string. See list of [supported HTML tags](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
159+
* @param {String} html The HTML text string. See list of [supported HTML tags](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
160160
*/
161161
exports.prototype.setHtml = function(html) {
162162
this['html'] = html;
@@ -165,16 +165,16 @@
165165

166166

167167
/**
168-
* Returns The CSS text string to apply styling to the HTML.
168+
* Returns The CSS text string to apply styling to the HTML. See list of [support CSS properties](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
169169
* @return {String}
170170
*/
171171
exports.prototype.getCss = function() {
172172
return this['css'];
173173
}
174174

175175
/**
176-
* Sets The CSS text string to apply styling to the HTML.
177-
* @param {String} css The CSS text string to apply styling to the HTML.
176+
* Sets The CSS text string to apply styling to the HTML. See list of [support CSS properties](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
177+
* @param {String} css The CSS text string to apply styling to the HTML. See list of [support CSS properties](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
178178
*/
179179
exports.prototype.setCss = function(css) {
180180
this['css'] = css;

0 commit comments

Comments
 (0)