@dolbyio/dolbyio-rest-apis-client 3.6.0 → 4.0.0

package/dist/communications/monitor/recordings.d.ts

@@ -1,10 +1,13 @@
 import JwtToken from '../../types/jwtToken';
-import { GetRecordingsOptions, GetAllRecordingsOptions, GetRecordingsResponse, Recording, GetRecordingOptions, DolbyVoiceRecording } from '../types/recordings';
+import { GetRecordingsOptions, GetAllRecordingsOptions, GetRecordingsResponse, Recording, GetConferenceRecordingsOptions, GetAllConferenceRecordingsOptions, GetConferenceRecordingsResponse } from '../types/recordings';
 /**
  * Get a list of the recorded conference metadata, such as duration or size of the recording.
  * This API checks only the recordings that have ended during a specific time range.
  * Recordings are indexed based on the ending time.
  *
+ * This API returns presigned URLs for secure download of the recording files.
+ * The URL returned in the response is an AWS S3 presigned URL with a validity of ten minutes.
+ *
  * @link https://docs.dolby.io/communications-apis/reference/get-recordings
  *
  * @param accessToken Access token to use for authentication.
@@ -18,6 +21,9 @@ export declare const getRecordings: (accessToken: JwtToken, options: GetRecordin
  * This API checks only the recordings that have ended during a specific time range.
  * Recordings are indexed based on the ending time.
  *
+ * This API returns presigned URLs for secure download of the recording files.
+ * The URL returned in the response is an AWS S3 presigned URL with a validity of ten minutes.
+ *
  * @link https://docs.dolby.io/communications-apis/reference/get-recordings
  *
  * @param accessToken Access token to use for authentication.
@@ -31,34 +37,41 @@ export declare const getAllRecordings: (accessToken: JwtToken, options: GetAllRe
  * This API checks the recordings that have ended during a specific time range.
  * Recordings are indexed based on the ending time.
  *
+ * This API returns presigned URLs for secure download of the recording files.
+ * The URL returned in the response is an AWS S3 presigned URL with a validity of ten minutes.
+ *
  * @link https://docs.dolby.io/communications-apis/reference/get-conference-recordings
  *
  * @param accessToken Access token to use for authentication.
- * @param options Options to request the recording.
+ * @param options Options to request the recordings.
  *
- * @returns An array of {@link Recording} objects through a {@link Promise}.
+ * @returns A {@link GetConferenceRecordingsResponse} object through a {@link Promise}.
  */
-export declare const getRecording: (accessToken: JwtToken, options: GetRecordingOptions) => Promise<Array<Recording>>;
+export declare const getConferenceRecordings: (accessToken: JwtToken, options: GetConferenceRecordingsOptions) => Promise<GetConferenceRecordingsResponse>;
 /**
- * Delete all recording data related to a specific conference.
+ * Get a list of the recorded conference metadata, such as duration or size of the recording.
+ * This API checks only the recordings that have ended during a specific time range.
+ * Recordings are indexed based on the ending time.
  *
- * **Warning**: After deleting the recording, it is not possible to restore the recording data.
+ * This API returns presigned URLs for secure download of the recording files.
+ * The URL returned in the response is an AWS S3 presigned URL with a validity of ten minutes.
  *
- * @link https://docs.dolby.io/communications-apis/reference/delete-conference-recordings
+ * @link https://docs.dolby.io/communications-apis/reference/get-conference-recordings
  *
  * @param accessToken Access token to use for authentication.
- * @param confId Identifier of the conference.
+ * @param options Options to request the recordings.
+ *
+ * @returns An array of {@link Recording} objects through a {@link Promise}.
  */
