ultracart_rest_api_v2_typescript 3.11.7 → 3.11.8

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.11.7
+## ultracart_rest_api_v2_typescript@3.11.8
 
 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.11.7 --save
+npm install ultracart_rest_api_v2_typescript@3.11.8 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.8 | 04/22/2025 | order property fields for created_by and created_dts |
 | 3.11.7 | 04/21/2025 | conversation agent additional fields |
 | 3.11.6 | 04/16/2025 | added channel partner order item properties |
 | 3.11.5 | 03/28/2025 | added paypal fastlane constants for payments |

package/api.ts

@@ -5344,6 +5344,80 @@ export interface CartValidationResponse {
     errors?: Array<string>;
 }
 
+/**
+ * 
+ * @export
+ * @interface ChanelPartnerReasonCodesResponse
+ */
+export interface ChanelPartnerReasonCodesResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    error?: ModelError;
+    /**
+     * True if the item level refund reason is required
+     * @type {boolean}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    item_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    item_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Return codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    item_level_return_reasons?: Array<OrderReason>;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * True if the order level refund reason is required
+     * @type {boolean}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    order_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    order_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * True if the order level reject reason is required
+     * @type {boolean}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    order_level_reject_reason_required?: boolean;
+    /**
+     * Reject codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    order_level_reject_reasons?: Array<OrderReason>;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -35001,6 +35075,18 @@ export interface OrderProcessPaymentResponse {
  * @interface OrderProperty
  */
 export interface OrderProperty {
+    /**
+     * Created by user
+     * @type {string}
+     * @memberof OrderProperty
+     */
+    created_by?: string;
+    /**
+     * The date/time that the property was created by the user
+     * @type {string}
+     * @memberof OrderProperty
+     */
+    created_dts?: string;
     /**
      * True if this property is displayed to the customer
      * @type {boolean}
@@ -47594,6 +47680,58 @@ export const ChannelPartnerApiFetchParamCreator = function (configuration?: Conf
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve reject and refund reason codes. 
+         * @summary Retrieve reject and refund reason codes.
+         * @param {number} channel_partner_oid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getChannelPartnerReasonCodes(channel_partner_oid: number, options: any = {}): FetchArgs {
+            // verify required parameter 'channel_partner_oid' is not null or undefined
+            if (channel_partner_oid === null || channel_partner_oid === undefined) {
+                throw new RequiredError('channel_partner_oid','Required parameter channel_partner_oid was null or undefined when calling getChannelPartnerReasonCodes.');
+            }
+            const localVarPath = `/channel_partner/channel_partners/{channel_partner_oid}/reason_codes`
+                .replace(`{${"channel_partner_oid"}}`, encodeURIComponent(String(channel_partner_oid)));
+            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", ["channel_partner_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 the ship to preference associated with the channel partner and the specific id. 
          * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -48193,6 +48331,27 @@ export const ChannelPartnerApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieve reject and refund reason codes. 
+         * @summary Retrieve reject and refund reason codes.
+         * @param {number} channel_partner_oid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ChanelPartnerReasonCodesResponse> {
+            const localVarFetchArgs = ChannelPartnerApiFetchParamCreator(configuration).getChannelPartnerReasonCodes(channel_partner_oid, 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 the ship to preference associated with the channel partner and the specific id. 
          * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -48434,6 +48593,16 @@ export const ChannelPartnerApiFactory = function (configuration?: Configuration,
         getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any) {
             return ChannelPartnerApiFp(configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(fetch, basePath);
         },
+        /**
+         * Retrieve reject and refund reason codes. 
+         * @summary Retrieve reject and refund reason codes.
+         * @param {number} channel_partner_oid 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any) {
+            return ChannelPartnerApiFp(configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(fetch, basePath);
+        },
         /**
          * Retrieve the ship to preference associated with the channel partner and the specific id. 
          * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -48598,6 +48767,16 @@ export interface ChannelPartnerApiInterface {
      */
     getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
 
+    /**
+     * Retrieve reject and refund reason codes. 
+     * @summary Retrieve reject and refund reason codes.
+     * @param {number} channel_partner_oid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChannelPartnerApiInterface
+     */
+    getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): Promise<ChanelPartnerReasonCodesResponse>;
+
     /**
      * Retrieve the ship to preference associated with the channel partner and the specific id. 
      * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -48776,6 +48955,18 @@ export class ChannelPartnerApi extends BaseAPI implements ChannelPartnerApiInter
         return ChannelPartnerApiFp(this.configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieve reject and refund reason codes. 
+     * @summary Retrieve reject and refund reason codes.
+     * @param {number} channel_partner_oid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChannelPartnerApi
+     */
+    public getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any) {
+        return ChannelPartnerApiFp(this.configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieve the ship to preference associated with the channel partner and the specific id. 
      * @summary Retrieve the ship to preference associated with the channel partner and the specific id.

package/dist/api.d.ts

@@ -5214,6 +5214,79 @@ export interface CartValidationResponse {
      */
     errors?: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface ChanelPartnerReasonCodesResponse
+ */
+export interface ChanelPartnerReasonCodesResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    error?: ModelError;
+    /**
+     * True if the item level refund reason is required
+     * @type {boolean}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    item_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    item_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * Return codes available at the item level.
+     * @type {Array<OrderReason>}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    item_level_return_reasons?: Array<OrderReason>;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * True if the order level refund reason is required
+     * @type {boolean}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    order_level_refund_reason_required?: boolean;
+    /**
+     * Reason codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    order_level_refund_reasons?: Array<OrderReason>;
+    /**
+     * True if the order level reject reason is required
+     * @type {boolean}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    order_level_reject_reason_required?: boolean;
+    /**
+     * Reject codes available at the order level.
+     * @type {Array<OrderReason>}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    order_level_reject_reasons?: Array<OrderReason>;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ChanelPartnerReasonCodesResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -34264,6 +34337,18 @@ export interface OrderProcessPaymentResponse {
  * @interface OrderProperty
  */
 export interface OrderProperty {
+    /**
+     * Created by user
+     * @type {string}
+     * @memberof OrderProperty
+     */
+    created_by?: string;
+    /**
+     * The date/time that the property was created by the user
+     * @type {string}
+     * @memberof OrderProperty
+     */
+    created_dts?: string;
     /**
      * True if this property is displayed to the customer
      * @type {boolean}
@@ -45255,6 +45340,14 @@ export declare const ChannelPartnerApiFetchParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): FetchArgs;
+    /**
+     * Retrieve reject and refund reason codes.
+     * @summary Retrieve reject and refund reason codes.
+     * @param {number} channel_partner_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): FetchArgs;
     /**
      * Retrieve the ship to preference associated with the channel partner and the specific id.
      * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -45388,6 +45481,14 @@ export declare const ChannelPartnerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
+    /**
+     * Retrieve reject and refund reason codes.
+     * @summary Retrieve reject and refund reason codes.
+     * @param {number} channel_partner_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ChanelPartnerReasonCodesResponse>;
     /**
      * Retrieve the ship to preference associated with the channel partner and the specific id.
      * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -45521,6 +45622,14 @@ export declare const ChannelPartnerApiFactory: (configuration?: Configuration, f
      * @throws {RequiredError}
      */
     getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
+    /**
+     * Retrieve reject and refund reason codes.
+     * @summary Retrieve reject and refund reason codes.
+     * @param {number} channel_partner_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): Promise<ChanelPartnerReasonCodesResponse>;
     /**
      * Retrieve the ship to preference associated with the channel partner and the specific id.
      * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -45662,6 +45771,15 @@ export interface ChannelPartnerApiInterface {
      * @memberof ChannelPartnerApiInterface
      */
     getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
+    /**
+     * Retrieve reject and refund reason codes.
+     * @summary Retrieve reject and refund reason codes.
+     * @param {number} channel_partner_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChannelPartnerApiInterface
+     */
+    getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): Promise<ChanelPartnerReasonCodesResponse>;
     /**
      * Retrieve the ship to preference associated with the channel partner and the specific id.
      * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -45811,6 +45929,15 @@ export declare class ChannelPartnerApi extends BaseAPI implements ChannelPartner
      * @memberof ChannelPartnerApi
      */
     getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
+    /**
+     * Retrieve reject and refund reason codes.
+     * @summary Retrieve reject and refund reason codes.
+     * @param {number} channel_partner_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChannelPartnerApi
+     */
+    getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): Promise<ChanelPartnerReasonCodesResponse>;
     /**
      * Retrieve the ship to preference associated with the channel partner and the specific id.
      * @summary Retrieve the ship to preference associated with the channel partner and the specific id.

package/dist/api.js

@@ -3846,6 +3846,52 @@ var ChannelPartnerApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve reject and refund reason codes.
+         * @summary Retrieve reject and refund reason codes.
+         * @param {number} channel_partner_oid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getChannelPartnerReasonCodes: function (channel_partner_oid, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'channel_partner_oid' is not null or undefined
+            if (channel_partner_oid === null || channel_partner_oid === undefined) {
+                throw new RequiredError('channel_partner_oid', 'Required parameter channel_partner_oid was null or undefined when calling getChannelPartnerReasonCodes.');
+            }
+            var localVarPath = "/channel_partner/channel_partners/{channel_partner_oid}/reason_codes"
+                .replace("{".concat("channel_partner_oid", "}"), encodeURIComponent(String(channel_partner_oid)));
+            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", ["channel_partner_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 the ship to preference associated with the channel partner and the specific id.
          * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -4398,6 +4444,28 @@ var ChannelPartnerApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieve reject and refund reason codes.
+         * @summary Retrieve reject and refund reason codes.
+         * @param {number} channel_partner_oid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getChannelPartnerReasonCodes: function (channel_partner_oid, options) {
+            var localVarFetchArgs = (0, exports.ChannelPartnerApiFetchParamCreator)(configuration).getChannelPartnerReasonCodes(channel_partner_oid, 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 the ship to preference associated with the channel partner and the specific id.
          * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -4646,6 +4714,16 @@ var ChannelPartnerApiFactory = function (configuration, fetch, basePath) {
         getChannelPartnerOrderByChannelPartnerOrderId: function (order_id, _expand, options) {
             return (0, exports.ChannelPartnerApiFp)(configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(fetch, basePath);
         },
+        /**
+         * Retrieve reject and refund reason codes.
+         * @summary Retrieve reject and refund reason codes.
+         * @param {number} channel_partner_oid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getChannelPartnerReasonCodes: function (channel_partner_oid, options) {
+            return (0, exports.ChannelPartnerApiFp)(configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(fetch, basePath);
+        },
         /**
          * Retrieve the ship to preference associated with the channel partner and the specific id.
          * @summary Retrieve the ship to preference associated with the channel partner and the specific id.
@@ -4822,6 +4900,17 @@ var ChannelPartnerApi = /** @class */ (function (_super) {
     ChannelPartnerApi.prototype.getChannelPartnerOrderByChannelPartnerOrderId = function (order_id, _expand, options) {
         return (0, exports.ChannelPartnerApiFp)(this.configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieve reject and refund reason codes.
+     * @summary Retrieve reject and refund reason codes.
+     * @param {number} channel_partner_oid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChannelPartnerApi
+     */
+    ChannelPartnerApi.prototype.getChannelPartnerReasonCodes = function (channel_partner_oid, options) {
+        return (0, exports.ChannelPartnerApiFp)(this.configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieve the ship to preference associated with the channel partner and the specific id.
      * @summary Retrieve the ship to preference associated with the channel partner and the specific id.

package/package.json

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