ultracart_rest_api_v2_typescript 4.1.84 → 4.1.85

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.84
+## ultracart_rest_api_v2_typescript@4.1.85
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.84 --save
+npm install ultracart_rest_api_v2_typescript@4.1.85 --save
 ```
 
 ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.85 | 05/05/2026 | improved warning object for customer insertCustomer and updateCustomer |
 | 4.1.84 | 05/04/2026 | Order API - add hold stage to allowed values on order query request |
 | 4.1.83 | 04/29/2026 | AO support for item appending on cancel request, order payment method test routing on hold release |
 | 4.1.82 | 04/27/2026 | converation - agent status and availability |

package/dist/apis/OrderApi.d.ts

@@ -53,6 +53,10 @@ export interface GeneratePackingSlipSpecificDCRequest {
     distributionCenterCode: string;
     orderId: string;
 }
+export interface GetAccountsReceivableDetailValueHistogramRequest {
+    detail: string;
+    gateway?: string;
+}
 export interface GetAccountsReceivableRetryStatsRequest {
     from?: string;
     to?: string;
@@ -348,6 +352,34 @@ export interface OrderApiInterface {
      * Generate a packing slip for this order for the given distribution center.
      */
     generatePackingSlipSpecificDC(requestParameters: GeneratePackingSlipSpecificDCRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPackingSlipResponse>;
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input.
+     * @summary Retrieve a value histogram for a given AR transaction-detail name
+     * @param {string} detail The transaction-detail name to histogram.
+     * @param {string} [gateway] The gateway name to scope to (optional).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getAccountsReceivableDetailValueHistogramRaw(requestParameters: GetAccountsReceivableDetailValueHistogramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input.
+     * Retrieve a value histogram for a given AR transaction-detail name
+     */
+    getAccountsReceivableDetailValueHistogram(requestParameters: GetAccountsReceivableDetailValueHistogramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal.
+     * @summary Retrieve gateway / detail-name picker data for the AR filter modal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getAccountsReceivableGatewayDetailNamesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal.
+     * Retrieve gateway / detail-name picker data for the AR filter modal
+     */
+    getAccountsReceivableGatewayDetailNames(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Retrieve A/R Retry Configuration. This is primarily an internal API call.  It is doubtful you would ever need to use it.
      * @summary Retrieve A/R Retry Configuration
@@ -843,6 +875,26 @@ export declare class OrderApi extends runtime.BaseAPI implements OrderApiInterfa
      * Generate a packing slip for this order for the given distribution center.
      */
     generatePackingSlipSpecificDC(requestParameters: GeneratePackingSlipSpecificDCRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPackingSlipResponse>;
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input.
+     * Retrieve a value histogram for a given AR transaction-detail name
+     */
+    getAccountsReceivableDetailValueHistogramRaw(requestParameters: GetAccountsReceivableDetailValueHistogramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input.
+     * Retrieve a value histogram for a given AR transaction-detail name
+     */
+    getAccountsReceivableDetailValueHistogram(requestParameters: GetAccountsReceivableDetailValueHistogramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal.
+     * Retrieve gateway / detail-name picker data for the AR filter modal
+     */
+    getAccountsReceivableGatewayDetailNamesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal.
+     * Retrieve gateway / detail-name picker data for the AR filter modal
+     */
+    getAccountsReceivableGatewayDetailNames(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Retrieve A/R Retry Configuration. This is primarily an internal API call.  It is doubtful you would ever need to use it.
      * Retrieve A/R Retry Configuration

package/dist/apis/OrderApi.js

@@ -751,6 +751,123 @@ var OrderApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input.
+     * Retrieve a value histogram for a given AR transaction-detail name
+     */
+    OrderApi.prototype.getAccountsReceivableDetailValueHistogramRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.detail === null || requestParameters.detail === undefined) {
+                            throw new runtime.RequiredError('detail', 'Required parameter requestParameters.detail was null or undefined when calling getAccountsReceivableDetailValueHistogram.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.gateway !== undefined) {
+                            queryParameters['gateway'] = requestParameters.gateway;
+                        }
+                        if (requestParameters.detail !== undefined) {
+                            queryParameters['detail'] = requestParameters.detail;
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/order/accounts_receivable/detail_value_histogram",
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input.
+     * Retrieve a value histogram for a given AR transaction-detail name
+     */
+    OrderApi.prototype.getAccountsReceivableDetailValueHistogram = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getAccountsReceivableDetailValueHistogramRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal.
+     * Retrieve gateway / detail-name picker data for the AR filter modal
+     */
+    OrderApi.prototype.getAccountsReceivableGatewayDetailNamesRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["order_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/order/accounts_receivable/gateway_detail_names",
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal.
+     * Retrieve gateway / detail-name picker data for the AR filter modal
+     */
+    OrderApi.prototype.getAccountsReceivableGatewayDetailNames = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getAccountsReceivableGatewayDetailNamesRaw(initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Retrieve A/R Retry Configuration. This is primarily an internal API call.  It is doubtful you would ever need to use it.
      * Retrieve A/R Retry Configuration

package/dist/models/Warning.d.ts

@@ -21,6 +21,12 @@ export interface Warning {
      * @memberof Warning
      */
     more_info?: string;
+    /**
+     * A stable machine-readable code identifying the warning. See API docs for known values.
+     * @type {string}
+     * @memberof Warning
+     */
+    warning_code?: string;
     /**
      * A technical message meant to be read by a developer
      * @type {string}

package/dist/models/Warning.js

@@ -33,6 +33,7 @@ function WarningFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'more_info': !(0, runtime_1.exists)(json, 'more_info') ? undefined : json['more_info'],
+        'warning_code': !(0, runtime_1.exists)(json, 'warning_code') ? undefined : json['warning_code'],
         'warning_message': !(0, runtime_1.exists)(json, 'warning_message') ? undefined : json['warning_message'],
     };
 }
@@ -46,6 +47,7 @@ function WarningToJSON(value) {
     }
     return {
         'more_info': value.more_info,
+        'warning_code': value.warning_code,
         'warning_message': value.warning_message,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.84",
+  "version": "4.1.85",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/OrderApi.ts

@@ -154,6 +154,11 @@ export interface GeneratePackingSlipSpecificDCRequest {
     orderId: string;
 }
 
+export interface GetAccountsReceivableDetailValueHistogramRequest {
+    detail: string;
+    gateway?: string;
+}
+
 export interface GetAccountsReceivableRetryStatsRequest {
     from?: string;
     to?: string;
@@ -493,6 +498,38 @@ export interface OrderApiInterface {
      */
     generatePackingSlipSpecificDC(requestParameters: GeneratePackingSlipSpecificDCRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderPackingSlipResponse>;
 
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input. 
+     * @summary Retrieve a value histogram for a given AR transaction-detail name
+     * @param {string} detail The transaction-detail name to histogram.
+     * @param {string} [gateway] The gateway name to scope to (optional).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getAccountsReceivableDetailValueHistogramRaw(requestParameters: GetAccountsReceivableDetailValueHistogramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input. 
+     * Retrieve a value histogram for a given AR transaction-detail name
+     */
+    getAccountsReceivableDetailValueHistogram(requestParameters: GetAccountsReceivableDetailValueHistogramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal. 
+     * @summary Retrieve gateway / detail-name picker data for the AR filter modal
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrderApiInterface
+     */
+    getAccountsReceivableGatewayDetailNamesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal. 
+     * Retrieve gateway / detail-name picker data for the AR filter modal
+     */
+    getAccountsReceivableGatewayDetailNames(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
     /**
      * Retrieve A/R Retry Configuration. This is primarily an internal API call.  It is doubtful you would ever need to use it. 
      * @summary Retrieve A/R Retry Configuration
@@ -1417,6 +1454,90 @@ export class OrderApi extends runtime.BaseAPI implements OrderApiInterface {
         return await response.value();
     }
 
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input. 
+     * Retrieve a value histogram for a given AR transaction-detail name
+     */
+    async getAccountsReceivableDetailValueHistogramRaw(requestParameters: GetAccountsReceivableDetailValueHistogramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters.detail === null || requestParameters.detail === undefined) {
+            throw new runtime.RequiredError('detail','Required parameter requestParameters.detail was null or undefined when calling getAccountsReceivableDetailValueHistogram.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.gateway !== undefined) {
+            queryParameters['gateway'] = requestParameters.gateway;
+        }
+
+        if (requestParameters.detail !== undefined) {
+            queryParameters['detail'] = requestParameters.detail;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["order_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/order/accounts_receivable/detail_value_histogram`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal\'s autocomplete on the detail-value input. 
+     * Retrieve a value histogram for a given AR transaction-detail name
+     */
+    async getAccountsReceivableDetailValueHistogram(requestParameters: GetAccountsReceivableDetailValueHistogramRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getAccountsReceivableDetailValueHistogramRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal. 
+     * Retrieve gateway / detail-name picker data for the AR filter modal
+     */
+    async getAccountsReceivableGatewayDetailNamesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["order_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/order/accounts_receivable/gateway_detail_names`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * For the calling merchant\'s Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal. 
+     * Retrieve gateway / detail-name picker data for the AR filter modal
+     */
+    async getAccountsReceivableGatewayDetailNames(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getAccountsReceivableGatewayDetailNamesRaw(initOverrides);
+    }
+
     /**
      * Retrieve A/R Retry Configuration. This is primarily an internal API call.  It is doubtful you would ever need to use it. 
      * Retrieve A/R Retry Configuration

package/src/models/Warning.ts

@@ -25,6 +25,12 @@ export interface Warning {
      * @memberof Warning
      */
     more_info?: string;
+    /**
+     * A stable machine-readable code identifying the warning. See API docs for known values.
+     * @type {string}
+     * @memberof Warning
+     */
+    warning_code?: string;
     /**
      * A technical message meant to be read by a developer
      * @type {string}
@@ -55,6 +61,7 @@ export function WarningFromJSONTyped(json: any, ignoreDiscriminator: boolean): W
     return {
         
         'more_info': !exists(json, 'more_info') ? undefined : json['more_info'],
+        'warning_code': !exists(json, 'warning_code') ? undefined : json['warning_code'],
         'warning_message': !exists(json, 'warning_message') ? undefined : json['warning_message'],
     };
 }
@@ -69,6 +76,7 @@ export function WarningToJSON(value?: Warning | null): any {
     return {
         
         'more_info': value.more_info,
+        'warning_code': value.warning_code,
         'warning_message': value.warning_message,
     };
 }