ultracart_rest_api_v2_typescript 3.11.34 → 3.11.35
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/api.ts +206 -0
- package/dist/api.d.ts +115 -0
- package/dist/api.js +156 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## ultracart_rest_api_v2_typescript@3.11.
|
|
1
|
+
## ultracart_rest_api_v2_typescript@3.11.35
|
|
2
2
|
|
|
3
3
|
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:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install ultracart_rest_api_v2_typescript@3.11.
|
|
39
|
+
npm install ultracart_rest_api_v2_typescript@3.11.35 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.11.35 | 12/02/2025 | caching option added to getCustomers, created new method searchCustomers |
|
|
57
58
|
| 3.11.34 | 12/02/2025 | coupons - added optional free specific shipping method to two coupons |
|
|
58
59
|
| 3.11.33 | 11/26/2025 | conversation - AI agent profile fields |
|
|
59
60
|
| 3.11.32 | 11/20/2025 | conversion api bug fix on incorrect signature |
|
package/api.ts
CHANGED
|
@@ -17333,6 +17333,12 @@ export interface CustomerQuery {
|
|
|
17333
17333
|
* @memberof CustomerQuery
|
|
17334
17334
|
*/
|
|
17335
17335
|
qb_class?: string;
|
|
17336
|
+
/**
|
|
17337
|
+
* Query Target
|
|
17338
|
+
* @type {string}
|
|
17339
|
+
* @memberof CustomerQuery
|
|
17340
|
+
*/
|
|
17341
|
+
query_target?: CustomerQuery.QueryTargetEnum;
|
|
17336
17342
|
/**
|
|
17337
17343
|
* QuickBooks name to import this customer as
|
|
17338
17344
|
* @type {string}
|
|
@@ -17407,6 +17413,21 @@ export interface CustomerQuery {
|
|
|
17407
17413
|
signup_dts_start?: string;
|
|
17408
17414
|
}
|
|
17409
17415
|
|
|
17416
|
+
/**
|
|
17417
|
+
* @export
|
|
17418
|
+
* @namespace CustomerQuery
|
|
17419
|
+
*/
|
|
17420
|
+
export namespace CustomerQuery {
|
|
17421
|
+
/**
|
|
17422
|
+
* @export
|
|
17423
|
+
* @enum {string}
|
|
17424
|
+
*/
|
|
17425
|
+
export enum QueryTargetEnum {
|
|
17426
|
+
Origin = <any> 'origin',
|
|
17427
|
+
Cache = <any> 'cache'
|
|
17428
|
+
}
|
|
17429
|
+
}
|
|
17430
|
+
|
|
17410
17431
|
/**
|
|
17411
17432
|
*
|
|
17412
17433
|
* @export
|
|
@@ -18980,6 +19001,24 @@ export interface EmailCommseq {
|
|
|
18980
19001
|
* @interface EmailCommseqEmail
|
|
18981
19002
|
*/
|
|
18982
19003
|
export interface EmailCommseqEmail {
|
|
19004
|
+
/**
|
|
19005
|
+
*
|
|
19006
|
+
* @type {boolean}
|
|
19007
|
+
* @memberof EmailCommseqEmail
|
|
19008
|
+
*/
|
|
19009
|
+
ai_generation?: boolean;
|
|
19010
|
+
/**
|
|
19011
|
+
*
|
|
19012
|
+
* @type {string}
|
|
19013
|
+
* @memberof EmailCommseqEmail
|
|
19014
|
+
*/
|
|
19015
|
+
ai_generation_prompt?: string;
|
|
19016
|
+
/**
|
|
19017
|
+
*
|
|
19018
|
+
* @type {number}
|
|
19019
|
+
* @memberof EmailCommseqEmail
|
|
19020
|
+
*/
|
|
19021
|
+
ai_generation_user_id?: number;
|
|
18983
19022
|
/**
|
|
18984
19023
|
* Deleted
|
|
18985
19024
|
* @type {boolean}
|
|
@@ -67284,6 +67323,92 @@ export const CustomerApiFetchParamCreator = function (configuration?: Configurat
|
|
|
67284
67323
|
options: localVarRequestOptions,
|
|
67285
67324
|
};
|
|
67286
67325
|
},
|
|
67326
|
+
/**
|
|
67327
|
+
* 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.
|
|
67328
|
+
* @summary Search for customers
|
|
67329
|
+
* @param {string} [search_string] Search
|
|
67330
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
67331
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
67332
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
67333
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
67334
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
67335
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
67336
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
67337
|
+
* @param {*} [options] Override http request option.
|
|
67338
|
+
* @throws {RequiredError}
|
|
67339
|
+
*/
|
|
67340
|
+
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 {
|
|
67341
|
+
const localVarPath = `/customer/customers/search`;
|
|
67342
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
67343
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
67344
|
+
const localVarHeaderParameter = {} as any;
|
|
67345
|
+
const localVarQueryParameter = {} as any;
|
|
67346
|
+
|
|
67347
|
+
if(configuration && configuration.apiVersion) {
|
|
67348
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
67349
|
+
}
|
|
67350
|
+
|
|
67351
|
+
|
|
67352
|
+
|
|
67353
|
+
// authentication ultraCartOauth required
|
|
67354
|
+
// oauth required
|
|
67355
|
+
if (configuration && configuration.accessToken) {
|
|
67356
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
67357
|
+
? configuration.accessToken("ultraCartOauth", ["customer_read"])
|
|
67358
|
+
: configuration.accessToken;
|
|
67359
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
67360
|
+
}
|
|
67361
|
+
|
|
67362
|
+
// authentication ultraCartSimpleApiKey required
|
|
67363
|
+
if (configuration && configuration.apiKey) {
|
|
67364
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
67365
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
67366
|
+
: configuration.apiKey;
|
|
67367
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
67368
|
+
}
|
|
67369
|
+
|
|
67370
|
+
if (search_string !== undefined) {
|
|
67371
|
+
localVarQueryParameter['search_string'] = search_string;
|
|
67372
|
+
}
|
|
67373
|
+
|
|
67374
|
+
if (signup_dts_start !== undefined) {
|
|
67375
|
+
localVarQueryParameter['signup_dts_start'] = signup_dts_start;
|
|
67376
|
+
}
|
|
67377
|
+
|
|
67378
|
+
if (signup_dts_end !== undefined) {
|
|
67379
|
+
localVarQueryParameter['signup_dts_end'] = signup_dts_end;
|
|
67380
|
+
}
|
|
67381
|
+
|
|
67382
|
+
if (_limit !== undefined) {
|
|
67383
|
+
localVarQueryParameter['_limit'] = _limit;
|
|
67384
|
+
}
|
|
67385
|
+
|
|
67386
|
+
if (_offset !== undefined) {
|
|
67387
|
+
localVarQueryParameter['_offset'] = _offset;
|
|
67388
|
+
}
|
|
67389
|
+
|
|
67390
|
+
if (_since !== undefined) {
|
|
67391
|
+
localVarQueryParameter['_since'] = _since;
|
|
67392
|
+
}
|
|
67393
|
+
|
|
67394
|
+
if (_sort !== undefined) {
|
|
67395
|
+
localVarQueryParameter['_sort'] = _sort;
|
|
67396
|
+
}
|
|
67397
|
+
|
|
67398
|
+
if (_expand !== undefined) {
|
|
67399
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
67400
|
+
}
|
|
67401
|
+
|
|
67402
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
67403
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
67404
|
+
delete localVarUrlObj.search;
|
|
67405
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
67406
|
+
|
|
67407
|
+
return {
|
|
67408
|
+
url: url.format(localVarUrlObj),
|
|
67409
|
+
options: localVarRequestOptions,
|
|
67410
|
+
};
|
|
67411
|
+
},
|
|
67287
67412
|
/**
|
|
67288
67413
|
* Update a customer on the UltraCart account.
|
|
67289
67414
|
* @summary Update a customer
|
|
@@ -68007,6 +68132,34 @@ export const CustomerApiFp = function(configuration?: Configuration) {
|
|
|
68007
68132
|
});
|
|
68008
68133
|
};
|
|
68009
68134
|
},
|
|
68135
|
+
/**
|
|
68136
|
+
* 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.
|
|
68137
|
+
* @summary Search for customers
|
|
68138
|
+
* @param {string} [search_string] Search
|
|
68139
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
68140
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
68141
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
68142
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
68143
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
68144
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
68145
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
68146
|
+
* @param {*} [options] Override http request option.
|
|
68147
|
+
* @throws {RequiredError}
|
|
68148
|
+
*/
|
|
68149
|
+
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> {
|
|
68150
|
+
const localVarFetchArgs = CustomerApiFetchParamCreator(configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options);
|
|
68151
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
68152
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
68153
|
+
|
|
68154
|
+
if (response.status >= 200 && response.status < 300) {
|
|
68155
|
+
return response.json();
|
|
68156
|
+
|
|
68157
|
+
} else {
|
|
68158
|
+
throw response;
|
|
68159
|
+
}
|
|
68160
|
+
});
|
|
68161
|
+
};
|
|
68162
|
+
},
|
|
68010
68163
|
/**
|
|
68011
68164
|
* Update a customer on the UltraCart account.
|
|
68012
68165
|
* @summary Update a customer
|
|
@@ -68350,6 +68503,23 @@ export const CustomerApiFactory = function (configuration?: Configuration, fetch
|
|
|
68350
68503
|
searchCustomerProfileValues(lookup_request: LookupRequest, options?: any) {
|
|
68351
68504
|
return CustomerApiFp(configuration).searchCustomerProfileValues(lookup_request, options)(fetch, basePath);
|
|
68352
68505
|
},
|
|
68506
|
+
/**
|
|
68507
|
+
* 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.
|
|
68508
|
+
* @summary Search for customers
|
|
68509
|
+
* @param {string} [search_string] Search
|
|
68510
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
68511
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
68512
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
68513
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
68514
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
68515
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
68516
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
68517
|
+
* @param {*} [options] Override http request option.
|
|
68518
|
+
* @throws {RequiredError}
|
|
68519
|
+
*/
|
|
68520
|
+
searchCustomers(search_string?: string, signup_dts_start?: string, signup_dts_end?: string, _limit?: number, _offset?: number, _since?: string, _sort?: string, _expand?: string, options?: any) {
|
|
68521
|
+
return CustomerApiFp(configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options)(fetch, basePath);
|
|
68522
|
+
},
|
|
68353
68523
|
/**
|
|
68354
68524
|
* Update a customer on the UltraCart account.
|
|
68355
68525
|
* @summary Update a customer
|
|
@@ -68649,6 +68819,23 @@ export interface CustomerApiInterface {
|
|
|
68649
68819
|
*/
|
|
68650
68820
|
searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
|
|
68651
68821
|
|
|
68822
|
+
/**
|
|
68823
|
+
* 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.
|
|
68824
|
+
* @summary Search for customers
|
|
68825
|
+
* @param {string} [search_string] Search
|
|
68826
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
68827
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
68828
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
68829
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
68830
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
68831
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
68832
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
68833
|
+
* @param {*} [options] Override http request option.
|
|
68834
|
+
* @throws {RequiredError}
|
|
68835
|
+
* @memberof CustomerApiInterface
|
|
68836
|
+
*/
|
|
68837
|
+
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>;
|
|
68838
|
+
|
|
68652
68839
|
/**
|
|
68653
68840
|
* Update a customer on the UltraCart account.
|
|
68654
68841
|
* @summary Update a customer
|
|
@@ -68988,6 +69175,25 @@ export class CustomerApi extends BaseAPI implements CustomerApiInterface {
|
|
|
68988
69175
|
return CustomerApiFp(this.configuration).searchCustomerProfileValues(lookup_request, options)(this.fetch, this.basePath);
|
|
68989
69176
|
}
|
|
68990
69177
|
|
|
69178
|
+
/**
|
|
69179
|
+
* 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.
|
|
69180
|
+
* @summary Search for customers
|
|
69181
|
+
* @param {string} [search_string] Search
|
|
69182
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
69183
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
69184
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
69185
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
69186
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
69187
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
69188
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
69189
|
+
* @param {*} [options] Override http request option.
|
|
69190
|
+
* @throws {RequiredError}
|
|
69191
|
+
* @memberof CustomerApi
|
|
69192
|
+
*/
|
|
69193
|
+
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) {
|
|
69194
|
+
return CustomerApiFp(this.configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options)(this.fetch, this.basePath);
|
|
69195
|
+
}
|
|
69196
|
+
|
|
68991
69197
|
/**
|
|
68992
69198
|
* Update a customer on the UltraCart account.
|
|
68993
69199
|
* @summary Update a customer
|
package/dist/api.d.ts
CHANGED
|
@@ -16920,6 +16920,12 @@ export interface CustomerQuery {
|
|
|
16920
16920
|
* @memberof CustomerQuery
|
|
16921
16921
|
*/
|
|
16922
16922
|
qb_class?: string;
|
|
16923
|
+
/**
|
|
16924
|
+
* Query Target
|
|
16925
|
+
* @type {string}
|
|
16926
|
+
* @memberof CustomerQuery
|
|
16927
|
+
*/
|
|
16928
|
+
query_target?: CustomerQuery.QueryTargetEnum;
|
|
16923
16929
|
/**
|
|
16924
16930
|
* QuickBooks name to import this customer as
|
|
16925
16931
|
* @type {string}
|
|
@@ -16993,6 +16999,20 @@ export interface CustomerQuery {
|
|
|
16993
16999
|
*/
|
|
16994
17000
|
signup_dts_start?: string;
|
|
16995
17001
|
}
|
|
17002
|
+
/**
|
|
17003
|
+
* @export
|
|
17004
|
+
* @namespace CustomerQuery
|
|
17005
|
+
*/
|
|
17006
|
+
export declare namespace CustomerQuery {
|
|
17007
|
+
/**
|
|
17008
|
+
* @export
|
|
17009
|
+
* @enum {string}
|
|
17010
|
+
*/
|
|
17011
|
+
enum QueryTargetEnum {
|
|
17012
|
+
Origin,
|
|
17013
|
+
Cache
|
|
17014
|
+
}
|
|
17015
|
+
}
|
|
16996
17016
|
/**
|
|
16997
17017
|
*
|
|
16998
17018
|
* @export
|
|
@@ -18536,6 +18556,24 @@ export interface EmailCommseq {
|
|
|
18536
18556
|
* @interface EmailCommseqEmail
|
|
18537
18557
|
*/
|
|
18538
18558
|
export interface EmailCommseqEmail {
|
|
18559
|
+
/**
|
|
18560
|
+
*
|
|
18561
|
+
* @type {boolean}
|
|
18562
|
+
* @memberof EmailCommseqEmail
|
|
18563
|
+
*/
|
|
18564
|
+
ai_generation?: boolean;
|
|
18565
|
+
/**
|
|
18566
|
+
*
|
|
18567
|
+
* @type {string}
|
|
18568
|
+
* @memberof EmailCommseqEmail
|
|
18569
|
+
*/
|
|
18570
|
+
ai_generation_prompt?: string;
|
|
18571
|
+
/**
|
|
18572
|
+
*
|
|
18573
|
+
* @type {number}
|
|
18574
|
+
* @memberof EmailCommseqEmail
|
|
18575
|
+
*/
|
|
18576
|
+
ai_generation_user_id?: number;
|
|
18539
18577
|
/**
|
|
18540
18578
|
* Deleted
|
|
18541
18579
|
* @type {boolean}
|
|
@@ -53992,6 +54030,21 @@ export declare const CustomerApiFetchParamCreator: (configuration?: Configuratio
|
|
|
53992
54030
|
* @throws {RequiredError}
|
|
53993
54031
|
*/
|
|
53994
54032
|
searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): FetchArgs;
|
|
54033
|
+
/**
|
|
54034
|
+
* 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.
|
|
54035
|
+
* @summary Search for customers
|
|
54036
|
+
* @param {string} [search_string] Search
|
|
54037
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
54038
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
54039
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
54040
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
54041
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
54042
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
54043
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
54044
|
+
* @param {*} [options] Override http request option.
|
|
54045
|
+
* @throws {RequiredError}
|
|
54046
|
+
*/
|
|
54047
|
+
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;
|
|
53995
54048
|
/**
|
|
53996
54049
|
* Update a customer on the UltraCart account.
|
|
53997
54050
|
* @summary Update a customer
|
|
@@ -54240,6 +54293,21 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
|
|
|
54240
54293
|
* @throws {RequiredError}
|
|
54241
54294
|
*/
|
|
54242
54295
|
searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<LookupResponse>;
|
|
54296
|
+
/**
|
|
54297
|
+
* 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.
|
|
54298
|
+
* @summary Search for customers
|
|
54299
|
+
* @param {string} [search_string] Search
|
|
54300
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
54301
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
54302
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
54303
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
54304
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
54305
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
54306
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
54307
|
+
* @param {*} [options] Override http request option.
|
|
54308
|
+
* @throws {RequiredError}
|
|
54309
|
+
*/
|
|
54310
|
+
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>;
|
|
54243
54311
|
/**
|
|
54244
54312
|
* Update a customer on the UltraCart account.
|
|
54245
54313
|
* @summary Update a customer
|
|
@@ -54488,6 +54556,21 @@ export declare const CustomerApiFactory: (configuration?: Configuration, fetch?:
|
|
|
54488
54556
|
* @throws {RequiredError}
|
|
54489
54557
|
*/
|
|
54490
54558
|
searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
|
|
54559
|
+
/**
|
|
54560
|
+
* 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.
|
|
54561
|
+
* @summary Search for customers
|
|
54562
|
+
* @param {string} [search_string] Search
|
|
54563
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
54564
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
54565
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
54566
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
54567
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
54568
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
54569
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
54570
|
+
* @param {*} [options] Override http request option.
|
|
54571
|
+
* @throws {RequiredError}
|
|
54572
|
+
*/
|
|
54573
|
+
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>;
|
|
54491
54574
|
/**
|
|
54492
54575
|
* Update a customer on the UltraCart account.
|
|
54493
54576
|
* @summary Update a customer
|
|
@@ -54757,6 +54840,22 @@ export interface CustomerApiInterface {
|
|
|
54757
54840
|
* @memberof CustomerApiInterface
|
|
54758
54841
|
*/
|
|
54759
54842
|
searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
|
|
54843
|
+
/**
|
|
54844
|
+
* 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.
|
|
54845
|
+
* @summary Search for customers
|
|
54846
|
+
* @param {string} [search_string] Search
|
|
54847
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
54848
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
54849
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
54850
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
54851
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
54852
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
54853
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
54854
|
+
* @param {*} [options] Override http request option.
|
|
54855
|
+
* @throws {RequiredError}
|
|
54856
|
+
* @memberof CustomerApiInterface
|
|
54857
|
+
*/
|
|
54858
|
+
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>;
|
|
54760
54859
|
/**
|
|
54761
54860
|
* Update a customer on the UltraCart account.
|
|
54762
54861
|
* @summary Update a customer
|
|
@@ -55031,6 +55130,22 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
|
|
|
55031
55130
|
* @memberof CustomerApi
|
|
55032
55131
|
*/
|
|
55033
55132
|
searchCustomerProfileValues(lookup_request: LookupRequest, options?: any): Promise<LookupResponse>;
|
|
55133
|
+
/**
|
|
55134
|
+
* 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.
|
|
55135
|
+
* @summary Search for customers
|
|
55136
|
+
* @param {string} [search_string] Search
|
|
55137
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
55138
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
55139
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
55140
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
55141
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
55142
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
55143
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
55144
|
+
* @param {*} [options] Override http request option.
|
|
55145
|
+
* @throws {RequiredError}
|
|
55146
|
+
* @memberof CustomerApi
|
|
55147
|
+
*/
|
|
55148
|
+
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>;
|
|
55034
55149
|
/**
|
|
55035
55150
|
* Update a customer on the UltraCart account.
|
|
55036
55151
|
* @summary Update a customer
|
package/dist/api.js
CHANGED
|
@@ -28,10 +28,10 @@ var __extends = (this && this.__extends) || (function () {
|
|
|
28
28
|
};
|
|
29
29
|
})();
|
|
30
30
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
|
-
exports.
|
|
32
|
-
exports.
|
|
33
|
-
exports.
|
|
34
|
-
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;
|
|
31
|
+
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;
|
|
32
|
+
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;
|
|
33
|
+
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;
|
|
34
|
+
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;
|
|
35
35
|
var url = require("url");
|
|
36
36
|
var portableFetch = require("portable-fetch");
|
|
37
37
|
var BASE_PATH = "https://secure.ultracart.com/rest/v2".replace(/\/+$/, "");
|
|
@@ -887,6 +887,22 @@ var Coupon;
|
|
|
887
887
|
UsableByEnum[UsableByEnum["OncePerNewCustomerForItem"] = 'OncePerNewCustomerForItem'] = "OncePerNewCustomerForItem";
|
|
888
888
|
})(UsableByEnum = Coupon.UsableByEnum || (Coupon.UsableByEnum = {}));
|
|
889
889
|
})(Coupon = exports.Coupon || (exports.Coupon = {}));
|
|
890
|
+
/**
|
|
891
|
+
* @export
|
|
892
|
+
* @namespace CustomerQuery
|
|
893
|
+
*/
|
|
894
|
+
var CustomerQuery;
|
|
895
|
+
(function (CustomerQuery) {
|
|
896
|
+
/**
|
|
897
|
+
* @export
|
|
898
|
+
* @enum {string}
|
|
899
|
+
*/
|
|
900
|
+
var QueryTargetEnum;
|
|
901
|
+
(function (QueryTargetEnum) {
|
|
902
|
+
QueryTargetEnum[QueryTargetEnum["Origin"] = 'origin'] = "Origin";
|
|
903
|
+
QueryTargetEnum[QueryTargetEnum["Cache"] = 'cache'] = "Cache";
|
|
904
|
+
})(QueryTargetEnum = CustomerQuery.QueryTargetEnum || (CustomerQuery.QueryTargetEnum = {}));
|
|
905
|
+
})(CustomerQuery = exports.CustomerQuery || (exports.CustomerQuery = {}));
|
|
890
906
|
/**
|
|
891
907
|
* @export
|
|
892
908
|
* @namespace Distance
|
|
@@ -18976,6 +18992,78 @@ var CustomerApiFetchParamCreator = function (configuration) {
|
|
|
18976
18992
|
options: localVarRequestOptions,
|
|
18977
18993
|
};
|
|
18978
18994
|
},
|
|
18995
|
+
/**
|
|
18996
|
+
* 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.
|
|
18997
|
+
* @summary Search for customers
|
|
18998
|
+
* @param {string} [search_string] Search
|
|
18999
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
19000
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
19001
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
19002
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
19003
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
19004
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
19005
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
19006
|
+
* @param {*} [options] Override http request option.
|
|
19007
|
+
* @throws {RequiredError}
|
|
19008
|
+
*/
|
|
19009
|
+
searchCustomers: function (search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options) {
|
|
19010
|
+
if (options === void 0) { options = {}; }
|
|
19011
|
+
var localVarPath = "/customer/customers/search";
|
|
19012
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
19013
|
+
var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
19014
|
+
var localVarHeaderParameter = {};
|
|
19015
|
+
var localVarQueryParameter = {};
|
|
19016
|
+
if (configuration && configuration.apiVersion) {
|
|
19017
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
19018
|
+
}
|
|
19019
|
+
// authentication ultraCartOauth required
|
|
19020
|
+
// oauth required
|
|
19021
|
+
if (configuration && configuration.accessToken) {
|
|
19022
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
19023
|
+
? configuration.accessToken("ultraCartOauth", ["customer_read"])
|
|
19024
|
+
: configuration.accessToken;
|
|
19025
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
19026
|
+
}
|
|
19027
|
+
// authentication ultraCartSimpleApiKey required
|
|
19028
|
+
if (configuration && configuration.apiKey) {
|
|
19029
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
19030
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
19031
|
+
: configuration.apiKey;
|
|
19032
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
19033
|
+
}
|
|
19034
|
+
if (search_string !== undefined) {
|
|
19035
|
+
localVarQueryParameter['search_string'] = search_string;
|
|
19036
|
+
}
|
|
19037
|
+
if (signup_dts_start !== undefined) {
|
|
19038
|
+
localVarQueryParameter['signup_dts_start'] = signup_dts_start;
|
|
19039
|
+
}
|
|
19040
|
+
if (signup_dts_end !== undefined) {
|
|
19041
|
+
localVarQueryParameter['signup_dts_end'] = signup_dts_end;
|
|
19042
|
+
}
|
|
19043
|
+
if (_limit !== undefined) {
|
|
19044
|
+
localVarQueryParameter['_limit'] = _limit;
|
|
19045
|
+
}
|
|
19046
|
+
if (_offset !== undefined) {
|
|
19047
|
+
localVarQueryParameter['_offset'] = _offset;
|
|
19048
|
+
}
|
|
19049
|
+
if (_since !== undefined) {
|
|
19050
|
+
localVarQueryParameter['_since'] = _since;
|
|
19051
|
+
}
|
|
19052
|
+
if (_sort !== undefined) {
|
|
19053
|
+
localVarQueryParameter['_sort'] = _sort;
|
|
19054
|
+
}
|
|
19055
|
+
if (_expand !== undefined) {
|
|
19056
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
19057
|
+
}
|
|
19058
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
19059
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
19060
|
+
delete localVarUrlObj.search;
|
|
19061
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
19062
|
+
return {
|
|
19063
|
+
url: url.format(localVarUrlObj),
|
|
19064
|
+
options: localVarRequestOptions,
|
|
19065
|
+
};
|
|
19066
|
+
},
|
|
18979
19067
|
/**
|
|
18980
19068
|
* Update a customer on the UltraCart account.
|
|
18981
19069
|
* @summary Update a customer
|
|
@@ -19690,6 +19778,35 @@ var CustomerApiFp = function (configuration) {
|
|
|
19690
19778
|
});
|
|
19691
19779
|
};
|
|
19692
19780
|
},
|
|
19781
|
+
/**
|
|
19782
|
+
* 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.
|
|
19783
|
+
* @summary Search for customers
|
|
19784
|
+
* @param {string} [search_string] Search
|
|
19785
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
19786
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
19787
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
19788
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
19789
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
19790
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
19791
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
19792
|
+
* @param {*} [options] Override http request option.
|
|
19793
|
+
* @throws {RequiredError}
|
|
19794
|
+
*/
|
|
19795
|
+
searchCustomers: function (search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options) {
|
|
19796
|
+
var localVarFetchArgs = (0, exports.CustomerApiFetchParamCreator)(configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options);
|
|
19797
|
+
return function (fetch, basePath) {
|
|
19798
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
19799
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
19800
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
19801
|
+
if (response.status >= 200 && response.status < 300) {
|
|
19802
|
+
return response.json();
|
|
19803
|
+
}
|
|
19804
|
+
else {
|
|
19805
|
+
throw response;
|
|
19806
|
+
}
|
|
19807
|
+
});
|
|
19808
|
+
};
|
|
19809
|
+
},
|
|
19693
19810
|
/**
|
|
19694
19811
|
* Update a customer on the UltraCart account.
|
|
19695
19812
|
* @summary Update a customer
|
|
@@ -20037,6 +20154,23 @@ var CustomerApiFactory = function (configuration, fetch, basePath) {
|
|
|
20037
20154
|
searchCustomerProfileValues: function (lookup_request, options) {
|
|
20038
20155
|
return (0, exports.CustomerApiFp)(configuration).searchCustomerProfileValues(lookup_request, options)(fetch, basePath);
|
|
20039
20156
|
},
|
|
20157
|
+
/**
|
|
20158
|
+
* 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.
|
|
20159
|
+
* @summary Search for customers
|
|
20160
|
+
* @param {string} [search_string] Search
|
|
20161
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
20162
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
20163
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
20164
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
20165
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
20166
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
20167
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
20168
|
+
* @param {*} [options] Override http request option.
|
|
20169
|
+
* @throws {RequiredError}
|
|
20170
|
+
*/
|
|
20171
|
+
searchCustomers: function (search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options) {
|
|
20172
|
+
return (0, exports.CustomerApiFp)(configuration).searchCustomers(search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options)(fetch, basePath);
|
|
20173
|
+
},
|
|
20040
20174
|
/**
|
|
20041
20175
|
* Update a customer on the UltraCart account.
|
|
20042
20176
|
* @summary Update a customer
|
|
@@ -20361,6 +20495,24 @@ var CustomerApi = /** @class */ (function (_super) {
|
|
|
20361
20495
|
CustomerApi.prototype.searchCustomerProfileValues = function (lookup_request, options) {
|
|
20362
20496
|
return (0, exports.CustomerApiFp)(this.configuration).searchCustomerProfileValues(lookup_request, options)(this.fetch, this.basePath);
|
|
20363
20497
|
};
|
|
20498
|
+
/**
|
|
20499
|
+
* 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.
|
|
20500
|
+
* @summary Search for customers
|
|
20501
|
+
* @param {string} [search_string] Search
|
|
20502
|
+
* @param {string} [signup_dts_start] Signup date start
|
|
20503
|
+
* @param {string} [signup_dts_end] Signup date end
|
|
20504
|
+
* @param {number} [_limit] The maximum number of records to return on this one API call. (Max 200)
|
|
20505
|
+
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
20506
|
+
* @param {string} [_since] Fetch customers that have been created/modified since this date/time.
|
|
20507
|
+
* @param {string} [_sort] The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
|
|
20508
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
20509
|
+
* @param {*} [options] Override http request option.
|
|
20510
|
+
* @throws {RequiredError}
|
|
20511
|
+
* @memberof CustomerApi
|
|
20512
|
+
*/
|
|
20513
|
+
CustomerApi.prototype.searchCustomers = function (search_string, signup_dts_start, signup_dts_end, _limit, _offset, _since, _sort, _expand, options) {
|
|
20514
|
+
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);
|
|
20515
|
+
};
|
|
20364
20516
|
/**
|
|
20365
20517
|
* Update a customer on the UltraCart account.
|
|
20366
20518
|
* @summary Update a customer
|