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

package/README.md

@@ -1,6 +1,6 @@
 # Dolby.io REST APIs
 
-Node.JS wrapper for the dolby.io REST [Communications](https://docs.dolby.io/communications-apis/reference/authentication-api) APIs.
+Node.JS wrapper for the dolby.io REST [Communications](https://docs.dolby.io/communications-apis/reference/authentication-api) and [Media](https://docs.dolby.io/media-processing/reference/media-enhance-overview) APIs.
 
 ## Install this project
 
@@ -10,7 +10,7 @@ Run the npm command to install the package `@dolbyio/dolbyio-rest-apis-client` i
 npm install @dolbyio/dolbyio-rest-apis-client --save
 ```
 
-## Examples
+## Communications Examples
 
 ### Authenticate
 
@@ -73,6 +73,23 @@ const conference = await dolbyio.communications.conference.createConference(jwt,
 console.log(`Conference created: ${conference.conferenceId}`);
 ```
 
+## Media Examples
+
+### Authenticate
+
+To get an access token, use the following code:
+
+```javascript
+const dolbyio = require('@dolbyio/dolbyio-rest-apis-client');
+
+const API_KEY = 'YOUR_API_KEY';
+const API_SECRET = 'YOUR_API_SECRET';
+
+const at = await dolbyio.media.platform.getAccessToken(API_KEY, API_SECRET);
+
+console.log(`Access Token: ${at.access_token}`);
+```
+
 ## Build this project
 
 To build the `dist` folder, run the command:

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 import * as communications from './communications';
-export { communications };
+import * as media from './media';
+export { communications, media };

package/dist/index.js

@@ -23,7 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.communications = void 0;
+exports.media = exports.communications = void 0;
 const communications = __importStar(require("./communications"));
 exports.communications = communications;
+const media = __importStar(require("./media"));
+exports.media = media;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AAE1C,wCAAc"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AAG1C,wCAAc;AAFvB,+CAAiC;AAER,sBAAK"}

package/dist/media/analyze.d.ts

@@ -0,0 +1,43 @@
+import JwtToken from './types/jwtToken';
+import { AnalyzeJob } from './types/analyze';
+/**
+ * Starts analyzing to learn about your media.
+ *
+ * The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
+ *
+ * This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
+ *
+ * There are additional optional parameters that can be provided to identify the type of content and additional loudness or validation requirements. See the samples for examples of what requests and responses look like.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-analyze-post
+ *
+ * Beta API
+ * This API is being made available as an early preview.
+ * If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
+ * https://dolby.io/contact
+ *
+ * Content Length
+ *
+ * Media content with duration less than 2 seconds will not be processed. The API will return an ERROR in this case.
+ *
+ * @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-analyze-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+export declare const start: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
+/**
+ * Gets Analyze Status.
+ *
+ * For a given job_id, this method will check the job status.
+ *
+ * When `status==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-analyze-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `AnalyzeJob` object through a `Promise`.
+ */
+export declare const getResults: (auth: string | JwtToken, jobId: string) => Promise<AnalyzeJob>;

package/dist/media/analyze.js

@@ -0,0 +1,82 @@
+"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 analyzing to learn about your media.
+ *
+ * The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
+ *
+ * This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
+ *
+ * There are additional optional parameters that can be provided to identify the type of content and additional loudness or validation requirements. See the samples for examples of what requests and responses look like.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-analyze-post
+ *
+ * Beta API
+ * This API is being made available as an early preview.
+ * If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
+ * https://dolby.io/contact
+ *
+ * Content Length
+ *
+ * Media content with duration less than 2 seconds will not be processed. The API will return an ERROR in this case.
+ *
+ * @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-analyze-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/analyze',
+        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 Analyze Status.
+ *
+ * For a given job_id, this method will check the job status.
+ *
+ * When `status==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-analyze-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `AnalyzeJob` object through a `Promise`.
+ */
+const getResults = (auth, jobId) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/analyze',
+        params: {
+            job_id: jobId,
+        },
+        headers: {},
+        auth,
+    };
+    const response = yield (0, httpHelpers_1.sendGet)(requestOptions);
+    return response;
+});
+exports.getResults = getResults;
+//# sourceMappingURL=analyze.js.map

package/dist/media/analyze.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyze.js","sourceRoot":"","sources":["../../src/media/analyze.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAA+E;AAI/E;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;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/analyzeSpeech.d.ts

@@ -0,0 +1,37 @@
+import JwtToken from './types/jwtToken';
+import { AnalyzeSpeechJob } from './types/analyzeSpeech';
+/**
+ * Starts analyzing to learn about speech in your media.
+ *
+ * The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
+ *
+ * This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-analyze-speech-post
+ *
+ * Beta API
+ * This API is being made available as an early preview.
+ * If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
+ * https://dolby.io/contact
+ *
+ * @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-analyze-speech-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+export declare const start: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
+/**
+ * Gets Speech Analytics Status.
+ *
+ * For a given job_id, this method will check if the processing task has completed.
+ *
+ * When `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-analyze-speech-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `AnalyzeSpeechJob` object through a `Promise`.
+ */
+export declare const getResults: (auth: string | JwtToken, jobId: string) => Promise<AnalyzeSpeechJob>;

package/dist/media/analyzeSpeech.js

@@ -0,0 +1,76 @@
+"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 analyzing to learn about speech in your media.
+ *
+ * The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
+ *
+ * This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-analyze-speech-post
+ *
+ * Beta API
+ * This API is being made available as an early preview.
+ * If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
+ * https://dolby.io/contact
+ *
+ * @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-analyze-speech-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/analyze/speech',
+        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 Speech Analytics Status.
+ *
+ * For a given job_id, this method will check if the processing task has completed.
+ *
+ * When `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-analyze-speech-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `AnalyzeSpeechJob` object through a `Promise`.
+ */
+const getResults = (auth, jobId) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/analyze/speech',
+        params: {
+            job_id: jobId,
+        },
+        headers: {},
+        auth,
+    };
+    const response = yield (0, httpHelpers_1.sendGet)(requestOptions);
+    return response;
+});
+exports.getResults = getResults;
+//# sourceMappingURL=analyzeSpeech.js.map

package/dist/media/analyzeSpeech.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analyzeSpeech.js","sourceRoot":"","sources":["../../src/media/analyzeSpeech.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAA+E;AAI/E;;;;;;;;;;;;;;;;;;GAkBG;AACI,MAAM,KAAK,GAAG,CAAO,IAAuB,EAAE,UAAkB,EAA0B,EAAE;IAC/F,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,uBAAuB;QAC7B,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,EAA6B,EAAE;IAClG,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,uBAAuB;QAC7B,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,QAA4B,CAAC;AACxC,CAAC,CAAA,CAAC;AAbW,QAAA,UAAU,cAarB"}

package/dist/media/diagnose.d.ts

@@ -0,0 +1,39 @@
+import JwtToken from './types/jwtToken';
+import { DiagnoseJob } from './types/diagnose';
+/**
+ * Starts diagnosing to learn about the audio quality of your media.
+ *
+ * The `input` location of your source media file is required.
+ *
+ * This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-diagnose-post
+ *
+ * Beta API
+ * This API is being made available as an early preview.
+ * If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
+ * https://dolby.io/contact
+ *
+ * @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-diagnose-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+export declare const start: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
+/**
+ * Gets Diagnose Results.
+ *
+ * For a given job_id, this method will check if the processing task has completed.
+ *
+ * The `progress` attribute provides a percentage of job progress.
+ *
+ * If the `status` is Success then the json result will be returned in the response.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-diagnose-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `DiagnoseJob` object through a `Promise`.
+ */
+export declare const getResults: (auth: string | JwtToken, jobId: string) => Promise<DiagnoseJob>;

package/dist/media/diagnose.js

@@ -0,0 +1,78 @@
+"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 diagnosing to learn about the audio quality of your media.
+ *
+ * The `input` location of your source media file is required.
+ *
+ * This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-diagnose-post
+ *
+ * Beta API
+ * This API is being made available as an early preview.
+ * If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
+ * https://dolby.io/contact
+ *
+ * @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-diagnose-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/diagnose',
+        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 Diagnose Results.
+ *
+ * For a given job_id, this method will check if the processing task has completed.
+ *
+ * The `progress` attribute provides a percentage of job progress.
+ *
+ * If the `status` is Success then the json result will be returned in the response.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-diagnose-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `DiagnoseJob` object through a `Promise`.
+ */
+const getResults = (auth, jobId) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/diagnose',
+        params: {
+            job_id: jobId,
+        },
+        headers: {},
+        auth,
+    };
+    const response = yield (0, httpHelpers_1.sendGet)(requestOptions);
+    return response;
+});
+exports.getResults = getResults;
+//# sourceMappingURL=diagnose.js.map

package/dist/media/diagnose.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnose.js","sourceRoot":"","sources":["../../src/media/diagnose.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAA+E;AAI/E;;;;;;;;;;;;;;;;;;GAkBG;AACI,MAAM,KAAK,GAAG,CAAO,IAAuB,EAAE,UAAkB,EAA0B,EAAE;IAC/F,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,iBAAiB;QACvB,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;;;;;;;;;;;;;;;GAeG;AACI,MAAM,UAAU,GAAG,CAAO,IAAuB,EAAE,KAAa,EAAwB,EAAE;IAC7F,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,iBAAiB;QACvB,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,QAAuB,CAAC;AACnC,CAAC,CAAA,CAAC;AAbW,QAAA,UAAU,cAarB"}

package/dist/media/enhance.d.ts

@@ -0,0 +1,34 @@
+import JwtToken from './types/jwtToken';
+import { EnhanceJob } from './types/enhance';
+/**
+ * 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`.
+ */
+export declare const start: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
+/**
+ * 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`.
+ */
+export declare const getResults: (auth: string | JwtToken, jobId: string) => Promise<EnhanceJob>;

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,10 @@
+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 transcode from './transcode';
+import * as platform from './platform';
+import * as webhooks from './webhooks';
+export { analyze, analyzeSpeech, diagnose, enhance, io, jobs, transcode, platform, webhooks };

package/dist/media/index.js

@@ -0,0 +1,45 @@
+"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.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 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;AAU5B,0BAAO;AAThB,+DAAiD;AAS/B,sCAAa;AAR/B,qDAAuC;AAQN,4BAAQ;AAPzC,mDAAqC;AAOM,0BAAO;AANlD,yCAA2B;AAMyB,gBAAE;AALtD,6CAA+B;AAKyB,oBAAI;AAJ5D,uDAAyC;AAIqB,8BAAS;AAHvE,qDAAuC;AAGkC,4BAAQ;AAFjF,qDAAuC;AAE4C,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<unknown>;
+/**
+ * Sends a POST request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+export declare const sendPost: (options: AuthRequestOptions) => Promise<unknown>;
+/**
+ * Sends a PUT request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+export declare const sendPut: (options: AuthRequestOptions) => Promise<unknown>;
+/**
+ * Sends a DELETE request.
+ *
+ * @param options Request options.
+ *
+ * @returns A JSON payload object through a Promise.
+ */
+export declare const sendDelete: (options: AuthRequestOptions) => Promise<unknown>;
+/**
+ * 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>;