@dolbyio/dolbyio-rest-apis-client 1.1.0 → 2.1.2

package/dist/media/enhance.js

@@ -0,0 +1,73 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResults = exports.start = void 0;
+const httpHelpers_1 = require("./internal/httpHelpers");
+/**
+ * Starts enhancing to improve your media.
+ *
+ * The input location for your source media file as well as the output location for the processed result are required.
+ *
+ * This is an asynchronous operation so you will receive a job_id where you can retrieve the results when enhancement is complete.
+ *
+ * There are additional optional parameters that can be provided to control and select the type of enhancements made. See the samples for some examples of what requests and responses look like.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-enhance-post
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-enhance-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+const start = (auth, jobContent) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/enhance',
+        headers: {},
+        auth,
+        body: jobContent,
+    };
+    const response = yield (0, httpHelpers_1.sendPost)(requestOptions);
+    if (response.hasOwnProperty('job_id')) {
+        return response['job_id'];
+    }
+    return null;
+});
+exports.start = start;
+/**
+ * Gets Enhance Results
+ *
+ * For a given job_id, this method will check if the processing task has completed and return the enhanced results.
+ *
+ * When the status is Success you'll be able to retrieve your result from the output location you provided in the original POST.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-enhance-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `EnhanceJob` object through a `Promise`.
+ */
+const getResults = (auth, jobId) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/enhance',
+        params: {
+            job_id: jobId,
+        },
+        headers: {},
+        auth,
+    };
+    const response = yield (0, httpHelpers_1.sendGet)(requestOptions);
+    return response;
+});
+exports.getResults = getResults;
+//# sourceMappingURL=enhance.js.map

package/dist/media/enhance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enhance.js","sourceRoot":"","sources":["../../src/media/enhance.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAA+E;AAI/E;;;;;;;;;;;;;;;GAeG;AACI,MAAM,KAAK,GAAG,CAAO,IAAuB,EAAE,UAAkB,EAA0B,EAAE;IAC/F,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,EAAE;QACX,IAAI;QACJ,IAAI,EAAE,UAAU;KACnB,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAQ,EAAC,cAAc,CAAC,CAAC;IAChD,IAAI,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QACnC,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAC7B;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAA,CAAC;AAfW,QAAA,KAAK,SAehB;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,UAAU,GAAG,CAAO,IAAuB,EAAE,KAAa,EAAuB,EAAE;IAC5F,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,gBAAgB;QACtB,MAAM,EAAE;YACJ,MAAM,EAAE,KAAK;SAChB;QACD,OAAO,EAAE,EAAE;QACX,IAAI;KACP,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,qBAAO,EAAC,cAAc,CAAC,CAAC;IAC/C,OAAO,QAAsB,CAAC;AAClC,CAAC,CAAA,CAAC;AAbW,QAAA,UAAU,cAarB"}

package/dist/media/index.d.ts

@@ -0,0 +1,11 @@
+import * as analyze from './analyze';
+import * as analyzeSpeech from './analyzeSpeech';
+import * as diagnose from './diagnose';
+import * as enhance from './enhance';
+import * as io from './io';
+import * as jobs from './jobs';
+import * as mastering from './mastering';
+import * as transcode from './transcode';
+import * as platform from './platform';
+import * as webhooks from './webhooks';
+export { analyze, analyzeSpeech, diagnose, enhance, io, jobs, mastering, transcode, platform, webhooks };

package/dist/media/index.js

