ultracart_rest_api_v2_typescript 3.11.33 → 3.11.35

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.11.33
+## ultracart_rest_api_v2_typescript@3.11.35
 
 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.33 --save
+npm install ultracart_rest_api_v2_typescript@3.11.35 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.35 | 12/02/2025 | caching option added to getCustomers, created new method searchCustomers |
+| 3.11.34 | 12/02/2025 | coupons - added optional free specific shipping method to two coupons |
 | 3.11.33 | 11/26/2025 | conversation - AI agent profile fields |
 | 3.11.32 | 11/20/2025 | conversion api bug fix on incorrect signature |
 | 3.11.31 | 11/20/2025 | conversation - AI agent mcp server tools function |

package/api.ts

@@ -13619,6 +13619,12 @@ export interface CouponFreeItemWithItemPurchaseAndFreeShipping {
      * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
      */
     required_purchase_items?: Array<string>;
+    /**
+     * One or more shipping methods that may be used with this coupon.  If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods
+     * @type {Array<string>}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    shipping_methods?: Array<string>;
 }
 
 /**
@@ -14117,6 +14123,12 @@ export interface CouponPercentOffItemsAndFreeShipping {
      * @memberof CouponPercentOffItemsAndFreeShipping
      */
     items?: Array<string>;
+    /**
+     * One or more shipping methods that may be used with this coupon.  If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods
+     * @type {Array<string>}
+     * @memberof CouponPercentOffItemsAndFreeShipping
+     */
+    shipping_methods?: Array<string>;
 }
 
 /**
@@ -17321,6 +17333,12 @@ export interface CustomerQuery {
      * @memberof CustomerQuery
      */
     qb_class?: string;
+    /**
+     * Query Target
+     * @type {string}
+     * @memberof CustomerQuery
+     */
+    query_target?: CustomerQuery.QueryTargetEnum;
     /**
      * QuickBooks name to import this customer as
      * @type {string}
@@ -17395,6 +17413,21 @@ export interface CustomerQuery {
     signup_dts_start?: string;
 }
 
+/**
+ * @export
+ * @namespace CustomerQuery
+ */
+export namespace CustomerQuery {
+    /**
+     * @export
+     * @enum {string}
+     */
+    export enum QueryTargetEnum {
+        Origin = <any> 'origin',
+        Cache = <any> 'cache'
+    }
+}
+
 /**
  * 
  * @export
@@ -18968,6 +19001,24 @@ export interface EmailCommseq {
  * @interface EmailCommseqEmail
  */
 export interface EmailCommseqEmail {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof EmailCommseqEmail
+     */
+    ai_generation?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailCommseqEmail
+     */
+    ai_generation_prompt?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof EmailCommseqEmail
+     */
+    ai_generation_user_id?: number;
     /**
      * Deleted
      * @type {boolean}
@@ -67272,6 +67323,92 @@ export const CustomerApiFetchParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates. 
+         * @summary Search for customers
+         * @param {string} [search_string] Search
+         * @param {string} [signup_dts_start] Signup date start
+         * @param {string} [signup_dts_end] Signup date end
+         * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+         * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+         * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+         * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options: any = {}): FetchArgs {
+            const localVarPath = `/customer/customers/search`;
+            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", ["customer_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;
+            }
+
+            if (search_string !== undefined) {
+                localVarQueryParameter['search_string'] = search_string;
+            }
+
+            if (signup_dts_start !== undefined) {
+                localVarQueryParameter['signup_dts_start'] = signup_dts_start;
+            }
+
+            if (signup_dts_end !== undefined) {
+                localVarQueryParameter['signup_dts_end'] = signup_dts_end;
+            }
+
+            if (_limit !== undefined) {
+                localVarQueryParameter['_limit'] = _limit;
+            }
+
+            if (_offset !== undefined) {
+                localVarQueryParameter['_offset'] = _offset;
+            }
+
+            if (_since !== undefined) {
+                localVarQueryParameter['_since'] = _since;
+            }
+
+            if (_sort !== undefined) {
+                localVarQueryParameter['_sort'] = _sort;
+            }
+
+            if (_expand !== undefined) {
+                localVarQueryParameter['_expand'] = _expand;
+            }
+
+            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,
+            };
+        },
         /**
          * Update a customer on the UltraCart account. 
          * @summary Update a customer
@@ -67995,6 +68132,34 @@ export const CustomerApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates. 
+         * @summary Search for customers
+         * @param {string} [search_string] Search
+         * @param {string} [signup_dts_start] Signup date start
+         * @param {string} [signup_dts_end] Signup date end
+         * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+         * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+         * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+         * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomersResponse> {
+            const localVarFetchArgs = CustomerApiFetchParamCreator(configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _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;
+                    }
+                });
+            };
+        },
         /**
          * Update a customer on the UltraCart account. 
          * @summary Update a customer
@@ -68338,6 +68503,23 @@ export const CustomerApiFactory = function (configuration?: Configuration, fetch
         searchCustomerProfileValues(lookup_request: LookupRequest, options?: any) {
             return CustomerApiFp(configuration).searchCustomerProfileValues(lookup_request, options)(fetch, basePath);
         },
+        /**
+         * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates. 
+         * @summary Search for customers
+         * @param {string} [search_string] Search
+         * @param {string} [signup_dts_start] Signup date start
+         * @param {string} [signup_dts_end] Signup date end
+         * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+         * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+         * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+         * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any) {
+            return CustomerApiFp(configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options)(fetch, basePath);
+        },
         /**
          * Update a customer on the UltraCart account. 
          * @summary Update a customer
@@ -68637,6 +68819,23 @@ export interface CustomerApiInterface {
      */
     searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
 
+    /**
+     * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates. 
+     * @summary Search for customers
+     * @param {string} [search_string] Search
+     * @param {string} [signup_dts_start] Signup date start
+     * @param {string} [signup_dts_end] Signup date end
+     * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+     * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any): Promise<CustomersResponse>;
+
     /**
      * Update a customer on the UltraCart account. 
      * @summary Update a customer
@@ -68976,6 +69175,25 @@ export class CustomerApi extends BaseAPI implements CustomerApiInterface {
         return CustomerApiFp(this.configuration).searchCustomerProfileValues(lookup_request, options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates. 
+     * @summary Search for customers
+     * @param {string} [search_string] Search
+     * @param {string} [signup_dts_start] Signup date start
+     * @param {string} [signup_dts_end] Signup date end
+     * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+     * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    public searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any) {
+        return CustomerApiFp(this.configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Update a customer on the UltraCart account. 
      * @summary Update a customer

package/dist/api.d.ts

@@ -13299,6 +13299,12 @@ export interface CouponFreeItemWithItemPurchaseAndFreeShipping {
      * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
      */
     required_purchase_items?: Array<string>;
+    /**
+     * One or more shipping methods that may be used with this coupon.  If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods
+     * @type {Array<string>}
+     * @memberof CouponFreeItemWithItemPurchaseAndFreeShipping
+     */
+    shipping_methods?: Array<string>;
 }
 /**
  *
@@ -13779,6 +13785,12 @@ export interface CouponPercentOffItemsAndFreeShipping {
      * @memberof CouponPercentOffItemsAndFreeShipping
      */
     items?: Array<string>;
