ultracart_rest_api_v2_typescript 4.1.34 → 4.1.35

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.34
+## ultracart_rest_api_v2_typescript@4.1.35
 
 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.34 --save
+npm install ultracart_rest_api_v2_typescript@4.1.35 --save
 ```
 
 ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.35 | 12/02/2025 | caching option added to getCustomers, created new method searchCustomers |
 | 4.1.34 | 12/02/2025 | coupons - added optional free specific shipping method to two coupons |
 | 4.1.33 | 11/26/2025 | conversation - AI agent profile fields |
 | 4.1.32 | 11/20/2025 | conversion api bug fix on incorrect signature |

package/dist/apis/CustomerApi.d.ts

@@ -112,6 +112,16 @@ export interface MergeCustomerRequest {
 export interface SearchCustomerProfileValuesRequest {
     lookupRequest: LookupRequest;
 }
+export interface SearchCustomersRequest {
+    searchString?: string;
+    signupDtsStart?: string;
+    signupDtsEnd?: string;
+    limit?: number;
+    offset?: number;
+    since?: string;
+    sort?: string;
+    expand?: string;
+}
 export interface UpdateCustomerRequest {
     customerProfileOid: number;
     customer: Customer;
@@ -460,6 +470,27 @@ export interface CustomerApiInterface {
      * Searches for all matching values (using POST)
      */
     searchCustomerProfileValues(requestParameters: SearchCustomerProfileValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): 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} [searchString] Search
+     * @param {string} [signupDtsStart] Signup date start
+     * @param {string} [signupDtsEnd] 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
+     */
+    searchCustomersRaw(requestParameters: SearchCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomersResponse>>;
+    /**
+     * 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.
+     * Search for customers
+     */
+    searchCustomers(requestParameters: SearchCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomersResponse>;
     /**
      * Update a customer on the UltraCart account.
      * @summary Update a customer
@@ -724,6 +755,16 @@ export declare class CustomerApi extends runtime.BaseAPI implements CustomerApiI
      * Searches for all matching values (using POST)
      */
     searchCustomerProfileValues(requestParameters: SearchCustomerProfileValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): 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.
+     * Search for customers
+     */
+    searchCustomersRaw(requestParameters: SearchCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomersResponse>>;
+    /**
+     * 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.
+     * Search for customers
+     */
+    searchCustomers(requestParameters?: SearchCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomersResponse>;
     /**
      * Update a customer on the UltraCart account.
      * Update a customer

package/dist/apis/CustomerApi.js

@@ -1403,6 +1403,87 @@ var CustomerApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Search for customers
+     */
+    CustomerApi.prototype.searchCustomersRaw = 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:
+                        queryParameters = {};
+                        if (requestParameters.searchString !== undefined) {
+                            queryParameters['search_string'] = requestParameters.searchString;
+                        }
+                        if (requestParameters.signupDtsStart !== undefined) {
+                            queryParameters['signup_dts_start'] = requestParameters.signupDtsStart;
+                        }
+                        if (requestParameters.signupDtsEnd !== undefined) {
+                            queryParameters['signup_dts_end'] = requestParameters.signupDtsEnd;
+                        }
+                        if (requestParameters.limit !== undefined) {
+                            queryParameters['_limit'] = requestParameters.limit;
+                        }
+                        if (requestParameters.offset !== undefined) {
+                            queryParameters['_offset'] = requestParameters.offset;
+                        }
+                        if (requestParameters.since !== undefined) {
+                            queryParameters['_since'] = requestParameters.since;
+                        }
+                        if (requestParameters.sort !== undefined) {
+                            queryParameters['_sort'] = requestParameters.sort;
+                        }
+                        if (requestParameters.expand !== undefined) {
+                            queryParameters['_expand'] = requestParameters.expand;
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["customer_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: "/customer/customers/search",
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomersResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Search for customers
+     */
+    CustomerApi.prototype.searchCustomers = function (requestParameters, initOverrides) {
+        if (requestParameters === void 0) { requestParameters = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.searchCustomersRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Update a customer on the UltraCart account.
      * Update a customer

package/dist/models/CustomerQuery.d.ts

@@ -123,6 +123,12 @@ export interface CustomerQuery {
      * @memberof CustomerQuery
      */
     qb_class?: string;
+    /**
+     * Query Target
+     * @type {string}
+     * @memberof CustomerQuery
+     */
+    query_target?: CustomerQueryQueryTargetEnum;
     /**
      * QuickBooks name to import this customer as
      * @type {string}
@@ -196,6 +202,14 @@ export interface CustomerQuery {
      */
     signup_dts_start?: string;
 }
+/**
+ * @export
+ */
+export declare const CustomerQueryQueryTargetEnum: {
+    readonly Origin: "origin";
+    readonly Cache: "cache";
+};
+export type CustomerQueryQueryTargetEnum = typeof CustomerQueryQueryTargetEnum[keyof typeof CustomerQueryQueryTargetEnum];
 /**
  * Check if a given object implements the CustomerQuery interface.
  */

package/dist/models/CustomerQuery.js

@@ -13,8 +13,15 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomerQueryToJSON = exports.CustomerQueryFromJSONTyped = exports.CustomerQueryFromJSON = exports.instanceOfCustomerQuery = void 0;
+exports.CustomerQueryToJSON = exports.CustomerQueryFromJSONTyped = exports.CustomerQueryFromJSON = exports.instanceOfCustomerQuery = exports.CustomerQueryQueryTargetEnum = void 0;
 var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.CustomerQueryQueryTargetEnum = {
+    Origin: 'origin',
+    Cache: 'cache'
+};
 /**
  * Check if a given object implements the CustomerQuery interface.
  */
@@ -50,6 +57,7 @@ function CustomerQueryFromJSONTyped(json, ignoreDiscriminator) {
         'pricing_tier_name': !(0, runtime_1.exists)(json, 'pricing_tier_name') ? undefined : json['pricing_tier_name'],
         'pricing_tier_oid': !(0, runtime_1.exists)(json, 'pricing_tier_oid') ? undefined : json['pricing_tier_oid'],
         'qb_class': !(0, runtime_1.exists)(json, 'qb_class') ? undefined : json['qb_class'],
+        'query_target': !(0, runtime_1.exists)(json, 'query_target') ? undefined : json['query_target'],
         'quickbooks_code': !(0, runtime_1.exists)(json, 'quickbooks_code') ? undefined : json['quickbooks_code'],
         'shipping_city': !(0, runtime_1.exists)(json, 'shipping_city') ? undefined : json['shipping_city'],
         'shipping_company': !(0, runtime_1.exists)(json, 'shipping_company') ? undefined : json['shipping_company'],
@@ -91,6 +99,7 @@ function CustomerQueryToJSON(value) {
         'pricing_tier_name': value.pricing_tier_name,
         'pricing_tier_oid': value.pricing_tier_oid,
         'qb_class': value.qb_class,
+        'query_target': value.query_target,
         'quickbooks_code': value.quickbooks_code,
         'shipping_city': value.shipping_city,
         'shipping_company': value.shipping_company,

package/dist/models/EmailCommseqEmail.d.ts

@@ -15,6 +15,24 @@
  * @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}

package/dist/models/EmailCommseqEmail.js

@@ -32,6 +32,9 @@ function EmailCommseqEmailFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'ai_generation': !(0, runtime_1.exists)(json, 'ai_generation') ? undefined : json['ai_generation'],
+        'ai_generation_prompt': !(0, runtime_1.exists)(json, 'ai_generation_prompt') ? undefined : json['ai_generation_prompt'],
+        'ai_generation_user_id': !(0, runtime_1.exists)(json, 'ai_generation_user_id') ? undefined : json['ai_generation_user_id'],
         'deleted': !(0, runtime_1.exists)(json, 'deleted') ? undefined : json['deleted'],
         'edited_by_user': !(0, runtime_1.exists)(json, 'edited_by_user') ? undefined : json['edited_by_user'],
         'email_communication_sequence_email_uuid': !(0, runtime_1.exists)(json, 'email_communication_sequence_email_uuid') ? undefined : json['email_communication_sequence_email_uuid'],
@@ -77,6 +80,9 @@ function EmailCommseqEmailToJSON(value) {
         return null;
     }
     return {
+        'ai_generation': value.ai_generation,
+        'ai_generation_prompt': value.ai_generation_prompt,
+        'ai_generation_user_id': value.ai_generation_user_id,
         'deleted': value.deleted,
         'edited_by_user': value.edited_by_user,
         'email_communication_sequence_email_uuid': value.email_communication_sequence_email_uuid,

package/package.json

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

package/src/apis/CustomerApi.ts

@@ -211,6 +211,17 @@ export interface SearchCustomerProfileValuesRequest {
     lookupRequest: LookupRequest;
 }
 
+export interface SearchCustomersRequest {
+    searchString?: string;
+    signupDtsStart?: string;
+    signupDtsEnd?: string;
+    limit?: number;
+    offset?: number;
+    since?: string;
+    sort?: string;
+    expand?: string;
+}
+
 export interface UpdateCustomerRequest {
     customerProfileOid: number;
     customer: Customer;
@@ -603,6 +614,29 @@ export interface CustomerApiInterface {
      */
     searchCustomerProfileValues(requestParameters: SearchCustomerProfileValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): 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} [searchString] Search
+     * @param {string} [signupDtsStart] Signup date start
+     * @param {string} [signupDtsEnd] 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
+     */
+    searchCustomersRaw(requestParameters: SearchCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomersResponse>>;
+
+    /**
+     * 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. 
+     * Search for customers
+     */
+    searchCustomers(requestParameters: SearchCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomersResponse>;
+
     /**
      * Update a customer on the UltraCart account. 
      * @summary Update a customer
@@ -1702,6 +1736,75 @@ export class CustomerApi extends runtime.BaseAPI implements CustomerApiInterface
         return await response.value();
     }
 
+    /**
+     * 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. 
+     * Search for customers
+     */
+    async searchCustomersRaw(requestParameters: SearchCustomersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomersResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters.searchString !== undefined) {
+            queryParameters['search_string'] = requestParameters.searchString;
+        }
+
+        if (requestParameters.signupDtsStart !== undefined) {
+            queryParameters['signup_dts_start'] = requestParameters.signupDtsStart;
+        }
+
+        if (requestParameters.signupDtsEnd !== undefined) {
+            queryParameters['signup_dts_end'] = requestParameters.signupDtsEnd;
+        }
+
+        if (requestParameters.limit !== undefined) {
+            queryParameters['_limit'] = requestParameters.limit;
+        }
+
+        if (requestParameters.offset !== undefined) {
+            queryParameters['_offset'] = requestParameters.offset;
+        }
+
+        if (requestParameters.since !== undefined) {
+            queryParameters['_since'] = requestParameters.since;
+        }
+
+        if (requestParameters.sort !== undefined) {
+            queryParameters['_sort'] = requestParameters.sort;
+        }
+
+        if (requestParameters.expand !== undefined) {
+            queryParameters['_expand'] = requestParameters.expand;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["customer_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: `/customer/customers/search`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CustomersResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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. 
+     * Search for customers
+     */
+    async searchCustomers(requestParameters: SearchCustomersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomersResponse> {
+        const response = await this.searchCustomersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Update a customer on the UltraCart account. 
      * Update a customer

package/src/models/CustomerQuery.ts

@@ -127,6 +127,12 @@ export interface CustomerQuery {
      * @memberof CustomerQuery
      */
     qb_class?: string;
+    /**
+     * Query Target
+     * @type {string}
+     * @memberof CustomerQuery
+     */
+    query_target?: CustomerQueryQueryTargetEnum;
     /**
      * QuickBooks name to import this customer as
      * @type {string}
@@ -203,6 +209,16 @@ export interface CustomerQuery {
 
 
 
+/**
+ * @export
+ */
+export const CustomerQueryQueryTargetEnum = {
+    Origin: 'origin',
+    Cache: 'cache'
+} as const;
+export type CustomerQueryQueryTargetEnum = typeof CustomerQueryQueryTargetEnum[keyof typeof CustomerQueryQueryTargetEnum];
+
+
 /**
  * Check if a given object implements the CustomerQuery interface.
  */
@@ -240,6 +256,7 @@ export function CustomerQueryFromJSONTyped(json: any, ignoreDiscriminator: boole
         'pricing_tier_name': !exists(json, 'pricing_tier_name') ? undefined : json['pricing_tier_name'],
         'pricing_tier_oid': !exists(json, 'pricing_tier_oid') ? undefined : json['pricing_tier_oid'],
         'qb_class': !exists(json, 'qb_class') ? undefined : json['qb_class'],
+        'query_target': !exists(json, 'query_target') ? undefined : json['query_target'],
         'quickbooks_code': !exists(json, 'quickbooks_code') ? undefined : json['quickbooks_code'],
         'shipping_city': !exists(json, 'shipping_city') ? undefined : json['shipping_city'],
         'shipping_company': !exists(json, 'shipping_company') ? undefined : json['shipping_company'],
@@ -282,6 +299,7 @@ export function CustomerQueryToJSON(value?: CustomerQuery | null): any {
         'pricing_tier_name': value.pricing_tier_name,
         'pricing_tier_oid': value.pricing_tier_oid,
         'qb_class': value.qb_class,
+        'query_target': value.query_target,
         'quickbooks_code': value.quickbooks_code,
         'shipping_city': value.shipping_city,
         'shipping_company': value.shipping_company,

package/src/models/EmailCommseqEmail.ts

@@ -19,6 +19,24 @@ import { exists, mapValues } from '../runtime';
  * @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}
@@ -246,6 +264,9 @@ export function EmailCommseqEmailFromJSONTyped(json: any, ignoreDiscriminator: b
     }
     return {
         
+        'ai_generation': !exists(json, 'ai_generation') ? undefined : json['ai_generation'],
+        'ai_generation_prompt': !exists(json, 'ai_generation_prompt') ? undefined : json['ai_generation_prompt'],
+        'ai_generation_user_id': !exists(json, 'ai_generation_user_id') ? undefined : json['ai_generation_user_id'],
         'deleted': !exists(json, 'deleted') ? undefined : json['deleted'],
         'edited_by_user': !exists(json, 'edited_by_user') ? undefined : json['edited_by_user'],
         'email_communication_sequence_email_uuid': !exists(json, 'email_communication_sequence_email_uuid') ? undefined : json['email_communication_sequence_email_uuid'],
@@ -292,6 +313,9 @@ export function EmailCommseqEmailToJSON(value?: EmailCommseqEmail | null): any {
     }
     return {
         
+        'ai_generation': value.ai_generation,
+        'ai_generation_prompt': value.ai_generation_prompt,
+        'ai_generation_user_id': value.ai_generation_user_id,
         'deleted': value.deleted,
         'edited_by_user': value.edited_by_user,
         'email_communication_sequence_email_uuid': value.email_communication_sequence_email_uuid,