@@ -0,0 +1,47 @@
+"use strict";
+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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webhooks = exports.platform = exports.transcode = exports.mastering = exports.jobs = exports.io = exports.enhance = exports.diagnose = exports.analyzeSpeech = exports.analyze = void 0;
+const analyze = __importStar(require("./analyze"));
+exports.analyze = analyze;
+const analyzeSpeech = __importStar(require("./analyzeSpeech"));
+exports.analyzeSpeech = analyzeSpeech;
+const diagnose = __importStar(require("./diagnose"));
+exports.diagnose = diagnose;
+const enhance = __importStar(require("./enhance"));
+exports.enhance = enhance;
+const io = __importStar(require("./io"));
+exports.io = io;
+const jobs = __importStar(require("./jobs"));
+exports.jobs = jobs;
+const mastering = __importStar(require("./mastering"));
+exports.mastering = mastering;
+const transcode = __importStar(require("./transcode"));
+exports.transcode = transcode;
+const platform = __importStar(require("./platform"));
+exports.platform = platform;
+const webhooks = __importStar(require("./webhooks"));
+exports.webhooks = webhooks;
+//# sourceMappingURL=index.js.map

package/dist/media/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/media/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAqC;AAW5B,0BAAO;AAVhB,+DAAiD;AAU/B,sCAAa;AAT/B,qDAAuC;AASN,4BAAQ;AARzC,mDAAqC;AAQM,0BAAO;AAPlD,yCAA2B;AAOyB,gBAAE;AANtD,6CAA+B;AAMyB,oBAAI;AAL5D,uDAAyC;AAKqB,8BAAS;AAJvE,uDAAyC;AAIgC,8BAAS;AAHlF,qDAAuC;AAG6C,4BAAQ;AAF5F,qDAAuC;AAEuD,4BAAQ"}

package/dist/media/internal/httpHelpers.d.ts