-export declare const deleteRecording: (accessToken: JwtToken, confId: string) => Promise<void>;
+export declare const getAllConferenceRecordings: (accessToken: JwtToken, options: GetAllConferenceRecordingsOptions) => Promise<Array<Recording>>;
 /**
- * Get details of all Dolby Voice-based audio recordings, and associated split recordings,
- * for a given conference and download the conference recording in the MP3 audio format.
+ * Deletes all recording data related to a specific conference, even data downloaded using the v1 Monitor API.
  *
- * @link https://docs.dolby.io/communications-apis/reference/get-dolby-voice-audio-recordings
+ * **Warning**: After deleting the recording, it is not possible to restore the recording data.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/delete-conference-recordings
  *
  * @param accessToken Access token to use for authentication.
  * @param confId Identifier of the conference.
- *
- * @returns A {@link DolbyVoiceRecording} object through a {@link Promise}.
  */
-export declare const getDolbyVoiceRecording: (accessToken: JwtToken, confId: string) => Promise<DolbyVoiceRecording>;
+export declare const deleteRecording: (accessToken: JwtToken, confId: string) => Promise<void>;

package/dist/communications/monitor/recordings.js

@@ -4,10 +4,12 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getRecordings = exports.getRecording = exports.getDolbyVoiceRecording = exports.getAllRecordings = exports.deleteRecording = void 0;
+exports.getRecordings = exports.getConferenceRecordings = exports.getAllRecordings = exports.getAllConferenceRecordings = exports.deleteRecording = void 0;
 var _httpHelpers = require("../../internal/httpHelpers");
 var _httpHelpers2 = require("../internal/httpHelpers");
-var _urls = require("../internal/urls");
+var Urls = _interopRequireWildcard(require("../../urls"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator["return"] && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) keys.push(key); return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, "catch": function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
@@ -16,6 +18,9 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
  * This API checks only the recordings that have ended during a specific time range.
  * Recordings are indexed based on the ending time.
  *
+ * This API returns presigned URLs for secure download of the recording files.
+ * The URL returned in the response is an AWS S3 presigned URL with a validity of ten minutes.
+ *
  * @link https://docs.dolby.io/communications-apis/reference/get-recordings
  *
  * @param accessToken Access token to use for authentication.
@@ -40,24 +45,25 @@ var getRecordings = /*#__PURE__*/function () {
             to: opts.to.toString(),
             max: opts.max.toString()
           };
-          if (opts.start) {
-            params['start'] = opts.start;
-          }
+          if (opts.start) params['start'] = opts.start;
+          if (opts.region) params['region'] = opts.region;
+          if (opts.type) params['type'] = opts.type;
+          if (opts.mediaType) params['mediaType'] = opts.mediaType;
           requestOptions = {
-            hostname: _urls.COMMS_HOSTNAME,
-            path: '/v1/monitor/recordings',
+            hostname: Urls.getCommsHostname(),
+            path: '/v2/monitor/recordings',
             params: params,
             headers: {
               Accept: 'application/json',
               Authorization: "".concat(accessToken.token_type, " ").concat(accessToken.access_token)
             }
           };
-          _context.next = 7;
+          _context.next = 10;
           return (0, _httpHelpers.sendGet)(requestOptions);
-        case 7:
+        case 10:
           response = _context.sent;
           return _context.abrupt("return", response);
-        case 9:
+        case 12:
         case "end":
           return _context.stop();
       }
@@ -73,6 +79,9 @@ var getRecordings = /*#__PURE__*/function () {
  * This API checks only the recordings that have ended during a specific time range.
  * Recordings are indexed based on the ending time.
  *
+ * This API returns presigned URLs for secure download of the recording files.
+ * The URL returned in the response is an AWS S3 presigned URL with a validity of ten minutes.
+ *
  * @link https://docs.dolby.io/communications-apis/reference/get-recordings
  *
  * @param accessToken Access token to use for authentication.
@@ -98,20 +107,23 @@ var getAllRecordings = /*#__PURE__*/function () {
             to: opts.to.toString(),
             max: opts.page_size.toString()
           };
+          if (opts.region) params['region'] = opts.region;
+          if (opts.type) params['type'] = opts.type;
+          if (opts.mediaType) params['mediaType'] = opts.mediaType;
           requestOptions = {
-            hostname: _urls.COMMS_HOSTNAME,
-            path: '/v1/monitor/recordings',
+            hostname: Urls.getCommsHostname(),
+            path: '/v2/monitor/recordings',
             params: params,
             headers: {
               Accept: 'application/json',
               Authorization: "".concat(accessToken.token_type, " ").concat(accessToken.access_token)
             }
           };
-          _context2.next = 6;
+          _context2.next = 9;
           return (0, _httpHelpers2.getAll)(requestOptions, 'recordings');
-        case 6:
+        case 9:
           return _context2.abrupt("return", _context2.sent);
-        case 7:
+        case 10:
         case "end":
           return _context2.stop();
       }
