@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
155 lines • 5.36 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const Utils = __importStar(require("@datocms/rest-client-utils"));
const BaseResource_1 = __importDefault(require("../../BaseResource"));
class UploadTrack extends BaseResource_1.default {
/**
* Create a new upload track
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/create
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
create(uploadId, body) {
return this.rawCreate(Utils.toId(uploadId), Utils.serializeRequestBody(body, {
type: 'upload_track',
attributes: [
'url_or_upload_request_id',
'type',
'name',
'language_code',
'closed_captions',
],
relationships: [],
})).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Create a new upload track
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/create
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawCreate(uploadId, body) {
return this.client.request({
method: 'POST',
url: `/uploads/${uploadId}/tracks`,
body,
});
}
/**
* List upload tracks
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
list(uploadId) {
return this.rawList(Utils.toId(uploadId)).then((body) => Utils.deserializeResponseBody(body));
}
/**
* List upload tracks
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawList(uploadId) {
return this.client.request({
method: 'GET',
url: `/uploads/${uploadId}/tracks`,
});
}
/**
* Delete an upload track
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/destroy
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
destroy(uploadId, uploadTrackId) {
return this.rawDestroy(Utils.toId(uploadId), Utils.toId(uploadTrackId)).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Delete an upload track
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/destroy
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawDestroy(uploadId, uploadTrackId) {
return this.client.request({
method: 'DELETE',
url: `/uploads/${uploadId}/tracks/${uploadTrackId}`,
});
}
/**
* Automatically generate a subtitles track
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/generate_subtitles
*
* @throws {ApiError}
* @throws {TimeoutError}
*
* @deprecated This API call is to be considered private and might change without notice
*/
generateSubtitles(uploadId, body) {
return this.rawGenerateSubtitles(Utils.toId(uploadId), Utils.serializeRequestBody(body, {
type: 'upload_track',
attributes: ['name', 'language_code'],
relationships: [],
})).then((body) => Utils.deserializeResponseBody(body));
}
/**
* Automatically generate a subtitles track
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload-track/generate_subtitles
*
* @throws {ApiError}
* @throws {TimeoutError}
*
* @deprecated This API call is to be considered private and might change without notice
*/
rawGenerateSubtitles(uploadId, body) {
return this.client.request({
method: 'POST',
url: `/uploads/${uploadId}/tracks/generate-subtitles`,
body,
});
}
}
exports.default = UploadTrack;
UploadTrack.TYPE = 'upload_track';
//# sourceMappingURL=UploadTrack.js.map