@@ -0,0 +1,46 @@
+import * as httpHelpers from '../../internal/httpHelpers';
+import JwtToken from '../types/jwtToken';
+export interface AuthRequestOptions extends httpHelpers.RequestOptions {
+    auth: string | JwtToken;
+}
+/**
+ * Sends a GET request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+export declare const sendGet: (options: AuthRequestOptions) => Promise<any>;
+/**
+ * Sends a POST request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+export declare const sendPost: (options: AuthRequestOptions) => Promise<any>;
+/**
+ * Sends a PUT request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+export declare const sendPut: (options: AuthRequestOptions) => Promise<any>;
+/**
+ * Sends a DELETE request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+export declare const sendDelete: (options: AuthRequestOptions) => Promise<any>;
+/**
+ * Download a file.
+ *
+ * @param filepath Where to save the file.
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+export declare const download: (filepath: string, options: AuthRequestOptions) => Promise<void>;

package/dist/media/internal/httpHelpers.js

@@ -0,0 +1,114 @@
+"use strict";
+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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.download = exports.sendDelete = exports.sendPut = exports.sendPost = exports.sendGet = void 0;
+const httpHelpers = __importStar(require("../../internal/httpHelpers"));
+/**
+ * Sends a GET request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+const sendGet = (options) => {
+    if (typeof options.auth === 'string') {
+        options.headers['x-api-key'] = options.auth;
+    }
+    else {
+        options.headers['Authorization'] = `Bearer ${options.auth.access_token}`;
+    }
+    return httpHelpers.sendGet(options);
+};
+exports.sendGet = sendGet;
+/**
+ * Sends a POST request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+const sendPost = (options) => {
+    if (typeof options.auth === 'string') {
+        options.headers['x-api-key'] = options.auth;
+    }
+    else {
+        options.headers['Authorization'] = `Bearer ${options.auth.access_token}`;
+    }
+    return httpHelpers.sendPost(options);
+};
+exports.sendPost = sendPost;
+/**
+ * Sends a PUT request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+const sendPut = (options) => {
+    if (typeof options.auth === 'string') {
+        options.headers['x-api-key'] = options.auth;
+    }
+    else {
+        options.headers['Authorization'] = `Bearer ${options.auth.access_token}`;
+    }
+    return httpHelpers.sendPut(options);
+};
+exports.sendPut = sendPut;
+/**
+ * Sends a DELETE request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+const sendDelete = (options) => {
+    if (typeof options.auth === 'string') {
+        options.headers['x-api-key'] = options.auth;
+    }
+    else {
+        options.headers['Authorization'] = `Bearer ${options.auth.access_token}`;
+    }
+    return httpHelpers.sendDelete(options);
+};
+exports.sendDelete = sendDelete;
+/**
+ * Download a file.
+ *
+ * @param filepath Where to save the file.
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+const download = (filepath, options) => {
+    if (typeof options.auth === 'string') {
+        options.headers['x-api-key'] = options.auth;
+    }
+    else {
+        options.headers['Authorization'] = `Bearer ${options.auth.access_token}`;
+    }
+    return httpHelpers.download(filepath, options);
+};
+exports.download = download;
+//# sourceMappingURL=httpHelpers.js.map

package/dist/media/internal/httpHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpHelpers.js","sourceRoot":"","sources":["../../../src/media/internal/httpHelpers.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wEAA0D;AAO1D;;;;;;GAMG;AACI,MAAM,OAAO,GAAG,CAAC,OAA2B,EAAE,EAAE;IACnD,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;QAClC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;KAC/C;SAAM;QACH,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;KAC5E;IAED,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACxC,CAAC,CAAC;AARW,QAAA,OAAO,WAQlB;AAEF;;;;;;GAMG;AACI,MAAM,QAAQ,GAAG,CAAC,OAA2B,EAAE,EAAE;IACpD,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;QAClC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;KAC/C;SAAM;QACH,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;KAC5E;IAED,OAAO,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACzC,CAAC,CAAC;AARW,QAAA,QAAQ,YAQnB;AAEF;;;;;;GAMG;AACI,MAAM,OAAO,GAAG,CAAC,OAA2B,EAAE,EAAE;IACnD,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;QAClC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;KAC/C;SAAM;QACH,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;KAC5E;IAED,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACxC,CAAC,CAAC;AARW,QAAA,OAAO,WAQlB;AAEF;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,CAAC,OAA2B,EAAE,EAAE;IACtD,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;QAClC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;KAC/C;SAAM;QACH,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;KAC5E;IAED,OAAO,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;AAC3C,CAAC,CAAC;AARW,QAAA,UAAU,cAQrB;AAEF;;;;;;;GAOG;AACI,MAAM,QAAQ,GAAG,CAAC,QAAgB,EAAE,OAA2B,EAAE,EAAE;IACtE,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;QAClC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;KAC/C;SAAM;QACH,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;KAC5E;IAED,OAAO,WAAW,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACnD,CAAC,CAAC;AARW,QAAA,QAAQ,YAQnB"}

package/dist/media/io.d.ts

@@ -0,0 +1,32 @@
+import JwtToken from './types/jwtToken';
+/**
+ * Starts Media Input
+ *
+ * To use the Dolby provided temporary storage is a two step process.
+ *
+ * You start by declaring a dlb:// url that you can reference in any other Media API calls. The response will provide a url where you can put your media. This allows you to use the dlb:// url as a short-cut for a temporary storage location.
+ *
+ * You'll be returned a pre-signed url you can use to PUT and upload your media file. The temporary storage should allow you to read and write to the dlb:// locations for a period of at least 24 hours before it is removed.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-input
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
+ *
+ * @returns The upload URL through a `Promise`.
+ */
+export declare const getUploadUrl: (auth: string | JwtToken, dlbUrl: string) => Promise<string | null>;
+/**
+ * Starts Media Download
+ *
+ * You can download media you previously uploaded with /media/input or media that was generated through another Dolby Media API.
+ *
+ * The temporary storage should allow you to read and write to the dlb:// locations for a period of at least 24 hours before it is removed.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-output-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
+ * @param filePath Local file path where to download the file to.
+ */
+export declare const downloadFile: (auth: string | JwtToken, dlbUrl: string, filePath: string) => Promise<void>;

package/dist/media/io.js

