ultracart_rest_api_v2_typescript 3.10.117 → 3.10.119

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.117
+## ultracart_rest_api_v2_typescript@3.10.119
 
 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.117 --save
+npm install ultracart_rest_api_v2_typescript@3.10.119 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.119 | 02/20/2023 | refund reasons |
+| 3.10.118 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
 | 3.10.117 | 02/15/2023 | added auto order sorting by next_shipment_dts |
 | 3.10.116 | 02/10/2023 | convo - add storefront_host_name to search request |
 | 3.10.115 | 02/07/2023 | convo - new event for when a customer joins a queue |

package/api.ts

@@ -28309,12 +28309,24 @@ export interface Order {
      * @memberof Order
      */
     refund_dts?: string;
+    /**
+     * Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof Order
+     */
+    refund_reason?: string;
     /**
      * If the order was rejected, the date/time that the rejection occurred
      * @type {string}
      * @memberof Order
      */
     reject_dts?: string;
+    /**
+     * Reject reason code.  This can only be written during a reject operation otherwise this field is read only.
+     * @type {string}
+     * @memberof Order
+     */
+    reject_reason?: string;
     /**
      * 
      * @type {OrderSalesforce}
@@ -29877,6 +29889,18 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     quickbooks_class?: string;
+    /**
+     * Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    refund_reason?: string;
+    /**
+     * Return reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    return_reason?: string;
     /**
      * True if this item ships in a separate box
      * @type {boolean}
@@ -31241,6 +31265,32 @@ export interface OrderQuote {
     quoted_dts?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface OrderReason
+ */
+export interface OrderReason {
+    /**
+     * Default reason
+     * @type {boolean}
+     * @memberof OrderReason
+     */
+    default_reason?: boolean;
+    /**
+     * Reason description.  This is the friendly description of the reason that should be displayed to the user.
+     * @type {string}
+     * @memberof OrderReason
+     */
+    description?: string;
+    /**
+     * Reason value.  This is what should be submitted with a refund operation.
+     * @type {string}
+     * @memberof OrderReason
+     */
+    value?: string;
+}
+
 /**
  * 
  * @export
@@ -31253,12 +31303,48 @@ export interface OrderRefundableResponse {
      * @memberof OrderRefundableResponse
      */
     error?: ModelError;
+    /**
+     * True if the item level refund reason is required
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Return codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_return_reasons?: Array<OrderReason>;
     /**
      * 
      * @type {ResponseMetadata}
      * @memberof OrderRefundableResponse
      */
     metadata?: ResponseMetadata;
+    /**
+     * True if the order level refund reason is required
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Reject codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_reject_reasons?: Array<OrderReason>;
     /**
      * Whether the order is refundable or not.  Null should be interpreted as false.
      * @type {boolean}
@@ -45729,6 +45815,58 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Unsubscribe any SMS participants in this conversation 
+         * @summary Unsubscribe any SMS participants in this conversation
+         * @param {string} conversation_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        smsUnsubscribeConversation(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 smsUnsubscribeConversation.');
+            }
+            const localVarPath = `/conversation/conversations/{conversation_uuid}/sms_unsubscribe`
+                .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) {
+				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,
+            };
+        },
         /**
          * Start a new conversation 
          * @summary Start a conversation
@@ -46677,6 +46815,27 @@ export const ConversationApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Unsubscribe any SMS participants in this conversation 
+         * @summary Unsubscribe any SMS participants in this conversation
+         * @param {string} conversation_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        smsUnsubscribeConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
+            const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).smsUnsubscribeConversation(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
@@ -47093,6 +47252,16 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
         searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any) {
             return ConversationApiFp(configuration).searchConversationCannedMessages(search_request, options)(fetch, basePath);
         },
+        /**
+         * Unsubscribe any SMS participants in this conversation 
+         * @summary Unsubscribe any SMS participants in this conversation
+         * @param {string} conversation_uuid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        smsUnsubscribeConversation(conversation_uuid: string, options?: any) {
+            return ConversationApiFp(configuration).smsUnsubscribeConversation(conversation_uuid, options)(fetch, basePath);
+        },
         /**
          * Start a new conversation 
          * @summary Start a conversation
@@ -47443,6 +47612,16 @@ export interface ConversationApiInterface {
      */
     searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): Promise<ConversationCannedMessagesResponse>;
 
+    /**
+     * Unsubscribe any SMS participants in this conversation 
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversation_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    smsUnsubscribeConversation(conversation_uuid: string, options?: any): Promise<{}>;
+
     /**
      * Start a new conversation 
      * @summary Start a conversation
@@ -47849,6 +48028,18 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
         return ConversationApiFp(this.configuration).searchConversationCannedMessages(search_request, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Unsubscribe any SMS participants in this conversation 
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversation_uuid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    public smsUnsubscribeConversation(conversation_uuid: string, options?: any) {
+        return ConversationApiFp(this.configuration).smsUnsubscribeConversation(conversation_uuid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Start a new conversation 
      * @summary Start a conversation

package/dist/api.d.ts

@@ -27705,12 +27705,24 @@ export interface Order {
      * @memberof Order
      */
     refund_dts?: string;
+    /**
+     * Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof Order
+     */
+    refund_reason?: string;
     /**
      * If the order was rejected, the date/time that the rejection occurred
      * @type {string}
      * @memberof Order
      */
     reject_dts?: string;
+    /**
+     * Reject reason code.  This can only be written during a reject operation otherwise this field is read only.
+     * @type {string}
+     * @memberof Order
+     */
+    reject_reason?: string;
     /**
      *
      * @type {OrderSalesforce}
@@ -29248,6 +29260,18 @@ export interface OrderItem {
      * @memberof OrderItem
      */
     quickbooks_class?: string;