+    /**
+     * One or more shipping methods that may be used with this coupon.  If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods
+     * @type {Array<string>}
+     * @memberof CouponPercentOffItemsAndFreeShipping
+     */
+    shipping_methods?: Array<string>;
 }
 /**
  *
@@ -16908,6 +16920,12 @@ export interface CustomerQuery {
      * @memberof CustomerQuery
      */
     qb_class?: string;
+    /**
+     * Query Target
+     * @type {string}
+     * @memberof CustomerQuery
+     */
+    query_target?: CustomerQuery.QueryTargetEnum;
     /**
      * QuickBooks name to import this customer as
      * @type {string}
@@ -16981,6 +16999,20 @@ export interface CustomerQuery {
      */
     signup_dts_start?: string;
 }
+/**
+ * @export
+ * @namespace CustomerQuery
+ */
+export declare namespace CustomerQuery {
+    /**
+     * @export
+     * @enum {string}
+     */
+    enum QueryTargetEnum {
+        Origin,
+        Cache
+    }
+}
 /**
  *
  * @export
@@ -18524,6 +18556,24 @@ export interface EmailCommseq {
  * @interface EmailCommseqEmail
  */
 export interface EmailCommseqEmail {
+    /**
+     *
+     * @type {boolean}
+     * @memberof EmailCommseqEmail
+     */
+    ai_generation?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof EmailCommseqEmail
+     */
+    ai_generation_prompt?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof EmailCommseqEmail
+     */
+    ai_generation_user_id?: number;
     /**
      * Deleted
      * @type {boolean}
@@ -53980,6 +54030,21 @@ export declare const CustomerApiFetchParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): FetchArgs;
+    /**
+     * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates.
+     * @summary Search for customers
+     * @param {string} [search_string] Search
+     * @param {string} [signup_dts_start] Signup date start
+     * @param {string} [signup_dts_end] Signup date end
+     * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+     * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any): FetchArgs;
     /**
      * Update a customer on the UltraCart account.
      * @summary Update a customer
@@ -54228,6 +54293,21 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<LookupResponse>;
+    /**
+     * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates.
+     * @summary Search for customers
+     * @param {string} [search_string] Search
+     * @param {string} [signup_dts_start] Signup date start
+     * @param {string} [signup_dts_end] Signup date end
+     * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+     * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomersResponse>;
     /**
      * Update a customer on the UltraCart account.
      * @summary Update a customer
@@ -54476,6 +54556,21 @@ export declare const CustomerApiFactory: (configuration?: Configuration, fetch?:
      * @throws {RequiredError}
      */
     searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
+    /**
+     * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates.
+     * @summary Search for customers
+     * @param {string} [search_string] Search
+     * @param {string} [signup_dts_start] Signup date start
+     * @param {string} [signup_dts_end] Signup date end
+     * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+     * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any): Promise<CustomersResponse>;
     /**
      * Update a customer on the UltraCart account.
      * @summary Update a customer
@@ -54745,6 +54840,22 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
+    /**
+     * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates.
+     * @summary Search for customers
+     * @param {string} [search_string] Search
+     * @param {string} [signup_dts_start] Signup date start
+     * @param {string} [signup_dts_end] Signup date end
+     * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+     * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any): Promise<CustomersResponse>;
     /**
      * Update a customer on the UltraCart account.
      * @summary Update a customer
@@ -55019,6 +55130,22 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
+    /**
+     * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates.
+     * @summary Search for customers
+     * @param {string} [search_string] Search
+     * @param {string} [signup_dts_start] Signup date start
+     * @param {string} [signup_dts_end] Signup date end
+     * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+     * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any): Promise<CustomersResponse>;
     /**
      * Update a customer on the UltraCart account.
      * @summary Update a customer

package/dist/api.js

@@ -28,10 +28,10 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ItemShippingMethod = exports.ItemShippingDestinationRestriction = exports.ItemReview = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.Coupon = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationVirtualAgentCapabilities = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationPbxVoicemailMessageSummary = exports.ConversationPbxVoicemailMessage = exports.ConversationPbxVoicemailMailbox = exports.ConversationPbxTimeBasedMapping = exports.ConversationPbxPhoneNumber = exports.ConversationPbxMenuMapping = exports.ConversationPbxMenu = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationMcpServer = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
-exports.CheckoutApi = exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.WorkflowTasksRequest = exports.WorkflowTask = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQueryBatch = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderCurrentStageHistory = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = void 0;
-exports.TaxApiFp = exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = void 0;
-exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = void 0;
+exports.ItemShippingDestinationRestriction = exports.ItemReview = exports.ItemRestrictionItem = exports.ItemRelatedItem = exports.ItemOptionValue = exports.ItemOption = exports.ItemContentMultimedia = exports.ItemAutoOrderStep = exports.Experiment = exports.EmailPerformance = exports.EmailCommseqStep = exports.Distance = exports.CustomerQuery = exports.Coupon = exports.ConversationWebsocketMessage = exports.ConversationWebchatQueueStatusUpdateRequest = exports.ConversationWebchatQueueStatusAgent = exports.ConversationVirtualAgentCapabilities = exports.ConversationSummary = exports.ConversationSentiment = exports.ConversationPbxVoicemailMessageSummary = exports.ConversationPbxVoicemailMessage = exports.ConversationPbxVoicemailMailbox = exports.ConversationPbxTimeBasedMapping = exports.ConversationPbxPhoneNumber = exports.ConversationPbxMenuMapping = exports.ConversationPbxMenu = exports.ConversationMessageTransportStatus = exports.ConversationMessage = exports.ConversationMcpServer = exports.ConversationEventRRWeb = exports.ConversationEngagementEquationFunction = exports.ConversationEngagement = exports.ConversationAgentProfile = exports.Conversation = exports.CheckoutHandoffRequest = exports.ChannelPartnerOrderItem = exports.ChannelPartnerOrder = exports.CartKitComponentOption = exports.CartItemOption = exports.CartItemMultimedia = exports.CartCustomerProfileCreditCard = exports.AutoOrderItemSimpleSchedule = exports.AutoOrderItem = exports.AutoOrder = exports.AffiliateLink = exports.AffiliateLedger = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = void 0;
+exports.CheckoutApiFactory = exports.CheckoutApiFp = exports.CheckoutApiFetchParamCreator = exports.ChannelPartnerApi = exports.ChannelPartnerApiFactory = exports.ChannelPartnerApiFp = exports.ChannelPartnerApiFetchParamCreator = exports.AutoOrderApi = exports.AutoOrderApiFactory = exports.AutoOrderApiFp = exports.AutoOrderApiFetchParamCreator = exports.AffiliateApi = exports.AffiliateApiFactory = exports.AffiliateApiFp = exports.AffiliateApiFetchParamCreator = exports.WorkflowTasksRequest = exports.WorkflowTask = exports.Weight = exports.Webhook = exports.TempMultimedia = exports.ReportWebsocketEvent = exports.ReportPageVisualizationMetric = exports.ReportPageVisualization = exports.ReportFilter = exports.ReportExecuteQueriesRequest = exports.ReportDataSourceSchema = exports.ReportDataSetSchema = exports.ReportDataSetQuery = exports.ReportDataSet = exports.Report = exports.PointOfSaleReader = exports.OrderQueryBatch = exports.OrderQuery = exports.OrderPaymentECheck = exports.OrderPaymentCreditCard = exports.OrderPayment = exports.OrderItemOption = exports.OrderItem = exports.OrderFraudScore = exports.OrderFormat = exports.OrderEdiDocument = exports.OrderCurrentStageHistory = exports.OrderAutoOrder = exports.OrderAffiliateLedger = exports.Order = exports.OauthTokenResponse = exports.ItemThirdPartyEmailMarketing = exports.ItemTax = exports.ItemTag = exports.ItemShippingMethod = void 0;
+exports.TaxApiFetchParamCreator = exports.StorefrontApi = exports.StorefrontApiFactory = exports.StorefrontApiFp = exports.StorefrontApiFetchParamCreator = exports.SsoApi = exports.SsoApiFactory = exports.SsoApiFp = exports.SsoApiFetchParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiFetchParamCreator = exports.OauthApi = exports.OauthApiFactory = exports.OauthApiFp = exports.OauthApiFetchParamCreator = exports.ItemApi = exports.ItemApiFactory = exports.ItemApiFp = exports.ItemApiFetchParamCreator = exports.IntegrationLogApi = exports.IntegrationLogApiFactory = exports.IntegrationLogApiFp = exports.IntegrationLogApiFetchParamCreator = exports.GiftCertificateApi = exports.GiftCertificateApiFactory = exports.GiftCertificateApiFp = exports.GiftCertificateApiFetchParamCreator = exports.FulfillmentApi = exports.FulfillmentApiFactory = exports.FulfillmentApiFp = exports.FulfillmentApiFetchParamCreator = exports.DatawarehouseApi = exports.DatawarehouseApiFactory = exports.DatawarehouseApiFp = exports.DatawarehouseApiFetchParamCreator = exports.CustomerApi = exports.CustomerApiFactory = exports.CustomerApiFp = exports.CustomerApiFetchParamCreator = exports.CouponApi = exports.CouponApiFactory = exports.CouponApiFp = exports.CouponApiFetchParamCreator = exports.ConversationApi = exports.ConversationApiFactory = exports.ConversationApiFp = exports.ConversationApiFetchParamCreator = exports.CheckoutApi = void 0;
+exports.WorkflowApi = exports.WorkflowApiFactory = exports.WorkflowApiFp = exports.WorkflowApiFetchParamCreator = exports.WebhookApi = exports.WebhookApiFactory = exports.WebhookApiFp = exports.WebhookApiFetchParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiFetchParamCreator = exports.TaxApi = exports.TaxApiFactory = exports.TaxApiFp = void 0;
 var url = require("url");
 var portableFetch = require("portable-fetch");
 var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
@@ -887,6 +887,22 @@ var Coupon;
         UsableByEnum[UsableByEnum["OncePerNewCustomerForItem"] = 'OncePerNewCustomerForItem'] = "OncePerNewCustomerForItem";
     })(UsableByEnum = Coupon.UsableByEnum || (Coupon.UsableByEnum = {}));
 })(Coupon = exports.Coupon || (exports.Coupon = {}));
+/**
+ * @export
+ * @namespace CustomerQuery
+ */
+var CustomerQuery;
+(function (CustomerQuery) {
+    /**
+     * @export
+     * @enum {string}
+     */
+    var QueryTargetEnum;
+    (function (QueryTargetEnum) {
+        QueryTargetEnum[QueryTargetEnum["Origin"] = 'origin'] = "Origin";
+        QueryTargetEnum[QueryTargetEnum["Cache"] = 'cache'] = "Cache";
+    })(QueryTargetEnum = CustomerQuery.QueryTargetEnum || (CustomerQuery.QueryTargetEnum = {}));
+})(CustomerQuery = exports.CustomerQuery || (exports.CustomerQuery = {}));
 /**
  * @export
  * @namespace Distance
@@ -18976,6 +18992,78 @@ var CustomerApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates.
+         * @summary Search for customers
+         * @param {string} [search_string] Search
+         * @param {string} [signup_dts_start] Signup date start
+         * @param {string} [signup_dts_end] Signup date end
+         * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+         * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+         * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+         * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        searchCustomers: function (search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options) {
+            if (options === void 0) { options = {}; }
+            var localVarPath = "/customer/customers/search";
+            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", ["customer_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;
+            }
+            if (search_string !== undefined) {
+                localVarQueryParameter['search_string'] = search_string;
+            }
+            if (signup_dts_start !== undefined) {
+                localVarQueryParameter['signup_dts_start'] = signup_dts_start;
+            }
+            if (signup_dts_end !== undefined) {
+                localVarQueryParameter['signup_dts_end'] = signup_dts_end;
+            }
+            if (_limit !== undefined) {
+                localVarQueryParameter['_limit'] = _limit;
+            }
+            if (_offset !== undefined) {
+                localVarQueryParameter['_offset'] = _offset;
+            }
+            if (_since !== undefined) {
+                localVarQueryParameter['_since'] = _since;
+            }
+            if (_sort !== undefined) {
+                localVarQueryParameter['_sort'] = _sort;
+            }
+            if (_expand !== undefined) {
+                localVarQueryParameter['_expand'] = _expand;
+            }
+            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,
+            };
+        },
         /**
          * Update a customer on the UltraCart account.
          * @summary Update a customer
@@ -19690,6 +19778,35 @@ var CustomerApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates.
+         * @summary Search for customers
+         * @param {string} [search_string] Search
+         * @param {string} [signup_dts_start] Signup date start
+         * @param {string} [signup_dts_end] Signup date end
+         * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+         * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+         * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+         * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        searchCustomers: function (search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options) {
+            var localVarFetchArgs = (0, exports.CustomerApiFetchParamCreator)(configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _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;
+                    }
+                });
+            };
+        },
         /**
          * Update a customer on the UltraCart account.
          * @summary Update a customer
@@ -20037,6 +20154,23 @@ var CustomerApiFactory = function (configuration, fetch, basePath) {
         searchCustomerProfileValues: function (lookup_request, options) {
             return (0, exports.CustomerApiFp)(configuration).searchCustomerProfileValues(lookup_request, options)(fetch, basePath);
         },
+        /**
+         * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates.
+         * @summary Search for customers
+         * @param {string} [search_string] Search
+         * @param {string} [signup_dts_start] Signup date start
+         * @param {string} [signup_dts_end] Signup date end
+         * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+         * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+         * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+         * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+         * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        searchCustomers: function (search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options) {
+            return (0, exports.CustomerApiFp)(configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options)(fetch, basePath);
+        },
         /**
          * Update a customer on the UltraCart account.
          * @summary Update a customer
@@ -20361,6 +20495,24 @@ var CustomerApi = /** @class */ (function (_super) {
     CustomerApi.prototype.searchCustomerProfileValues = function (lookup_request, options) {
         return (0, exports.CustomerApiFp)(this.configuration).searchCustomerProfileValues(lookup_request, options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieves customers from the account by matching the search value against most customer fields.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.  This search also goes against the cache so updates should not be performed with these result objects.  Always re-query the individual customer profile if you are going to make updates.
+     * @summary Search for customers
+     * @param {string} [search_string] Search
+     * @param {string} [signup_dts_start] Signup date start
+     * @param {string} [signup_dts_end] Signup date end
+     * @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
+     * @param {number} [_offset] Pagination of the record set.  Offset is a zero based index.
+     * @param {string} [_since] Fetch customers that have been created/modified since this date/time.
+     * @param {string} [_sort] The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+     * @param {string} [_expand] The object expansion to perform on the result.  See documentation for examples
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    CustomerApi.prototype.searchCustomers = function (search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options) {
+        return (0, exports.CustomerApiFp)(this.configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options)(this.fetch, this.basePath);
+    };
     /**
      * Update a customer on the UltraCart account.
      * @summary Update a customer

package/package.json

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