@@ -0,0 +1,74 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadFile = exports.getUploadUrl = void 0;
+const httpHelpers_1 = require("./internal/httpHelpers");
+/**
+ * Starts Media Input
+ *
+ * To use the Dolby provided temporary storage is a two step process.
+ *
+ * You start by declaring a dlb:// url that you can reference in any other Media API calls. The response will provide a url where you can put your media. This allows you to use the dlb:// url as a short-cut for a temporary storage location.
+ *
+ * You'll be returned a pre-signed url you can use to PUT and upload your media file. The temporary storage should allow you to read and write to the dlb:// locations for a period of at least 24 hours before it is removed.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-input
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
+ *
+ * @returns The upload URL through a `Promise`.
+ */
+const getUploadUrl = (auth, dlbUrl) => __awaiter(void 0, void 0, void 0, function* () {
+    const payload = {
+        url: dlbUrl,
+    };
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/input',
+        headers: {},
+        auth,
+        body: JSON.stringify(payload, null, '  '),
+    };
+    const response = yield (0, httpHelpers_1.sendPost)(requestOptions);
+    if (response.hasOwnProperty('url')) {
+        return response['url'];
+    }
+    return null;
+});
+exports.getUploadUrl = getUploadUrl;
+/**
+ * Starts Media Download
+ *
+ * You can download media you previously uploaded with /media/input or media that was generated through another Dolby Media API.
+ *
+ * The temporary storage should allow you to read and write to the dlb:// locations for a period of at least 24 hours before it is removed.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-output-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
+ * @param filePath Local file path where to download the file to.
+ */
+const downloadFile = (auth, dlbUrl, filePath) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/output',
+        params: {
+            url: dlbUrl,
+        },
+        headers: {},
+        auth,
+    };
+    (0, httpHelpers_1.download)(filePath, requestOptions);
+});
+exports.downloadFile = downloadFile;
+//# sourceMappingURL=io.js.map

package/dist/media/io.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"io.js","sourceRoot":"","sources":["../../src/media/io.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAAgF;AAGhF;;;;;;;;;;;;;;;GAeG;AACI,MAAM,YAAY,GAAG,CAAO,IAAuB,EAAE,MAAc,EAA0B,EAAE;IAClG,MAAM,OAAO,GAAG;QACZ,GAAG,EAAE,MAAM;KACd,CAAC;IAEF,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,cAAc;QACpB,OAAO,EAAE,EAAE;QACX,IAAI;QACJ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC;KAC5C,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAQ,EAAC,cAAc,CAAC,CAAC;IAChD,IAAI,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE;QAChC,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;KAC1B;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAA,CAAC;AAnBW,QAAA,YAAY,gBAmBvB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,YAAY,GAAG,CAAO,IAAuB,EAAE,MAAc,EAAE,QAAgB,EAAiB,EAAE;IAC3G,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,eAAe;QACrB,MAAM,EAAE;YACJ,GAAG,EAAE,MAAM;SACd;QACD,OAAO,EAAE,EAAE;QACX,IAAI;KACP,CAAC;IAEF,IAAA,sBAAQ,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;AACvC,CAAC,CAAA,CAAC;AAZW,QAAA,YAAY,gBAYvB"}

package/dist/media/jobs.d.ts

@@ -0,0 +1,35 @@
+import JwtToken from './types/jwtToken';
+import { ListJobsOptions, ListAllJobsOptions, JobsResponse, Job } from './types/jobs';
+/**
+ * Query Media Jobs.
+ * List of jobs previously submitted, up to the last 31 days.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-jobs-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param options Options to request the list of jobs.
+ *
+ * @returns A `JobsResponse` object through a `Promise`.
+ */
+export declare const list: (auth: string | JwtToken, options: ListJobsOptions) => Promise<JobsResponse>;
+/**
+ * Query Media Jobs.
+ * List of all jobs previously submitted, up to the last 31 days.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-jobs-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param options Options to request the list of jobs.
+ *
+ * @returns An array of `Job` objects through a `Promise`.
+ */
+export declare const listAll: (auth: string | JwtToken, options: ListAllJobsOptions) => Promise<Array<Job>>;
+/**
+ * Requests cancellation of a previously submitted job.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-jobs-cancel-post
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to cancel.
+ */
+export declare const cancel: (auth: string | JwtToken, jobId: string) => Promise<void>;