@@ -127,15 +139,18 @@ var getAllRecordings = /*#__PURE__*/function () {
  * This API checks the recordings that have ended during a specific time range.
  * Recordings are indexed based on the ending time.
  *
+ * This API returns presigned URLs for secure download of the recording files.
+ * The URL returned in the response is an AWS S3 presigned URL with a validity of ten minutes.
+ *
  * @link https://docs.dolby.io/communications-apis/reference/get-conference-recordings
  *
  * @param accessToken Access token to use for authentication.
- * @param options Options to request the recording.
+ * @param options Options to request the recordings.
  *
- * @returns An array of {@link Recording} objects through a {@link Promise}.
+ * @returns A {@link GetConferenceRecordingsResponse} object through a {@link Promise}.
  */
 exports.getAllRecordings = getAllRecordings;
-var getRecording = /*#__PURE__*/function () {
+var getConferenceRecordings = /*#__PURE__*/function () {
   var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(accessToken, options) {
     var optionsDefault, opts, params, requestOptions, response;
     return _regeneratorRuntime().wrap(function _callee3$(_context3) {
@@ -144,7 +159,8 @@ var getRecording = /*#__PURE__*/function () {
           optionsDefault = {
             from: 0,
             to: 9999999999999,
-            max: 100
+            max: 100,
+            confId: ''
           };
           opts = Object.assign(optionsDefault, options);
           params = {
@@ -152,12 +168,10 @@ var getRecording = /*#__PURE__*/function () {
             to: opts.to.toString(),
             max: opts.max.toString()
           };
-          if (opts.start) {
-            params['start'] = opts.start;
-          }
+          if (opts.start) params['start'] = opts.start;
           requestOptions = {
-            hostname: _urls.COMMS_HOSTNAME,
-            path: "/v1/monitor/conferences/".concat(opts.confId, "/recordings"),
+            hostname: Urls.getCommsHostname(),
+            path: "/v2/monitor/conferences/".concat(opts.confId, "/recordings"),
             params: params,
             headers: {
               Accept: 'application/json',
@@ -168,95 +182,111 @@ var getRecording = /*#__PURE__*/function () {
           return (0, _httpHelpers.sendGet)(requestOptions);
         case 7:
           response = _context3.sent;
-          return _context3.abrupt("return", response.recordings);
+          return _context3.abrupt("return", response);
         case 9:
         case "end":
           return _context3.stop();
       }
     }, _callee3);
   }));
-  return function getRecording(_x5, _x6) {
+  return function getConferenceRecordings(_x5, _x6) {
     return _ref3.apply(this, arguments);
   };
 }();
 
 /**
- * Delete all recording data related to a specific conference.
+ * Get a list of the recorded conference metadata, such as duration or size of the recording.
+ * This API checks only the recordings that have ended during a specific time range.
+ * Recordings are indexed based on the ending time.
  *
- * **Warning**: After deleting the recording, it is not possible to restore the recording data.
+ * This API returns presigned URLs for secure download of the recording files.
+ * The URL returned in the response is an AWS S3 presigned URL with a validity of ten minutes.
  *
- * @link https://docs.dolby.io/communications-apis/reference/delete-conference-recordings
+ * @link https://docs.dolby.io/communications-apis/reference/get-conference-recordings
  *
  * @param accessToken Access token to use for authentication.
- * @param confId Identifier of the conference.
+ * @param options Options to request the recordings.
+ *
+ * @returns An array of {@link Recording} objects through a {@link Promise}.
  */
-exports.getRecording = getRecording;
-var deleteRecording = /*#__PURE__*/function () {
-  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(accessToken, confId) {
-    var requestOptions;
+exports.getConferenceRecordings = getConferenceRecordings;
+var getAllConferenceRecordings = /*#__PURE__*/function () {
+  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(accessToken, options) {
+    var optionsDefault, opts, params, requestOptions;
     return _regeneratorRuntime().wrap(function _callee4$(_context4) {
       while (1) switch (_context4.prev = _context4.next) {
         case 0:
+          optionsDefault = {
+            from: 0,
+            to: 9999999999999,
+            page_size: 100,
+            confId: ''
+          };
+          opts = Object.assign(optionsDefault, options);
+          params = {
+            from: opts.from.toString(),
+            to: opts.to.toString(),
+            max: opts.page_size.toString()
+          };
           requestOptions = {
-            hostname: _urls.COMMS_HOSTNAME,
-            path: "/v1/monitor/conferences/".concat(confId, "/recordings"),
+            hostname: Urls.getCommsHostname(),
+            path: "/v2/monitor/conferences/".concat(opts.confId, "/recordings"),
+            params: params,
             headers: {
               Accept: 'application/json',
               Authorization: "".concat(accessToken.token_type, " ").concat(accessToken.access_token)
             }
           };
-          _context4.next = 3;
-          return (0, _httpHelpers.sendDelete)(requestOptions);
-        case 3:
+          _context4.next = 6;
+          return (0, _httpHelpers2.getAll)(requestOptions, 'recordings');
+        case 6:
+          return _context4.abrupt("return", _context4.sent);
+        case 7:
         case "end":
           return _context4.stop();
       }
     }, _callee4);
   }));
-  return function deleteRecording(_x7, _x8) {
+  return function getAllConferenceRecordings(_x7, _x8) {
     return _ref4.apply(this, arguments);
   };
 }();
 
 /**
- * Get details of all Dolby Voice-based audio recordings, and associated split recordings,
- * for a given conference and download the conference recording in the MP3 audio format.
+ * Deletes all recording data related to a specific conference, even data downloaded using the v1 Monitor API.
+ *
+ * **Warning**: After deleting the recording, it is not possible to restore the recording data.
  *
- * @link https://docs.dolby.io/communications-apis/reference/get-dolby-voice-audio-recordings
+ * @link https://docs.dolby.io/communications-apis/reference/delete-conference-recordings
  *
  * @param accessToken Access token to use for authentication.
  * @param confId Identifier of the conference.
- *
- * @returns A {@link DolbyVoiceRecording} object through a {@link Promise}.
  */
-exports.deleteRecording = deleteRecording;
-var getDolbyVoiceRecording = /*#__PURE__*/function () {
+exports.getAllConferenceRecordings = getAllConferenceRecordings;
+var deleteRecording = /*#__PURE__*/function () {
   var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5(accessToken, confId) {
-    var requestOptions, response;
+    var requestOptions;
     return _regeneratorRuntime().wrap(function _callee5$(_context5) {
       while (1) switch (_context5.prev = _context5.next) {
         case 0:
           requestOptions = {
-            hostname: _urls.COMMS_HOSTNAME,
-            path: "/v1/monitor/conferences/".concat(confId, "/recordings/audio"),
+            hostname: Urls.getCommsHostname(),
+            path: "/v2/monitor/conferences/".concat(confId, "/recordings"),
             headers: {
               Accept: 'application/json',
               Authorization: "".concat(accessToken.token_type, " ").concat(accessToken.access_token)
             }
           };
           _context5.next = 3;
-          return (0, _httpHelpers.sendGet)(requestOptions);
+          return (0, _httpHelpers.sendDelete)(requestOptions);
         case 3:
-          response = _context5.sent;
-          return _context5.abrupt("return", response);
-        case 5:
         case "end":
           return _context5.stop();
       }
     }, _callee5);
   }));
-  return function getDolbyVoiceRecording(_x9, _x10) {
+  return function deleteRecording(_x9, _x10) {
     return _ref5.apply(this, arguments);
   };
 }();
-exports.getDolbyVoiceRecording = getDolbyVoiceRecording;
+exports.deleteRecording = deleteRecording;

package/dist/communications/monitor/webhooks.js

@@ -7,7 +7,9 @@ Object.defineProperty(exports, "__esModule", {
 exports.getEvents = exports.getAllEvents = void 0;
 var _httpHelpers = require("../../internal/httpHelpers");
 var _httpHelpers2 = require("../internal/httpHelpers");
-var _urls = require("../internal/urls");
+var Urls = _interopRequireWildcard(require("../../urls"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator["return"] && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) keys.push(key); return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, "catch": function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
@@ -50,7 +52,7 @@ var getEvents = /*#__PURE__*/function () {
             params['start'] = opts.start;
           }
           requestOptions = {
-            hostname: _urls.COMMS_HOSTNAME,
+            hostname: Urls.getCommsHostname(),
             path: path,
             params: params,
             headers: {
@@ -111,7 +113,7 @@ var getAllEvents = /*#__PURE__*/function () {
             params['type'] = opts.type;
           }
           requestOptions = {
-            hostname: _urls.COMMS_HOSTNAME,
+            hostname: Urls.getCommsHostname(),
             path: path,
             params: params,
             headers: {

package/dist/communications/recording.d.ts

@@ -1,24 +1,40 @@
+import { Expand, ExpandRecursively } from '../internal/utils';
 import JwtToken from '../types/jwtToken';
+import { MixOptionsBase, MixOptionsComplex } from './types/mixOptions';
 /**
  * Starts recording for the specified conference.
  *
- * You can specify a custom layout URL per recording request.
- * The {@link layoutUrl} parameter overrides the layout URL configured in the dashboard.
+ * You can specify a custom layout URL per a recording request.
+ * The {@link MixOptionsComplex.layoutUrl} parameter overrides the layout URL configured in the dashboard.
  *
  * @link https://docs.dolby.io/communications-apis/reference/api-recording-start
  *
- * @param accessToken Access token to use for authentication.
- * @param conferenceId Identifier of the conference.
- * @param layoutUrl Overwrites the layout URL configuration.
- *      This field is ignored if it is not relevant regarding recording configuration,
- *      for example if live_recording set to false or if the recording is MP3 only.
- *      - `null`: uses the layout URL configured in the dashboard (if no URL is set in the dashboard, then uses the Dolby.io default);
- *      - `default`: uses the Dolby.io default layout;
- *      - URL string: uses this layout URL
+ * @param options Recording options.
+ */
+export declare function start(options: Expand<MixOptionsBase>): Promise<void>;
+/**
+ * Starts recording for the specified conference.
+ *
+ * You can specify a custom layout URL per a recording request.
+ * The {@link MixOptionsComplex.layoutUrl} parameter overrides the layout URL configured in the dashboard.
+ *
+ * You can also specify the resolution of the recording.
+ * The default mixer layout application supports both 1920x1080 (16:9 aspect ratio) and 1080x1920 (9:16 aspect ratio).
+ * If the {@link MixOptionsComplex.resolution} parameter is not specified, then the system defaults to 1920x1080.
+ *
+ * Using the {@link MixOptionsComplex.mixId} parameter you can uniquely identify individual mixed recordings.
+ * For example, `landscape-stage` and `portrait-audience` as mixId can help you identify the purpose of the recording
+ * when you receive the webhook notification or use the Monitor API to retrieve the recordings.
+ * You may start only one recording per mixId.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/api-recording-start
+ *
+ * @param options Recording options.
  */
-export declare const start: (accessToken: JwtToken, conferenceId: string, layoutUrl?: string) => Promise<void>;
+export declare function start(options: ExpandRecursively<MixOptionsComplex>): Promise<void>;
 /**
- * Stops the recording of the specified conference.
+ * Stops recording the specified conference.
+ * Calling this API while recoding multiple mixed recordings stops all recordings.
  *
  * @link https://docs.dolby.io/communications-apis/reference/api-recording-stop
  *