ultracart_rest_api_v2_typescript 3.11.27 → 3.11.28

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.11.27
+## ultracart_rest_api_v2_typescript@3.11.28
 
 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.27 --save
+npm install ultracart_rest_api_v2_typescript@3.11.28 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.28 | 11/07/2025 | OrderApi.assignToAffiliate |
 | 3.11.27 | 11/06/2025 | conversation ai knowledge base changes |
 | 3.11.26 | 10/20/2025 | conversation api bug fixes |
 | 3.11.25 | 10/20/2025 | conversation api bug fix for bad url on agent profile kb upload |

package/api.ts

@@ -33734,6 +33734,32 @@ export namespace OrderAffiliateLedger {
     }
 }
 
+/**
+ * 
+ * @export
+ * @interface OrderAssignToAffiliateRequest
+ */
+export interface OrderAssignToAffiliateRequest {
+    /**
+     * Affiliate email to associate with the order
+     * @type {string}
+     * @memberof OrderAssignToAffiliateRequest
+     */
+    affiliate_email?: string;
+    /**
+     * Affiliate id to associate with the order
+     * @type {number}
+     * @memberof OrderAssignToAffiliateRequest
+     */
+    affiliate_id?: number;
+    /**
+     * Affiliate sub id to associate with the order
+     * @type {string}
+     * @memberof OrderAssignToAffiliateRequest
+     */
+    affiliate_sub_id?: string;
+}
+
 /**
  * 
  * @export
@@ -76908,6 +76934,72 @@ export const OrderApiFetchParamCreator = function (configuration?: Configuration
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Assigns an order to an affiliate. 
+         * @summary Assigns an order to an affiliate
+         * @param {string} order_id The order id to assign to the affiliate.
+         * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options: any = {}): FetchArgs {
+            // verify required parameter 'order_id' is not null or undefined
+            if (order_id === null || order_id === undefined) {
+                throw new RequiredError('order_id','Required parameter order_id was null or undefined when calling assignToAffiliate.');
+            }
+            // verify required parameter 'assign_to_affiliate_request' is not null or undefined
+            if (assign_to_affiliate_request === null || assign_to_affiliate_request === undefined) {
+                throw new RequiredError('assign_to_affiliate_request','Required parameter assign_to_affiliate_request was null or undefined when calling assignToAffiliate.');
+            }
+            const localVarPath = `/order/orders/{order_id}/assignToAffiliate`
+                .replace(`{${"order_id"}}`, encodeURIComponent(String(order_id)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, 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", ["order_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;
+            }
+
+            if (_expand !== undefined) {
+                localVarQueryParameter['_expand'] = _expand;
+            }
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            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);
+            const needsSerialization = (<any>"OrderAssignToAffiliateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify(assign_to_affiliate_request || {}) : (assign_to_affiliate_request || "");
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
          * @summary Set a refund block on an order
@@ -78782,6 +78874,29 @@ export const OrderApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Assigns an order to an affiliate. 
+         * @summary Assigns an order to an affiliate
+         * @param {string} order_id The order id to assign to the affiliate.
+         * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse> {
+            const localVarFetchArgs = OrderApiFetchParamCreator(configuration).assignToAffiliate(order_id, assign_to_affiliate_request, _expand, 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;
+                    }
+                });
+            };
+        },
         /**
          * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
          * @summary Set a refund block on an order
@@ -79470,6 +79585,18 @@ export const OrderApiFactory = function (configuration?: Configuration, fetch?:
         adjustOrderTotal(order_id: string, desired_total: string, options?: any) {
             return OrderApiFp(configuration).adjustOrderTotal(order_id, desired_total, options)(fetch, basePath);
         },
+        /**
+         * Assigns an order to an affiliate. 
+         * @summary Assigns an order to an affiliate
+         * @param {string} order_id The order id to assign to the affiliate.
+         * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options?: any) {
+            return OrderApiFp(configuration).assignToAffiliate(order_id, assign_to_affiliate_request, _expand, options)(fetch, basePath);
+        },
         /**
          * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
          * @summary Set a refund block on an order
@@ -79839,6 +79966,18 @@ export interface OrderApiInterface {
      */
     adjustOrderTotal(order_id: string, desired_total: string, options?: any): Promise<BaseResponse>;
 
+    /**
+     * Assigns an order to an affiliate. 
+     * @summary Assigns an order to an affiliate
+     * @param {string} order_id The order id to assign to the affiliate.
+     * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options?: any): Promise<OrderResponse>;
+
     /**
      * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
      * @summary Set a refund block on an order
@@ -80210,6 +80349,20 @@ export class OrderApi extends BaseAPI implements OrderApiInterface {
         return OrderApiFp(this.configuration).adjustOrderTotal(order_id, desired_total, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Assigns an order to an affiliate. 
+     * @summary Assigns an order to an affiliate
+     * @param {string} order_id The order id to assign to the affiliate.
+     * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    public assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options?: any) {
+        return OrderApiFp(this.configuration).assignToAffiliate(order_id, assign_to_affiliate_request, _expand, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
      * @summary Set a refund block on an order

package/dist/api.d.ts

@@ -33012,6 +33012,31 @@ export declare namespace OrderAffiliateLedger {
         PartiallyPaid
     }
 }
+/**
+ *
+ * @export
+ * @interface OrderAssignToAffiliateRequest
+ */
+export interface OrderAssignToAffiliateRequest {
+    /**
+     * Affiliate email to associate with the order
+     * @type {string}
+     * @memberof OrderAssignToAffiliateRequest
+     */
+    affiliate_email?: string;
+    /**
+     * Affiliate id to associate with the order
+     * @type {number}
+     * @memberof OrderAssignToAffiliateRequest
+     */
+    affiliate_id?: number;
+    /**
+     * Affiliate sub id to associate with the order
+     * @type {string}
+     * @memberof OrderAssignToAffiliateRequest
+     */
+    affiliate_sub_id?: string;
+}
 /**
  *
  * @export
@@ -58172,6 +58197,16 @@ export declare const OrderApiFetchParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     adjustOrderTotal(order_id: string, desired_total: string, options?: any): FetchArgs;
+    /**
+     * Assigns an order to an affiliate.
+     * @summary Assigns an order to an affiliate
+     * @param {string} order_id The order id to assign to the affiliate.
+     * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options?: any): FetchArgs;
     /**
      * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.
      * @summary Set a refund block on an order
@@ -58478,6 +58513,16 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     adjustOrderTotal(order_id: string, desired_total: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse>;
+    /**
+     * Assigns an order to an affiliate.
+     * @summary Assigns an order to an affiliate
+     * @param {string} order_id The order id to assign to the affiliate.
+     * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
     /**
      * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.
      * @summary Set a refund block on an order
@@ -58784,6 +58829,16 @@ export declare const OrderApiFactory: (configuration?: Configuration, fetch?: Fe
      * @throws {RequiredError}
      */
     adjustOrderTotal(order_id: string, desired_total: string, options?: any): Promise<BaseResponse>;
+    /**
+     * Assigns an order to an affiliate.
+     * @summary Assigns an order to an affiliate
+     * @param {string} order_id The order id to assign to the affiliate.
+     * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options?: any): Promise<OrderResponse>;
     /**
      * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.
      * @summary Set a refund block on an order
@@ -59092,6 +59147,17 @@ export interface OrderApiInterface {
      * @memberof OrderApiInterface
      */
     adjustOrderTotal(order_id: string, desired_total: string, options?: any): Promise<BaseResponse>;
+    /**
+     * Assigns an order to an affiliate.
+     * @summary Assigns an order to an affiliate
+     * @param {string} order_id The order id to assign to the affiliate.
+     * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options?: any): Promise<OrderResponse>;
     /**
      * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.
      * @summary Set a refund block on an order
@@ -59430,6 +59496,17 @@ export declare class OrderApi extends BaseAPI implements OrderApiInterface {
      * @memberof OrderApi
      */
     adjustOrderTotal(order_id: string, desired_total: string, options?: any): Promise<BaseResponse>;