package/dist/media/jobs.js

@@ -0,0 +1,116 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancel = exports.listAll = exports.list = void 0;
+const httpHelpers_1 = require("./internal/httpHelpers");
+/**
+ * Query Media Jobs.
+ * List of jobs previously submitted, up to the last 31 days.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-jobs-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param options Options to request the list of jobs.
+ *
+ * @returns A `JobsResponse` object through a `Promise`.
+ */
+const list = (auth, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const params = {};
+    if (options.submitted_after) {
+        params['submitted_after'] = options.submitted_after;
+    }
+    if (options.submitted_before) {
+        params['submitted_before'] = options.submitted_before;
+    }
+    if (options.status) {
+        params['status'] = options.status;
+    }
+    if (options.next_token) {
+        params['next_token'] = options.next_token;
+    }
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/jobs',
+        params,
+        headers: {},
+        auth,
+    };
+    const response = yield (0, httpHelpers_1.sendGet)(requestOptions);
+    return response;
+});
+exports.list = list;
+/**
+ * Query Media Jobs.
+ * List of all jobs previously submitted, up to the last 31 days.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-jobs-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param options Options to request the list of jobs.
+ *
+ * @returns An array of `Job` objects through a `Promise`.
+ */
+const listAll = (auth, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const params = {};
+    if (options.submitted_after) {
+        params['submitted_after'] = options.submitted_after;
+    }
+    if (options.submitted_before) {
+        params['submitted_before'] = options.submitted_before;
+    }
+    if (options.status) {
+        params['status'] = options.status;
+    }
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/jobs',
+        headers: {},
+        auth,
+    };
+    const result = [];
+    do {
+        requestOptions.params = params;
+        const response = (yield (0, httpHelpers_1.sendGet)(requestOptions));
+        for (let index = 0; index < response.jobs.length; index++) {
+            const object = response.jobs[index];
+            result.push(object);
+        }
+        if (!response.next_token || response.next_token.length <= 0) {
+            break;
+        }
+        params['next_token'] = response.next_token;
+    } while (true);
+    return result;
+});
+exports.listAll = listAll;
+/**
+ * Requests cancellation of a previously submitted job.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-jobs-cancel-post
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to cancel.
+ */
+const cancel = (auth, jobId) => __awaiter(void 0, void 0, void 0, function* () {
+    const params = {
+        job_id: jobId,
+    };
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/jobs/cancel',
+        headers: {},
+        auth,
+        params: params,
+    };
+    yield (0, httpHelpers_1.sendPost)(requestOptions);
+});
+exports.cancel = cancel;
+//# sourceMappingURL=jobs.js.map

