ultracart_rest_api_v2_typescript 3.10.196 → 3.10.197

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.196
+## ultracart_rest_api_v2_typescript@3.10.197
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@3.10.196 --save
+npm install ultracart_rest_api_v2_typescript@3.10.197 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.197 | 05/02/2024 | conversation - new method to load pbx audio usage |
 | 3.10.196 | 05/02/2024 | autoorder - fields to record merge association and tstamp |
 | 3.10.195 | 05/01/2024 | getConversationPbxAudioUploadUrl - fix the response obj def |
 | 3.10.194 | 04/24/2024 | esp - add fields for external generation on email |

package/api.ts

@@ -8902,6 +8902,56 @@ export interface ConversationPbxAudioUploadUrlResponse {
     warning?: Warning;
 }
 
+/**
+ * 
+ * @export
+ * @interface ConversationPbxAudioUsageResponse
+ */
+export interface ConversationPbxAudioUsageResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {Array<ConversationPbxMenu>}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    menus?: Array<ConversationPbxMenu>;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * 
+     * @type {Array<ConversationPbxQueue>}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    queues?: Array<ConversationPbxQueue>;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Array<ConversationPbxVoicemailMailbox>}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    voicemail_mailboxes?: Array<ConversationPbxVoicemailMailbox>;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -52424,6 +52474,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
 
 
 
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["conversation_read"])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieve a pbx audio usage 
+         * @summary Get pbx audio usage
+         * @param {string} conversationPbxAudioUuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPbxAudioUsage(conversationPbxAudioUuid: string, options: any = {}): FetchArgs {
+            // verify required parameter 'conversationPbxAudioUuid' is not null or undefined
+            if (conversationPbxAudioUuid === null || conversationPbxAudioUuid === undefined) {
+                throw new RequiredError('conversationPbxAudioUuid','Required parameter conversationPbxAudioUuid was null or undefined when calling getPbxAudioUsage.');
+            }
+            const localVarPath = `/conversation/pbx/audio/{conversationPbxAudioUuid}/usage`
+                .replace(`{${"conversationPbxAudioUuid"}}`, encodeURIComponent(String(conversationPbxAudioUuid)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
             // authentication ultraCartOauth required
             // oauth required
             if (configuration && configuration.accessToken) {
@@ -55874,6 +55976,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieve a pbx audio usage 
+         * @summary Get pbx audio usage
+         * @param {string} conversationPbxAudioUuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPbxAudioUsage(conversationPbxAudioUuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationPbxAudioUsageResponse> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getPbxAudioUsage(conversationPbxAudioUuid, options);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Retrieve pbx audios 
          * @summary Get pbx audios
@@ -57274,6 +57397,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         getPbxAudio(conversationPbxAudioUuid: string, options?: any) {
             return ConversationApiFp(configuration).getPbxAudio(conversationPbxAudioUuid, options)(fetch, basePath);
         },
+        /**
+         * Retrieve a pbx audio usage 
+         * @summary Get pbx audio usage
+         * @param {string} conversationPbxAudioUuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPbxAudioUsage(conversationPbxAudioUuid: string, options?: any) {
+            return ConversationApiFp(configuration).getPbxAudioUsage(conversationPbxAudioUuid, options)(fetch, basePath);
+        },
         /**
          * Retrieve pbx audios 
          * @summary Get pbx audios
@@ -58146,6 +58279,16 @@ export interface ConversationApiInterface {
      */
     getPbxAudio(conversationPbxAudioUuid: string, options?: any): Promise<ConversationPbxAudioResponse>;
 
+    /**
+     * Retrieve a pbx audio usage 
+     * @summary Get pbx audio usage
+     * @param {string} conversationPbxAudioUuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getPbxAudioUsage(conversationPbxAudioUuid: string, options?: any): Promise<ConversationPbxAudioUsageResponse>;
+
     /**
      * Retrieve pbx audios 
      * @summary Get pbx audios
@@ -59094,6 +59237,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).getPbxAudio(conversationPbxAudioUuid, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieve a pbx audio usage 
+     * @summary Get pbx audio usage
+     * @param {string} conversationPbxAudioUuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public getPbxAudioUsage(conversationPbxAudioUuid: string, options?: any) {
+        return ConversationApiFp(this.configuration).getPbxAudioUsage(conversationPbxAudioUuid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieve pbx audios 
      * @summary Get pbx audios

package/dist/api.d.ts

@@ -8688,6 +8688,55 @@ export interface ConversationPbxAudioUploadUrlResponse {
      */
     warning?: Warning;
 }
+/**
+ *
+ * @export
+ * @interface ConversationPbxAudioUsageResponse
+ */
+export interface ConversationPbxAudioUsageResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {Array<ConversationPbxMenu>}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    menus?: Array<ConversationPbxMenu>;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     *
+     * @type {Array<ConversationPbxQueue>}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    queues?: Array<ConversationPbxQueue>;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Array<ConversationPbxVoicemailMailbox>}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    voicemail_mailboxes?: Array<ConversationPbxVoicemailMailbox>;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationPbxAudioUsageResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -46323,6 +46372,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     getPbxAudio(conversationPbxAudioUuid: string, options?: any): FetchArgs;
+    /**
+     * Retrieve a pbx audio usage
+     * @summary Get pbx audio usage
+     * @param {string} conversationPbxAudioUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPbxAudioUsage(conversationPbxAudioUuid: string, options?: any): FetchArgs;
     /**
      * Retrieve pbx audios
      * @summary Get pbx audios
@@ -47020,6 +47077,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPbxAudio(conversationPbxAudioUuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationPbxAudioResponse>;
+    /**
+     * Retrieve a pbx audio usage
+     * @summary Get pbx audio usage
+     * @param {string} conversationPbxAudioUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPbxAudioUsage(conversationPbxAudioUuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationPbxAudioUsageResponse>;
     /**
      * Retrieve pbx audios
      * @summary Get pbx audios
@@ -47717,6 +47782,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     getPbxAudio(conversationPbxAudioUuid: string, options?: any): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Retrieve a pbx audio usage
+     * @summary Get pbx audio usage
+     * @param {string} conversationPbxAudioUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPbxAudioUsage(conversationPbxAudioUuid: string, options?: any): Promise<ConversationPbxAudioUsageResponse>;
     /**
      * Retrieve pbx audios
      * @summary Get pbx audios
@@ -48453,6 +48526,15 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     getPbxAudio(conversationPbxAudioUuid: string, options?: any): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Retrieve a pbx audio usage
+     * @summary Get pbx audio usage
+     * @param {string} conversationPbxAudioUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getPbxAudioUsage(conversationPbxAudioUuid: string, options?: any): Promise<ConversationPbxAudioUsageResponse>;
     /**
      * Retrieve pbx audios
      * @summary Get pbx audios
@@ -49238,6 +49320,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     getPbxAudio(conversationPbxAudioUuid: string, options?: any): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Retrieve a pbx audio usage
+     * @summary Get pbx audio usage
+     * @param {string} conversationPbxAudioUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    getPbxAudioUsage(conversationPbxAudioUuid: string, options?: any): Promise<ConversationPbxAudioUsageResponse>;
     /**
      * Retrieve pbx audios
      * @summary Get pbx audios

package/dist/api.js

@@ -8535,6 +8535,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve a pbx audio usage
+         * @summary Get pbx audio usage
+         * @param {string} conversationPbxAudioUuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPbxAudioUsage: function (conversationPbxAudioUuid, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'conversationPbxAudioUuid' is not null or undefined
+            if (conversationPbxAudioUuid === null || conversationPbxAudioUuid === undefined) {
+                throw new RequiredError('conversationPbxAudioUuid', 'Required parameter conversationPbxAudioUuid was null or undefined when calling getPbxAudioUsage.');
+            }
+            var localVarPath = "/conversation/pbx/audio/{conversationPbxAudioUuid}/usage"
+                .replace("{".concat("conversationPbxAudioUuid", "}"), encodeURIComponent(String(conversationPbxAudioUuid)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["conversation_read"])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieve pbx audios
          * @summary Get pbx audios
@@ -11681,6 +11727,28 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieve a pbx audio usage
+         * @summary Get pbx audio usage
+         * @param {string} conversationPbxAudioUuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPbxAudioUsage: function (conversationPbxAudioUuid, options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getPbxAudioUsage(conversationPbxAudioUuid, options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Retrieve pbx audios
          * @summary Get pbx audios
@@ -13129,6 +13197,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         getPbxAudio: function (conversationPbxAudioUuid, options) {
             return (0, exports.ConversationApiFp)(configuration).getPbxAudio(conversationPbxAudioUuid, options)(fetch, basePath);
         },
+        /**
+         * Retrieve a pbx audio usage
+         * @summary Get pbx audio usage
+         * @param {string} conversationPbxAudioUuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPbxAudioUsage: function (conversationPbxAudioUuid, options) {
+            return (0, exports.ConversationApiFp)(configuration).getPbxAudioUsage(conversationPbxAudioUuid, options)(fetch, basePath);
+        },
         /**
          * Retrieve pbx audios
          * @summary Get pbx audios
@@ -14044,6 +14122,17 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.getPbxAudio = function (conversationPbxAudioUuid, options) {
         return (0, exports.ConversationApiFp)(this.configuration).getPbxAudio(conversationPbxAudioUuid, options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieve a pbx audio usage
+     * @summary Get pbx audio usage
+     * @param {string} conversationPbxAudioUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.getPbxAudioUsage = function (conversationPbxAudioUuid, options) {
+        return (0, exports.ConversationApiFp)(this.configuration).getPbxAudioUsage(conversationPbxAudioUuid, options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieve pbx audios
      * @summary Get pbx audios

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.10.196",
+  "version": "3.10.197",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [