ultracart_rest_api_v2_typescript 3.10.101 → 3.10.102

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.101
+## ultracart_rest_api_v2_typescript@3.10.102
 
 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.101 --save
+npm install ultracart_rest_api_v2_typescript@3.10.102 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.102 | 01/19/2023 | convo - getConversationPermissions added |
 | 3.10.101 | 01/18/2023 | conversation get dept member list method added |
 | 3.10.100 | 01/18/2023 | conversation dept members |
 | 3.10.99 | 01/18/2023 | channel partner ship to pref desc field |

package/api.ts

@@ -7144,12 +7144,6 @@ export interface ConversationDepartmentsResponse {
      * @memberof ConversationDepartmentsResponse
      */
     metadata?: ResponseMetadata;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof ConversationDepartmentsResponse
-     */
-    read_only?: boolean;
     /**
      * Indicates if API call was successful
      * @type {boolean}
@@ -8097,6 +8091,58 @@ export interface ConversationParticipant {
     unread_messages?: number;
 }
 
+/**
+ * 
+ * @export
+ * @interface ConversationPermissions
+ */
+export interface ConversationPermissions {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ConversationPermissions
+     */
+    edit_settings?: boolean;
+}
+
+/**
+ * 
+ * @export
+ * @interface ConversationPermissionsResponse
+ */
+export interface ConversationPermissionsResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ConversationPermissionsResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ConversationPermissionsResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * 
+     * @type {ConversationPermissions}
+     * @memberof ConversationPermissionsResponse
+     */
+    permissions?: ConversationPermissions;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationPermissionsResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ConversationPermissionsResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -44363,6 +44409,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve conversation permissions 
+         * @summary Retrieve conversation permissions
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationPermissions(options: any = {}): FetchArgs {
+            const localVarPath = `/conversation/permissions`;
+            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) {
+				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 conversation webchat queue statuses including agent status and queue entries 
          * @summary Retrieve a conversation webchat queue statuses
@@ -45544,6 +45636,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieve conversation permissions 
+         * @summary Retrieve conversation permissions
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationPermissions(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationPermissionsResponse> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getConversationPermissions(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 a conversation webchat queue statuses including agent status and queue entries 
          * @summary Retrieve a conversation webchat queue statuses
@@ -46023,6 +46135,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         getConversationMultimediaUploadUrl(extension: string, options?: any) {
             return ConversationApiFp(configuration).getConversationMultimediaUploadUrl(extension, options)(fetch, basePath);
         },
+        /**
+         * Retrieve conversation permissions 
+         * @summary Retrieve conversation permissions
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationPermissions(options?: any) {
+            return ConversationApiFp(configuration).getConversationPermissions(options)(fetch, basePath);
+        },
         /**
          * Retrieve a conversation webchat queue statuses including agent status and queue entries 
          * @summary Retrieve a conversation webchat queue statuses
@@ -46326,6 +46447,15 @@ export interface ConversationApiInterface {
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
 
+    /**
+     * Retrieve conversation permissions 
+     * @summary Retrieve conversation permissions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationPermissions(options?: any): Promise<ConversationPermissionsResponse>;
+
     /**
      * Retrieve a conversation webchat queue statuses including agent status and queue entries 
      * @summary Retrieve a conversation webchat queue statuses
@@ -46655,6 +46785,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).getConversationMultimediaUploadUrl(extension, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieve conversation permissions 
+     * @summary Retrieve conversation permissions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public getConversationPermissions(options?: any) {
+        return ConversationApiFp(this.configuration).getConversationPermissions(options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieve a conversation webchat queue statuses including agent status and queue entries 
      * @summary Retrieve a conversation webchat queue statuses

package/dist/api.d.ts

@@ -6975,12 +6975,6 @@ export interface ConversationDepartmentsResponse {
      * @memberof ConversationDepartmentsResponse
      */
     metadata?: ResponseMetadata;
-    /**
-     *
-     * @type {boolean}
-     * @memberof ConversationDepartmentsResponse
-     */
-    read_only?: boolean;
     /**
      * Indicates if API call was successful
      * @type {boolean}
@@ -7901,6 +7895,56 @@ export interface ConversationParticipant {
      */
     unread_messages?: number;
 }
+/**
+ *
+ * @export
+ * @interface ConversationPermissions
+ */
+export interface ConversationPermissions {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ConversationPermissions
+     */
+    edit_settings?: boolean;
+}
+/**
+ *
+ * @export
+ * @interface ConversationPermissionsResponse
+ */
+export interface ConversationPermissionsResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationPermissionsResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationPermissionsResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     *
+     * @type {ConversationPermissions}
+     * @memberof ConversationPermissionsResponse
+     */
+    permissions?: ConversationPermissions;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationPermissionsResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationPermissionsResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -39615,6 +39659,13 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): FetchArgs;
+    /**
+     * Retrieve conversation permissions
+     * @summary Retrieve conversation permissions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationPermissions(options?: any): FetchArgs;
     /**
      * Retrieve a conversation webchat queue statuses including agent status and queue entries
      * @summary Retrieve a conversation webchat queue statuses
@@ -39857,6 +39908,13 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationMultimediaUploadUrlResponse>;
+    /**
+     * Retrieve conversation permissions
+     * @summary Retrieve conversation permissions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationPermissions(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationPermissionsResponse>;
     /**
      * Retrieve a conversation webchat queue statuses including agent status and queue entries
      * @summary Retrieve a conversation webchat queue statuses
@@ -40099,6 +40157,13 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
+    /**
+     * Retrieve conversation permissions
+     * @summary Retrieve conversation permissions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversationPermissions(options?: any): Promise<ConversationPermissionsResponse>;
     /**
      * Retrieve a conversation webchat queue statuses including agent status and queue entries
      * @summary Retrieve a conversation webchat queue statuses
@@ -40355,6 +40420,14 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
+    /**
+     * Retrieve conversation permissions
+     * @summary Retrieve conversation permissions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getConversationPermissions(options?: any): Promise<ConversationPermissionsResponse>;
     /**
      * Retrieve a conversation webchat queue statuses including agent status and queue entries
      * @summary Retrieve a conversation webchat queue statuses
@@ -40628,6 +40701,14 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     getConversationMultimediaUploadUrl(extension: string, options?: any): Promise<ConversationMultimediaUploadUrlResponse>;
+    /**
+     * Retrieve conversation permissions
+     * @summary Retrieve conversation permissions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    getConversationPermissions(options?: any): Promise<ConversationPermissionsResponse>;
     /**
      * Retrieve a conversation webchat queue statuses including agent status and queue entries
      * @summary Retrieve a conversation webchat queue statuses

package/dist/api.js

@@ -6729,6 +6729,46 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve conversation permissions
+         * @summary Retrieve conversation permissions
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationPermissions: function (options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/conversation/permissions";
+            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 a conversation webchat queue statuses including agent status and queue entries
          * @summary Retrieve a conversation webchat queue statuses
@@ -7811,6 +7851,27 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieve conversation permissions
+         * @summary Retrieve conversation permissions
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationPermissions: function (options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).getConversationPermissions(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 a conversation webchat queue statuses including agent status and queue entries
          * @summary Retrieve a conversation webchat queue statuses
@@ -8306,6 +8367,15 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         getConversationMultimediaUploadUrl: function (extension, options) {
             return (0, exports.ConversationApiFp)(configuration).getConversationMultimediaUploadUrl(extension, options)(fetch, basePath);
         },
+        /**
+         * Retrieve conversation permissions
+         * @summary Retrieve conversation permissions
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getConversationPermissions: function (options) {
+            return (0, exports.ConversationApiFp)(configuration).getConversationPermissions(options)(fetch, basePath);
+        },
         /**
          * Retrieve a conversation webchat queue statuses including agent status and queue entries
          * @summary Retrieve a conversation webchat queue statuses
@@ -8627,6 +8697,16 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.getConversationMultimediaUploadUrl = function (extension, options) {
         return (0, exports.ConversationApiFp)(this.configuration).getConversationMultimediaUploadUrl(extension, options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieve conversation permissions
+     * @summary Retrieve conversation permissions
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.getConversationPermissions = function (options) {
+        return (0, exports.ConversationApiFp)(this.configuration).getConversationPermissions(options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieve a conversation webchat queue statuses including agent status and queue entries
      * @summary Retrieve a conversation webchat queue statuses

package/package.json

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