package/dist/media/jobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../src/media/jobs.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAA+E;AAI/E;;;;;;;;;;GAUG;AACI,MAAM,IAAI,GAAG,CAAO,IAAuB,EAAE,OAAwB,EAAyB,EAAE;IACnG,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI,OAAO,CAAC,eAAe,EAAE;QACzB,MAAM,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;KACvD;IACD,IAAI,OAAO,CAAC,gBAAgB,EAAE;QAC1B,MAAM,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC;KACzD;IACD,IAAI,OAAO,CAAC,MAAM,EAAE;QAChB,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;KACrC;IACD,IAAI,OAAO,CAAC,UAAU,EAAE;QACpB,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;KAC7C;IAED,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,aAAa;QACnB,MAAM;QACN,OAAO,EAAE,EAAE;QACX,IAAI;KACP,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,qBAAO,EAAC,cAAc,CAAC,CAAC;IAC/C,OAAO,QAAwB,CAAC;AACpC,CAAC,CAAA,CAAC;AAzBW,QAAA,IAAI,QAyBf;AAEF;;;;;;;;;;GAUG;AACI,MAAM,OAAO,GAAG,CAAO,IAAuB,EAAE,OAA2B,EAAuB,EAAE;IACvG,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,IAAI,OAAO,CAAC,eAAe,EAAE;QACzB,MAAM,CAAC,iBAAiB,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC;KACvD;IACD,IAAI,OAAO,CAAC,gBAAgB,EAAE;QAC1B,MAAM,CAAC,kBAAkB,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC;KACzD;IACD,IAAI,OAAO,CAAC,MAAM,EAAE;QAChB,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;KACrC;IAED,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,EAAE;QACX,IAAI;KACP,CAAC;IAEF,MAAM,MAAM,GAAe,EAAE,CAAC;IAE9B,GAAG;QACC,cAAc,CAAC,MAAM,GAAG,MAAM,CAAC;QAE/B,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAA,qBAAO,EAAC,cAAc,CAAC,CAAiB,CAAC;QAEjE,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACvD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SACvB;QAED,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,EAAE;YACzD,MAAM;SACT;QAED,MAAM,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC;KAC9C,QAAQ,IAAI,EAAE;IAEf,OAAO,MAAM,CAAC;AAClB,CAAC,CAAA,CAAC;AAvCW,QAAA,OAAO,WAuClB;AAEF;;;;;;;GAOG;AACI,MAAM,MAAM,GAAG,CAAO,IAAuB,EAAE,KAAa,EAAiB,EAAE;IAClF,MAAM,MAAM,GAAG;QACX,MAAM,EAAE,KAAK;KAChB,CAAC;IAEF,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,oBAAoB;QAC1B,OAAO,EAAE,EAAE;QACX,IAAI;QACJ,MAAM,EAAE,MAAM;KACjB,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,cAAc,CAAC,CAAC;AACnC,CAAC,CAAA,CAAC;AAdW,QAAA,MAAM,UAcjB"}

package/dist/media/mastering.d.ts

@@ -0,0 +1,70 @@
+import JwtToken from './types/jwtToken';
+import { MasteringPreviewJob, MasteringJob } from './types/mastering';
+/**
+ * Starts mastering preview to improve your music.
+ *
+ * The `inputs` location for your source media file as well as the `outputs` location for the processed media file are required.
+ *
+ * A `preset` applies dynamic EQ processing to shape your music to match a desired sound. There are also additional optional parameters that can be provided to control the mastering output.
+ *
+ * A `segment` object specifying preview `start` may optionally be provided.
+ *
+ * This is an asynchronous operation. You receive a `job_id` that you use to retrieve the results when the mastering is complete.
+ *
+ * To learn more, see the example requests and responses.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+export declare const startPreview: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
+/**
+ * Gets Mastering Preview Results
+ *
+ * For a given job_id, this method will check if the mastering task has completed.
+ * When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-preview-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `MasteringPreviewJob` object through a `Promise`.
+ */
+export declare const getPreviewResults: (auth: string | JwtToken, jobId: string) => Promise<MasteringPreviewJob>;
+/**
+ * Starts mastering to improve your music.
+ *
+ * The `inputs` location for your source media file as well as the `outputs` location for the processed media file are required.
+ *
+ * A `preset` applies dynamic EQ processing to shape your music to match a desired sound. There are also additional optional parameters that can be provided to control the mastering output.
+ *
+ * This is an asynchronous operation. You receive a `job_id` that you use to retrieve the results when the mastering is complete.
+ *
+ * To learn more, see the example requests and responses.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+export declare const start: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
+/**
+ * Gets Mastering Results
+ *
+ * For a given job_id, this method will check if the mastering task has completed.
+ * When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `MasteringJob` object through a `Promise`.
+ */
+export declare const getResults: (auth: string | JwtToken, jobId: string) => Promise<MasteringJob>;