+    /**
+     * Assigns an order to an affiliate.
+     * @summary Assigns an order to an affiliate
+     * @param {string} order_id The order id to assign to the affiliate.
+     * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    assignToAffiliate(order_id: string, assign_to_affiliate_request: OrderAssignToAffiliateRequest, _expand?: string, options?: any): Promise<OrderResponse>;
     /**
      * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.
      * @summary Set a refund block on an order

package/dist/api.js

@@ -27270,6 +27270,64 @@ var OrderApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Assigns an order to an affiliate.
+         * @summary Assigns an order to an affiliate
+         * @param {string} order_id The order id to assign to the affiliate.
+         * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        assignToAffiliate: function (order_id, assign_to_affiliate_request, _expand, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'order_id' is not null or undefined
+            if (order_id === null || order_id === undefined) {
+                throw new RequiredError('order_id', 'Required parameter order_id was null or undefined when calling assignToAffiliate.');
+            }
+            // verify required parameter 'assign_to_affiliate_request' is not null or undefined
+            if (assign_to_affiliate_request === null || assign_to_affiliate_request === undefined) {
+                throw new RequiredError('assign_to_affiliate_request', 'Required parameter assign_to_affiliate_request was null or undefined when calling assignToAffiliate.');
+            }
+            var localVarPath = "/order/orders/{order_id}/assignToAffiliate"
+                .replace("{".concat("order_id", "}"), encodeURIComponent(String(order_id)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'POST' }, 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", ["order_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;
+            }
+            if (_expand !== undefined) {
+                localVarQueryParameter['_expand'] = _expand;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            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);
+            var needsSerialization = ("OrderAssignToAffiliateRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body = needsSerialization ? JSON.stringify(assign_to_affiliate_request || {}) : (assign_to_affiliate_request || "");
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.
          * @summary Set a refund block on an order
@@ -28904,6 +28962,30 @@ var OrderApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Assigns an order to an affiliate.
+         * @summary Assigns an order to an affiliate
+         * @param {string} order_id The order id to assign to the affiliate.
+         * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        assignToAffiliate: function (order_id, assign_to_affiliate_request, _expand, options) {
+            var localVarFetchArgs = (0, exports.OrderApiFetchParamCreator)(configuration).assignToAffiliate(order_id, assign_to_affiliate_request, _expand, 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;
+                    }
+                });
+            };
+        },
         /**
          * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.
          * @summary Set a refund block on an order
@@ -29621,6 +29703,18 @@ var OrderApiFactory = function (configuration, fetch, basePath) {
         adjustOrderTotal: function (order_id, desired_total, options) {
             return (0, exports.OrderApiFp)(configuration).adjustOrderTotal(order_id, desired_total, options)(fetch, basePath);
         },
+        /**
+         * Assigns an order to an affiliate.
+         * @summary Assigns an order to an affiliate
+         * @param {string} order_id The order id to assign to the affiliate.
+         * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        assignToAffiliate: function (order_id, assign_to_affiliate_request, _expand, options) {
+            return (0, exports.OrderApiFp)(configuration).assignToAffiliate(order_id, assign_to_affiliate_request, _expand, options)(fetch, basePath);
+        },
         /**
          * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.
          * @summary Set a refund block on an order
@@ -29996,6 +30090,19 @@ var OrderApi = /** @class */ (function (_super) {
     OrderApi.prototype.adjustOrderTotal = function (order_id, desired_total, options) {
         return (0, exports.OrderApiFp)(this.configuration).adjustOrderTotal(order_id, desired_total, options)(this.fetch, this.basePath);
     };
+    /**
+     * Assigns an order to an affiliate.
+     * @summary Assigns an order to an affiliate
+     * @param {string} order_id The order id to assign to the affiliate.
+     * @param {OrderAssignToAffiliateRequest} assign_to_affiliate_request Assign to affiliate request
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApi
+     */
+    OrderApi.prototype.assignToAffiliate = function (order_id, assign_to_affiliate_request, _expand, options) {
+        return (0, exports.OrderApiFp)(this.configuration).assignToAffiliate(order_id, assign_to_affiliate_request, _expand, options)(this.fetch, this.basePath);
+    };
     /**
      * Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received.
      * @summary Set a refund block on an order

package/package.json

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