+    /**
+     * Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    refund_reason?: string;
+    /**
+     * Return reason code.  This can only be written during a refund operation otherwise this field is read only.
+     * @type {string}
+     * @memberof OrderItem
+     */
+    return_reason?: string;
     /**
      * True if this item ships in a separate box
      * @type {boolean}
@@ -30580,6 +30604,31 @@ export interface OrderQuote {
      */
     quoted_dts?: string;
 }
+/**
+ *
+ * @export
+ * @interface OrderReason
+ */
+export interface OrderReason {
+    /**
+     * Default reason
+     * @type {boolean}
+     * @memberof OrderReason
+     */
+    default_reason?: boolean;
+    /**
+     * Reason description.  This is the friendly description of the reason that should be displayed to the user.
+     * @type {string}
+     * @memberof OrderReason
+     */
+    description?: string;
+    /**
+     * Reason value.  This is what should be submitted with a refund operation.
+     * @type {string}
+     * @memberof OrderReason
+     */
+    value?: string;
+}
 /**
  *
  * @export
@@ -30592,12 +30641,48 @@ export interface OrderRefundableResponse {
      * @memberof OrderRefundableResponse
      */
     error?: ModelError;
+    /**
+     * True if the item level refund reason is required
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Return codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    item_level_return_reasons?: Array<OrderReason>;
     /**
      *
      * @type {ResponseMetadata}
      * @memberof OrderRefundableResponse
      */
     metadata?: ResponseMetadata;
+    /**
+     * True if the order level refund reason is required
+     * @type {boolean}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Reject codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof OrderRefundableResponse
+     */
+    order_level_reject_reasons?: Array<OrderReason>;
     /**
      * Whether the order is refundable or not.  Null should be interpreted as false.
      * @type {boolean}
@@ -40297,6 +40382,14 @@ export declare const ConversationApiFetchParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): FetchArgs;
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    smsUnsubscribeConversation(conversation_uuid: string, options?: any): FetchArgs;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -40576,6 +40669,14 @@ export declare const ConversationApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationCannedMessagesResponse>;
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    smsUnsubscribeConversation(conversation_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -40855,6 +40956,14 @@ export declare const ConversationApiFactory: (configuration?: Configuration, fet
      * @throws {RequiredError}
      */
     searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): Promise<ConversationCannedMessagesResponse>;
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    smsUnsubscribeConversation(conversation_uuid: string, options?: any): Promise<Response>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -41163,6 +41272,15 @@ export interface ConversationApiInterface {
      * @memberof ConversationApiInterface
      */
     searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): Promise<ConversationCannedMessagesResponse>;
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    smsUnsubscribeConversation(conversation_uuid: string, options?: any): Promise<{}>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -41478,6 +41596,15 @@ export declare class ConversationApi extends BaseAPI implements ConversationApiI
      * @memberof ConversationApi
      */
     searchConversationCannedMessages(search_request: ConversationCannedMessagesSearch, options?: any): Promise<ConversationCannedMessagesResponse>;
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    smsUnsubscribeConversation(conversation_uuid: string, options?: any): Promise<Response>;
     /**
      * Start a new conversation
      * @summary Start a conversation

package/dist/api.js

@@ -7441,6 +7441,52 @@ var ConversationApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Unsubscribe any SMS participants in this conversation
+         * @summary Unsubscribe any SMS participants in this conversation
+         * @param {string} conversation_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        smsUnsubscribeConversation: 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 smsUnsubscribeConversation.');
+            }
+            var localVarPath = "/conversation/conversations/{conversation_uuid}/sms_unsubscribe"
+                .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
@@ -8375,6 +8421,28 @@ var ConversationApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Unsubscribe any SMS participants in this conversation
+         * @summary Unsubscribe any SMS participants in this conversation
+         * @param {string} conversation_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        smsUnsubscribeConversation: function (conversation_uuid, options) {
+            var localVarFetchArgs = (0, exports.ConversationApiFetchParamCreator)(configuration).smsUnsubscribeConversation(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
@@ -8797,6 +8865,16 @@ var ConversationApiFactory = function (configuration, fetch, basePath) {
         searchConversationCannedMessages: function (search_request, options) {
             return (0, exports.ConversationApiFp)(configuration).searchConversationCannedMessages(search_request, options)(fetch, basePath);
         },
+        /**
+         * Unsubscribe any SMS participants in this conversation
+         * @summary Unsubscribe any SMS participants in this conversation
+         * @param {string} conversation_uuid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        smsUnsubscribeConversation: function (conversation_uuid, options) {
+            return (0, exports.ConversationApiFp)(configuration).smsUnsubscribeConversation(conversation_uuid, options)(fetch, basePath);
+        },
         /**
          * Start a new conversation
          * @summary Start a conversation
@@ -9180,6 +9258,17 @@ var ConversationApi = /** @class */ (function (_super) {
     ConversationApi.prototype.searchConversationCannedMessages = function (search_request, options) {
         return (0, exports.ConversationApiFp)(this.configuration).searchConversationCannedMessages(search_request, options)(this.fetch, this.basePath);
     };
+    /**
+     * Unsubscribe any SMS participants in this conversation
+     * @summary Unsubscribe any SMS participants in this conversation
+     * @param {string} conversation_uuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApi
+     */
+    ConversationApi.prototype.smsUnsubscribeConversation = function (conversation_uuid, options) {
+        return (0, exports.ConversationApiFp)(this.configuration).smsUnsubscribeConversation(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.117",
+  "version": "3.10.119",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [