ultracart_rest_api_v2_typescript 3.10.70 → 3.10.71

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.70
+## ultracart_rest_api_v2_typescript@3.10.71
 
 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.70 --save
+npm install ultracart_rest_api_v2_typescript@3.10.71 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.71 | 11/29/2022 | converstation marked convo read method |
 | 3.10.70 | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
 | 3.10.69 | 11/21/2022 | conversation context method |
 | 3.10.68 | 11/21/2022 | adjusted conversation event model |

package/api.ts

@@ -6741,6 +6741,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     conversation_message_uuid?: string;
+    /**
+     * Delay message transmission until date/time
+     * @type {string}
+     * @memberof ConversationMessage
+     */
+    delay_until_dts?: string;
     /**
      * 
      * @type {Array<string>}
@@ -41898,6 +41904,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_write"])
+					: 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,
+            };
+        },
+        /**
+         * Mark a conversation as read 
+         * @summary Mark a conversation as read
+         * @param {string} conversation_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        markReadConversation(conversation_uuid: string, options: any = {}): FetchArgs {
+            // verify required parameter 'conversation_uuid' is not null or undefined
+            if (conversation_uuid === null || conversation_uuid === undefined) {
+                throw new RequiredError('conversation_uuid','Required parameter conversation_uuid was null or undefined when calling markReadConversation.');
+            }
+            const localVarPath = `/conversation/conversations/{conversation_uuid}/markread`
+                .replace(`{${"conversation_uuid"}}`, encodeURIComponent(String(conversation_uuid)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'PUT' }, 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) {
@@ -42263,6 +42321,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Mark a conversation as read 
+         * @summary Mark a conversation as read
+         * @param {string} conversation_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        markReadConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).markReadConversation(conversation_uuid, 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;
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Start a new conversation 
          * @summary Start a conversation
@@ -42418,6 +42497,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         leaveConversation(conversation_uuid: string, options?: any) {
             return ConversationApiFp(configuration).leaveConversation(conversation_uuid, options)(fetch, basePath);
         },
+        /**
+         * Mark a conversation as read 
+         * @summary Mark a conversation as read
+         * @param {string} conversation_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        markReadConversation(conversation_uuid: string, options?: any) {
+            return ConversationApiFp(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
+        },
         /**
          * Start a new conversation 
          * @summary Start a conversation
@@ -42551,6 +42640,16 @@ export interface ConversationApiInterface {
      */
     leaveConversation(conversation_uuid: string, options?: any): Promise<{}>;
 
+    /**
+     * Mark a conversation as read 
+     * @summary Mark a conversation as read
+     * @param {string} conversation_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
+
     /**
      * Start a new conversation 
      * @summary Start a conversation
@@ -42704,6 +42803,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).leaveConversation(conversation_uuid, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Mark a conversation as read 
+     * @summary Mark a conversation as read
+     * @param {string} conversation_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public markReadConversation(conversation_uuid: string, options?: any) {
+        return ConversationApiFp(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Start a new conversation 
      * @summary Start a conversation

package/dist/api.d.ts

@@ -6582,6 +6582,12 @@ export interface ConversationMessage {
      * @memberof ConversationMessage
      */
     conversation_message_uuid?: string;
+    /**
+     * Delay message transmission until date/time
+     * @type {string}
+     * @memberof ConversationMessage
+     */
+    delay_until_dts?: string;
     /**
      *
      * @type {Array<string>}
@@ -37728,6 +37734,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     leaveConversation(conversation_uuid: string, options?: any): FetchArgs;
+    /**
+     * Mark a conversation as read
+     * @summary Mark a conversation as read
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markReadConversation(conversation_uuid: string, options?: any): FetchArgs;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -37834,6 +37848,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     leaveConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
+    /**
+     * Mark a conversation as read
+     * @summary Mark a conversation as read
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markReadConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -37940,6 +37962,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     leaveConversation(conversation_uuid: string, options?: any): Promise<Response>;
+    /**
+     * Mark a conversation as read
+     * @summary Mark a conversation as read
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -38057,6 +38087,15 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     leaveConversation(conversation_uuid: string, options?: any): Promise<{}>;
+    /**
+     * Mark a conversation as read
+     * @summary Mark a conversation as read
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    markReadConversation(conversation_uuid: string, options?: any): Promise<{}>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -38177,6 +38216,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     leaveConversation(conversation_uuid: string, options?: any): Promise<Response>;
+    /**
+     * Mark a conversation as read
+     * @summary Mark a conversation as read
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    markReadConversation(conversation_uuid: string, options?: any): Promise<Response>;
     /**
      * Start a new conversation
      * @summary Start a conversation

package/dist/api.js

@@ -5926,6 +5926,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Mark a conversation as read
+         * @summary Mark a conversation as read
+         * @param {string} conversation_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        markReadConversation: function (conversation_uuid, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'conversation_uuid' is not null or undefined
+            if (conversation_uuid === null || conversation_uuid === undefined) {
+                throw new RequiredError('conversation_uuid', 'Required parameter conversation_uuid was null or undefined when calling markReadConversation.');
+            }
+            var localVarPath = "/conversation/conversations/{conversation_uuid}/markread"
+                .replace("{".concat("conversation_uuid", "}"), encodeURIComponent(String(conversation_uuid)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'PUT' }, 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_write"])
+                    : 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,
+            };
+        },
         /**
          * Start a new conversation
          * @summary Start a conversation
@@ -6260,6 +6306,28 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Mark a conversation as read
+         * @summary Mark a conversation as read
+         * @param {string} conversation_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        markReadConversation: function (conversation_uuid, options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).markReadConversation(conversation_uuid, 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;
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Start a new conversation
          * @summary Start a conversation
@@ -6417,6 +6485,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         leaveConversation: function (conversation_uuid, options) {
             return (0, exports.ConversationApiFp)(configuration).leaveConversation(conversation_uuid, options)(fetch, basePath);
         },
+        /**
+         * Mark a conversation as read
+         * @summary Mark a conversation as read
+         * @param {string} conversation_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        markReadConversation: function (conversation_uuid, options) {
+            return (0, exports.ConversationApiFp)(configuration).markReadConversation(conversation_uuid, options)(fetch, basePath);
+        },
         /**
          * Start a new conversation
          * @summary Start a conversation
@@ -6565,6 +6643,17 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.leaveConversation = function (conversation_uuid, options) {
         return (0, exports.ConversationApiFp)(this.configuration).leaveConversation(conversation_uuid, options)(this.fetch, this.basePath);
     };
+    /**
+     * Mark a conversation as read
+     * @summary Mark a conversation as read
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.markReadConversation = function (conversation_uuid, options) {
+        return (0, exports.ConversationApiFp)(this.configuration).markReadConversation(conversation_uuid, options)(this.fetch, this.basePath);
+    };
     /**
      * Start a new conversation
      * @summary Start a conversation

package/package.json

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