ultracart_rest_api_v2_typescript 3.11.36 → 3.11.38
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 +4 -2
- package/api.ts +314 -1
- package/dist/api.d.ts +161 -1
- package/dist/api.js +223 -0
- 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.38
|
|
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.38 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -54,6 +54,8 @@ Not every change is committed to every SDK.
|
|
|
54
54
|
|
|
55
55
|
| Version | Date | Comments |
|
|
56
56
|
| --: | :-: | --- |
|
|
57
|
+
| 3.11.38 | 12/29/2025 | conversations - AI agent level capabilities |
|
|
58
|
+
| 3.11.37 | 12/29/2025 | conversations - pbx agent AI flag |
|
|
57
59
|
| 3.11.36 | 12/22/2025 | conversation - agent auth worker token v2 |
|
|
58
60
|
| 3.11.35 | 12/02/2025 | caching option added to getCustomers, created new method searchCustomers |
|
|
59
61
|
| 3.11.34 | 12/02/2025 | coupons - added optional free specific shipping method to two coupons |
|
package/api.ts
CHANGED
|
@@ -7117,6 +7117,12 @@ export interface ConversationAgentProfile {
|
|
|
7117
7117
|
* @memberof ConversationAgentProfile
|
|
7118
7118
|
*/
|
|
7119
7119
|
ai?: boolean;
|
|
7120
|
+
/**
|
|
7121
|
+
*
|
|
7122
|
+
* @type {ConversationVirtualAgentCapabilities}
|
|
7123
|
+
* @memberof ConversationAgentProfile
|
|
7124
|
+
*/
|
|
7125
|
+
ai_capabilities?: ConversationVirtualAgentCapabilities;
|
|
7120
7126
|
/**
|
|
7121
7127
|
* Additional instructions for this AI when handle web chats
|
|
7122
7128
|
* @type {string}
|
|
@@ -9181,6 +9187,12 @@ export interface ConversationParticipant {
|
|
|
9181
9187
|
* @interface ConversationPbxAgent
|
|
9182
9188
|
*/
|
|
9183
9189
|
export interface ConversationPbxAgent {
|
|
9190
|
+
/**
|
|
9191
|
+
* Flag to indicate if the agent is AI
|
|
9192
|
+
* @type {boolean}
|
|
9193
|
+
* @memberof ConversationPbxAgent
|
|
9194
|
+
*/
|
|
9195
|
+
ai?: boolean;
|
|
9184
9196
|
/**
|
|
9185
9197
|
* Cellphone number of agent in E.164 format
|
|
9186
9198
|
* @type {string}
|
|
@@ -30850,7 +30862,9 @@ export namespace ItemRelatedItem {
|
|
|
30850
30862
|
*/
|
|
30851
30863
|
export enum TypeEnum {
|
|
30852
30864
|
System = <any> 'System',
|
|
30853
|
-
UserDefined = <any> 'UserDefined'
|
|
30865
|
+
UserDefined = <any> 'UserDefined',
|
|
30866
|
+
Addon = <any> 'Addon',
|
|
30867
|
+
Complementary = <any> 'Complementary'
|
|
30854
30868
|
}
|
|
30855
30869
|
}
|
|
30856
30870
|
|
|
@@ -32006,6 +32020,44 @@ export interface ItemShippingDistributionCenter {
|
|
|
32006
32020
|
stock_picking_location?: string;
|
|
32007
32021
|
}
|
|
32008
32022
|
|
|
32023
|
+
/**
|
|
32024
|
+
*
|
|
32025
|
+
* @export
|
|
32026
|
+
* @interface ItemShippingDistributionCenterResponse
|
|
32027
|
+
*/
|
|
32028
|
+
export interface ItemShippingDistributionCenterResponse {
|
|
32029
|
+
/**
|
|
32030
|
+
*
|
|
32031
|
+
* @type {ModelError}
|
|
32032
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32033
|
+
*/
|
|
32034
|
+
error?: ModelError;
|
|
32035
|
+
/**
|
|
32036
|
+
*
|
|
32037
|
+
* @type {ItemShippingDistributionCenter}
|
|
32038
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32039
|
+
*/
|
|
32040
|
+
itemShippingDistributionCenter?: ItemShippingDistributionCenter;
|
|
32041
|
+
/**
|
|
32042
|
+
*
|
|
32043
|
+
* @type {ResponseMetadata}
|
|
32044
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32045
|
+
*/
|
|
32046
|
+
metadata?: ResponseMetadata;
|
|
32047
|
+
/**
|
|
32048
|
+
* Indicates if API call was successful
|
|
32049
|
+
* @type {boolean}
|
|
32050
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32051
|
+
*/
|
|
32052
|
+
success?: boolean;
|
|
32053
|
+
/**
|
|
32054
|
+
*
|
|
32055
|
+
* @type {Warning}
|
|
32056
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32057
|
+
*/
|
|
32058
|
+
warning?: Warning;
|
|
32059
|
+
}
|
|
32060
|
+
|
|
32009
32061
|
/**
|
|
32010
32062
|
*
|
|
32011
32063
|
* @export
|
|
@@ -75350,6 +75402,74 @@ export const ItemApiFetchParamCreator = function (configuration?: Configuration)
|
|
|
75350
75402
|
|
|
75351
75403
|
|
|
75352
75404
|
|
|
75405
|
+
// authentication ultraCartOauth required
|
|
75406
|
+
// oauth required
|
|
75407
|
+
if (configuration && configuration.accessToken) {
|
|
75408
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
75409
|
+
? configuration.accessToken("ultraCartOauth", ["item_read"])
|
|
75410
|
+
: configuration.accessToken;
|
|
75411
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
75412
|
+
}
|
|
75413
|
+
|
|
75414
|
+
// authentication ultraCartSimpleApiKey required
|
|
75415
|
+
if (configuration && configuration.apiKey) {
|
|
75416
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
75417
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
75418
|
+
: configuration.apiKey;
|
|
75419
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
75420
|
+
}
|
|
75421
|
+
|
|
75422
|
+
if (_expand !== undefined) {
|
|
75423
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
75424
|
+
}
|
|
75425
|
+
|
|
75426
|
+
if (_placeholders !== undefined) {
|
|
75427
|
+
localVarQueryParameter['_placeholders'] = _placeholders;
|
|
75428
|
+
}
|
|
75429
|
+
|
|
75430
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
75431
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
75432
|
+
delete localVarUrlObj.search;
|
|
75433
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
75434
|
+
|
|
75435
|
+
return {
|
|
75436
|
+
url: url.format(localVarUrlObj),
|
|
75437
|
+
options: localVarRequestOptions,
|
|
75438
|
+
};
|
|
75439
|
+
},
|
|
75440
|
+
/**
|
|
75441
|
+
* Retrieve an item shipping distribution center.
|
|
75442
|
+
* @summary Retrieve an item shipping distribution center
|
|
75443
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
75444
|
+
* @param {string} distribution_center_code
|
|
75445
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
75446
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
75447
|
+
* @param {*} [options] Override http request option.
|
|
75448
|
+
* @throws {RequiredError}
|
|
75449
|
+
*/
|
|
75450
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options: any = {}): FetchArgs {
|
|
75451
|
+
// verify required parameter 'merchant_item_oid' is not null or undefined
|
|
75452
|
+
if (merchant_item_oid === null || merchant_item_oid === undefined) {
|
|
75453
|
+
throw new RequiredError('merchant_item_oid','Required parameter merchant_item_oid was null or undefined when calling getItemShippingDistributionCenterByCode.');
|
|
75454
|
+
}
|
|
75455
|
+
// verify required parameter 'distribution_center_code' is not null or undefined
|
|
75456
|
+
if (distribution_center_code === null || distribution_center_code === undefined) {
|
|
75457
|
+
throw new RequiredError('distribution_center_code','Required parameter distribution_center_code was null or undefined when calling getItemShippingDistributionCenterByCode.');
|
|
75458
|
+
}
|
|
75459
|
+
const localVarPath = `/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}`
|
|
75460
|
+
.replace(`{${"merchant_item_oid"}}`, encodeURIComponent(String(merchant_item_oid)))
|
|
75461
|
+
.replace(`{${"distribution_center_code"}}`, encodeURIComponent(String(distribution_center_code)));
|
|
75462
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
75463
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
75464
|
+
const localVarHeaderParameter = {} as any;
|
|
75465
|
+
const localVarQueryParameter = {} as any;
|
|
75466
|
+
|
|
75467
|
+
if(configuration && configuration.apiVersion) {
|
|
75468
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
75469
|
+
}
|
|
75470
|
+
|
|
75471
|
+
|
|
75472
|
+
|
|
75353
75473
|
// authentication ultraCartOauth required
|
|
75354
75474
|
// oauth required
|
|
75355
75475
|
if (configuration && configuration.accessToken) {
|
|
@@ -76082,6 +76202,73 @@ export const ItemApiFetchParamCreator = function (configuration?: Configuration)
|
|
|
76082
76202
|
options: localVarRequestOptions,
|
|
76083
76203
|
};
|
|
76084
76204
|
},
|
|
76205
|
+
/**
|
|
76206
|
+
* Update an item shipping distribution center
|
|
76207
|
+
* @summary Update an item shipping distribution center
|
|
76208
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
76209
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
76210
|
+
* @param {string} distribution_center_code
|
|
76211
|
+
* @param {*} [options] Override http request option.
|
|
76212
|
+
* @throws {RequiredError}
|
|
76213
|
+
*/
|
|
76214
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options: any = {}): FetchArgs {
|
|
76215
|
+
// verify required parameter 'item_shipping_distribution_center' is not null or undefined
|
|
76216
|
+
if (item_shipping_distribution_center === null || item_shipping_distribution_center === undefined) {
|
|
76217
|
+
throw new RequiredError('item_shipping_distribution_center','Required parameter item_shipping_distribution_center was null or undefined when calling updateItemShippingDistributionCenterByCode.');
|
|
76218
|
+
}
|
|
76219
|
+
// verify required parameter 'merchant_item_oid' is not null or undefined
|
|
76220
|
+
if (merchant_item_oid === null || merchant_item_oid === undefined) {
|
|
76221
|
+
throw new RequiredError('merchant_item_oid','Required parameter merchant_item_oid was null or undefined when calling updateItemShippingDistributionCenterByCode.');
|
|
76222
|
+
}
|
|
76223
|
+
// verify required parameter 'distribution_center_code' is not null or undefined
|
|
76224
|
+
if (distribution_center_code === null || distribution_center_code === undefined) {
|
|
76225
|
+
throw new RequiredError('distribution_center_code','Required parameter distribution_center_code was null or undefined when calling updateItemShippingDistributionCenterByCode.');
|
|
76226
|
+
}
|
|
76227
|
+
const localVarPath = `/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}`
|
|
76228
|
+
.replace(`{${"merchant_item_oid"}}`, encodeURIComponent(String(merchant_item_oid)))
|
|
76229
|
+
.replace(`{${"distribution_center_code"}}`, encodeURIComponent(String(distribution_center_code)));
|
|
76230
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
76231
|
+
const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
76232
|
+
const localVarHeaderParameter = {} as any;
|
|
76233
|
+
const localVarQueryParameter = {} as any;
|
|
76234
|
+
|
|
76235
|
+
if(configuration && configuration.apiVersion) {
|
|
76236
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
76237
|
+
}
|
|
76238
|
+
|
|
76239
|
+
|
|
76240
|
+
|
|
76241
|
+
// authentication ultraCartOauth required
|
|
76242
|
+
// oauth required
|
|
76243
|
+
if (configuration && configuration.accessToken) {
|
|
76244
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
76245
|
+
? configuration.accessToken("ultraCartOauth", ["item_write"])
|
|
76246
|
+
: configuration.accessToken;
|
|
76247
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
76248
|
+
}
|
|
76249
|
+
|
|
76250
|
+
// authentication ultraCartSimpleApiKey required
|
|
76251
|
+
if (configuration && configuration.apiKey) {
|
|
76252
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
76253
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
76254
|
+
: configuration.apiKey;
|
|
76255
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
76256
|
+
}
|
|
76257
|
+
|
|
76258
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
76259
|
+
|
|
76260
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
76261
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
76262
|
+
delete localVarUrlObj.search;
|
|
76263
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
76264
|
+
const needsSerialization = (<any>"ItemShippingDistributionCenter" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
76265
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(item_shipping_distribution_center || {}) : (item_shipping_distribution_center || "");
|
|
76266
|
+
|
|
76267
|
+
return {
|
|
76268
|
+
url: url.format(localVarUrlObj),
|
|
76269
|
+
options: localVarRequestOptions,
|
|
76270
|
+
};
|
|
76271
|
+
},
|
|
76085
76272
|
/**
|
|
76086
76273
|
* Update multiple item on the UltraCart account.
|
|
76087
76274
|
* @summary Update multiple items
|
|
@@ -76485,6 +76672,30 @@ export const ItemApiFp = function(configuration?: Configuration) {
|
|
|
76485
76672
|
});
|
|
76486
76673
|
};
|
|
76487
76674
|
},
|
|
76675
|
+
/**
|
|
76676
|
+
* Retrieve an item shipping distribution center.
|
|
76677
|
+
* @summary Retrieve an item shipping distribution center
|
|
76678
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
76679
|
+
* @param {string} distribution_center_code
|
|
76680
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
76681
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
76682
|
+
* @param {*} [options] Override http request option.
|
|
76683
|
+
* @throws {RequiredError}
|
|
76684
|
+
*/
|
|
76685
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemShippingDistributionCenterResponse> {
|
|
76686
|
+
const localVarFetchArgs = ItemApiFetchParamCreator(configuration).getItemShippingDistributionCenterByCode(merchant_item_oid, distribution_center_code, _expand, _placeholders, options);
|
|
76687
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
76688
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
76689
|
+
|
|
76690
|
+
if (response.status >= 200 && response.status < 300) {
|
|
76691
|
+
return response.json();
|
|
76692
|
+
|
|
76693
|
+
} else {
|
|
76694
|
+
throw response;
|
|
76695
|
+
}
|
|
76696
|
+
});
|
|
76697
|
+
};
|
|
76698
|
+
},
|
|
76488
76699
|
/**
|
|
76489
76700
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
76490
76701
|
* @summary Retrieve items
|
|
@@ -76737,6 +76948,29 @@ export const ItemApiFp = function(configuration?: Configuration) {
|
|
|
76737
76948
|
});
|
|
76738
76949
|
};
|
|
76739
76950
|
},
|
|
76951
|
+
/**
|
|
76952
|
+
* Update an item shipping distribution center
|
|
76953
|
+
* @summary Update an item shipping distribution center
|
|
76954
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
76955
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
76956
|
+
* @param {string} distribution_center_code
|
|
76957
|
+
* @param {*} [options] Override http request option.
|
|
76958
|
+
* @throws {RequiredError}
|
|
76959
|
+
*/
|
|
76960
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
|
|
76961
|
+
const localVarFetchArgs = ItemApiFetchParamCreator(configuration).updateItemShippingDistributionCenterByCode(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options);
|
|
76962
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
76963
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
76964
|
+
|
|
76965
|
+
if (response.status >= 200 && response.status < 300) {
|
|
76966
|
+
return response;
|
|
76967
|
+
|
|
76968
|
+
} else {
|
|
76969
|
+
throw response;
|
|
76970
|
+
}
|
|
76971
|
+
});
|
|
76972
|
+
};
|
|
76973
|
+
},
|
|
76740
76974
|
/**
|
|
76741
76975
|
* Update multiple item on the UltraCart account.
|
|
76742
76976
|
* @summary Update multiple items
|
|
@@ -76913,6 +77147,19 @@ export const ItemApiFactory = function (configuration?: Configuration, fetch?: F
|
|
|
76913
77147
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any) {
|
|
76914
77148
|
return ItemApiFp(configuration).getItemByMerchantItemId(merchant_item_id, _expand, _placeholders, options)(fetch, basePath);
|
|
76915
77149
|
},
|
|
77150
|
+
/**
|
|
77151
|
+
* Retrieve an item shipping distribution center.
|
|
77152
|
+
* @summary Retrieve an item shipping distribution center
|
|
77153
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
77154
|
+
* @param {string} distribution_center_code
|
|
77155
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
77156
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
77157
|
+
* @param {*} [options] Override http request option.
|
|
77158
|
+
* @throws {RequiredError}
|
|
77159
|
+
*/
|
|
77160
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any) {
|
|
77161
|
+
return ItemApiFp(configuration).getItemShippingDistributionCenterByCode(merchant_item_oid, distribution_center_code, _expand, _placeholders, options)(fetch, basePath);
|
|
77162
|
+
},
|
|
76916
77163
|
/**
|
|
76917
77164
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
76918
77165
|
* @summary Retrieve items
|
|
@@ -77044,6 +77291,18 @@ export const ItemApiFactory = function (configuration?: Configuration, fetch?: F
|
|
|
77044
77291
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any) {
|
|
77045
77292
|
return ItemApiFp(configuration).updateItem(item, merchant_item_oid, _expand, _placeholders, options)(fetch, basePath);
|
|
77046
77293
|
},
|
|
77294
|
+
/**
|
|
77295
|
+
* Update an item shipping distribution center
|
|
77296
|
+
* @summary Update an item shipping distribution center
|
|
77297
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
77298
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
77299
|
+
* @param {string} distribution_center_code
|
|
77300
|
+
* @param {*} [options] Override http request option.
|
|
77301
|
+
* @throws {RequiredError}
|
|
77302
|
+
*/
|
|
77303
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any) {
|
|
77304
|
+
return ItemApiFp(configuration).updateItemShippingDistributionCenterByCode(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options)(fetch, basePath);
|
|
77305
|
+
},
|
|
77047
77306
|
/**
|
|
77048
77307
|
* Update multiple item on the UltraCart account.
|
|
77049
77308
|
* @summary Update multiple items
|
|
@@ -77187,6 +77446,19 @@ export interface ItemApiInterface {
|
|
|
77187
77446
|
*/
|
|
77188
77447
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
77189
77448
|
|
|
77449
|
+
/**
|
|
77450
|
+
* Retrieve an item shipping distribution center.
|
|
77451
|
+
* @summary Retrieve an item shipping distribution center
|
|
77452
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
77453
|
+
* @param {string} distribution_center_code
|
|
77454
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
77455
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
77456
|
+
* @param {*} [options] Override http request option.
|
|
77457
|
+
* @throws {RequiredError}
|
|
77458
|
+
* @memberof ItemApiInterface
|
|
77459
|
+
*/
|
|
77460
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemShippingDistributionCenterResponse>;
|
|
77461
|
+
|
|
77190
77462
|
/**
|
|
77191
77463
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
77192
77464
|
* @summary Retrieve items
|
|
@@ -77318,6 +77590,18 @@ export interface ItemApiInterface {
|
|
|
77318
77590
|
*/
|
|
77319
77591
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
77320
77592
|
|
|
77593
|
+
/**
|
|
77594
|
+
* Update an item shipping distribution center
|
|
77595
|
+
* @summary Update an item shipping distribution center
|
|
77596
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
77597
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
77598
|
+
* @param {string} distribution_center_code
|
|
77599
|
+
* @param {*} [options] Override http request option.
|
|
77600
|
+
* @throws {RequiredError}
|
|
77601
|
+
* @memberof ItemApiInterface
|
|
77602
|
+
*/
|
|
77603
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): Promise<{}>;
|
|
77604
|
+
|
|
77321
77605
|
/**
|
|
77322
77606
|
* Update multiple item on the UltraCart account.
|
|
77323
77607
|
* @summary Update multiple items
|
|
@@ -77479,6 +77763,21 @@ export class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
77479
77763
|
return ItemApiFp(this.configuration).getItemByMerchantItemId(merchant_item_id, _expand, _placeholders, options)(this.fetch, this.basePath);
|
|
77480
77764
|
}
|
|
77481
77765
|
|
|
77766
|
+
/**
|
|
77767
|
+
* Retrieve an item shipping distribution center.
|
|
77768
|
+
* @summary Retrieve an item shipping distribution center
|
|
77769
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
77770
|
+
* @param {string} distribution_center_code
|
|
77771
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
77772
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
77773
|
+
* @param {*} [options] Override http request option.
|
|
77774
|
+
* @throws {RequiredError}
|
|
77775
|
+
* @memberof ItemApi
|
|
77776
|
+
*/
|
|
77777
|
+
public getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any) {
|
|
77778
|
+
return ItemApiFp(this.configuration).getItemShippingDistributionCenterByCode(merchant_item_oid, distribution_center_code, _expand, _placeholders, options)(this.fetch, this.basePath);
|
|
77779
|
+
}
|
|
77780
|
+
|
|
77482
77781
|
/**
|
|
77483
77782
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
77484
77783
|
* @summary Retrieve items
|
|
@@ -77632,6 +77931,20 @@ export class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
77632
77931
|
return ItemApiFp(this.configuration).updateItem(item, merchant_item_oid, _expand, _placeholders, options)(this.fetch, this.basePath);
|
|
77633
77932
|
}
|
|
77634
77933
|
|
|
77934
|
+
/**
|
|
77935
|
+
* Update an item shipping distribution center
|
|
77936
|
+
* @summary Update an item shipping distribution center
|
|
77937
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
77938
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
77939
|
+
* @param {string} distribution_center_code
|
|
77940
|
+
* @param {*} [options] Override http request option.
|
|
77941
|
+
* @throws {RequiredError}
|
|
77942
|
+
* @memberof ItemApi
|
|
77943
|
+
*/
|
|
77944
|
+
public updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any) {
|
|
77945
|
+
return ItemApiFp(this.configuration).updateItemShippingDistributionCenterByCode(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options)(this.fetch, this.basePath);
|
|
77946
|
+
}
|
|
77947
|
+
|
|
77635
77948
|
/**
|
|
77636
77949
|
* Update multiple item on the UltraCart account.
|
|
77637
77950
|
* @summary Update multiple items
|
package/dist/api.d.ts
CHANGED
|
@@ -6956,6 +6956,12 @@ export interface ConversationAgentProfile {
|
|
|
6956
6956
|
* @memberof ConversationAgentProfile
|
|
6957
6957
|
*/
|
|
6958
6958
|
ai?: boolean;
|
|
6959
|
+
/**
|
|
6960
|
+
*
|
|
6961
|
+
* @type {ConversationVirtualAgentCapabilities}
|
|
6962
|
+
* @memberof ConversationAgentProfile
|
|
6963
|
+
*/
|
|
6964
|
+
ai_capabilities?: ConversationVirtualAgentCapabilities;
|
|
6959
6965
|
/**
|
|
6960
6966
|
* Additional instructions for this AI when handle web chats
|
|
6961
6967
|
* @type {string}
|
|
@@ -8962,6 +8968,12 @@ export interface ConversationParticipant {
|
|
|
8962
8968
|
* @interface ConversationPbxAgent
|
|
8963
8969
|
*/
|
|
8964
8970
|
export interface ConversationPbxAgent {
|
|
8971
|
+
/**
|
|
8972
|
+
* Flag to indicate if the agent is AI
|
|
8973
|
+
* @type {boolean}
|
|
8974
|
+
* @memberof ConversationPbxAgent
|
|
8975
|
+
*/
|
|
8976
|
+
ai?: boolean;
|
|
8965
8977
|
/**
|
|
8966
8978
|
* Cellphone number of agent in E.164 format
|
|
8967
8979
|
* @type {string}
|
|
@@ -30188,7 +30200,9 @@ export declare namespace ItemRelatedItem {
|
|
|
30188
30200
|
*/
|
|
30189
30201
|
enum TypeEnum {
|
|
30190
30202
|
System,
|
|
30191
|
-
UserDefined
|
|
30203
|
+
UserDefined,
|
|
30204
|
+
Addon,
|
|
30205
|
+
Complementary
|
|
30192
30206
|
}
|
|
30193
30207
|
}
|
|
30194
30208
|
/**
|
|
@@ -31325,6 +31339,43 @@ export interface ItemShippingDistributionCenter {
|
|
|
31325
31339
|
*/
|
|
31326
31340
|
stock_picking_location?: string;
|
|
31327
31341
|
}
|
|
31342
|
+
/**
|
|
31343
|
+
*
|
|
31344
|
+
* @export
|
|
31345
|
+
* @interface ItemShippingDistributionCenterResponse
|
|
31346
|
+
*/
|
|
31347
|
+
export interface ItemShippingDistributionCenterResponse {
|
|
31348
|
+
/**
|
|
31349
|
+
*
|
|
31350
|
+
* @type {ModelError}
|
|
31351
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31352
|
+
*/
|
|
31353
|
+
error?: ModelError;
|
|
31354
|
+
/**
|
|
31355
|
+
*
|
|
31356
|
+
* @type {ItemShippingDistributionCenter}
|
|
31357
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31358
|
+
*/
|
|
31359
|
+
itemShippingDistributionCenter?: ItemShippingDistributionCenter;
|
|
31360
|
+
/**
|
|
31361
|
+
*
|
|
31362
|
+
* @type {ResponseMetadata}
|
|
31363
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31364
|
+
*/
|
|
31365
|
+
metadata?: ResponseMetadata;
|
|
31366
|
+
/**
|
|
31367
|
+
* Indicates if API call was successful
|
|
31368
|
+
* @type {boolean}
|
|
31369
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31370
|
+
*/
|
|
31371
|
+
success?: boolean;
|
|
31372
|
+
/**
|
|
31373
|
+
*
|
|
31374
|
+
* @type {Warning}
|
|
31375
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31376
|
+
*/
|
|
31377
|
+
warning?: Warning;
|
|
31378
|
+
}
|
|
31328
31379
|
/**
|
|
31329
31380
|
*
|
|
31330
31381
|
* @export
|
|
@@ -57585,6 +57636,17 @@ export declare const ItemApiFetchParamCreator: (configuration?: Configuration) =
|
|
|
57585
57636
|
* @throws {RequiredError}
|
|
57586
57637
|
*/
|
|
57587
57638
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): FetchArgs;
|
|
57639
|
+
/**
|
|
57640
|
+
* Retrieve an item shipping distribution center.
|
|
57641
|
+
* @summary Retrieve an item shipping distribution center
|
|
57642
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
57643
|
+
* @param {string} distribution_center_code
|
|
57644
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
57645
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
57646
|
+
* @param {*} [options] Override http request option.
|
|
57647
|
+
* @throws {RequiredError}
|
|
57648
|
+
*/
|
|
57649
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): FetchArgs;
|
|
57588
57650
|
/**
|
|
57589
57651
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
57590
57652
|
* @summary Retrieve items
|
|
@@ -57694,6 +57756,16 @@ export declare const ItemApiFetchParamCreator: (configuration?: Configuration) =
|
|
|
57694
57756
|
* @throws {RequiredError}
|
|
57695
57757
|
*/
|
|
57696
57758
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): FetchArgs;
|
|
57759
|
+
/**
|
|
57760
|
+
* Update an item shipping distribution center
|
|
57761
|
+
* @summary Update an item shipping distribution center
|
|
57762
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
57763
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
57764
|
+
* @param {string} distribution_center_code
|
|
57765
|
+
* @param {*} [options] Override http request option.
|
|
57766
|
+
* @throws {RequiredError}
|
|
57767
|
+
*/
|
|
57768
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): FetchArgs;
|
|
57697
57769
|
/**
|
|
57698
57770
|
* Update multiple item on the UltraCart account.
|
|
57699
57771
|
* @summary Update multiple items
|
|
@@ -57810,6 +57882,17 @@ export declare const ItemApiFp: (configuration?: Configuration) => {
|
|
|
57810
57882
|
* @throws {RequiredError}
|
|
57811
57883
|
*/
|
|
57812
57884
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemResponse>;
|
|
57885
|
+
/**
|
|
57886
|
+
* Retrieve an item shipping distribution center.
|
|
57887
|
+
* @summary Retrieve an item shipping distribution center
|
|
57888
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
57889
|
+
* @param {string} distribution_center_code
|
|
57890
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
57891
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
57892
|
+
* @param {*} [options] Override http request option.
|
|
57893
|
+
* @throws {RequiredError}
|
|
57894
|
+
*/
|
|
57895
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemShippingDistributionCenterResponse>;
|
|
57813
57896
|
/**
|
|
57814
57897
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
57815
57898
|
* @summary Retrieve items
|
|
@@ -57919,6 +58002,16 @@ export declare const ItemApiFp: (configuration?: Configuration) => {
|
|
|
57919
58002
|
* @throws {RequiredError}
|
|
57920
58003
|
*/
|
|
57921
58004
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemResponse>;
|
|
58005
|
+
/**
|
|
58006
|
+
* Update an item shipping distribution center
|
|
58007
|
+
* @summary Update an item shipping distribution center
|
|
58008
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
58009
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
58010
|
+
* @param {string} distribution_center_code
|
|
58011
|
+
* @param {*} [options] Override http request option.
|
|
58012
|
+
* @throws {RequiredError}
|
|
58013
|
+
*/
|
|
58014
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
|
|
57922
58015
|
/**
|
|
57923
58016
|
* Update multiple item on the UltraCart account.
|
|
57924
58017
|
* @summary Update multiple items
|
|
@@ -58035,6 +58128,17 @@ export declare const ItemApiFactory: (configuration?: Configuration, fetch?: Fet
|
|
|
58035
58128
|
* @throws {RequiredError}
|
|
58036
58129
|
*/
|
|
58037
58130
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58131
|
+
/**
|
|
58132
|
+
* Retrieve an item shipping distribution center.
|
|
58133
|
+
* @summary Retrieve an item shipping distribution center
|
|
58134
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
58135
|
+
* @param {string} distribution_center_code
|
|
58136
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
58137
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
58138
|
+
* @param {*} [options] Override http request option.
|
|
58139
|
+
* @throws {RequiredError}
|
|
58140
|
+
*/
|
|
58141
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemShippingDistributionCenterResponse>;
|
|
58038
58142
|
/**
|
|
58039
58143
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
58040
58144
|
* @summary Retrieve items
|
|
@@ -58144,6 +58248,16 @@ export declare const ItemApiFactory: (configuration?: Configuration, fetch?: Fet
|
|
|
58144
58248
|
* @throws {RequiredError}
|
|
58145
58249
|
*/
|
|
58146
58250
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58251
|
+
/**
|
|
58252
|
+
* Update an item shipping distribution center
|
|
58253
|
+
* @summary Update an item shipping distribution center
|
|
58254
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
58255
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
58256
|
+
* @param {string} distribution_center_code
|
|
58257
|
+
* @param {*} [options] Override http request option.
|
|
58258
|
+
* @throws {RequiredError}
|
|
58259
|
+
*/
|
|
58260
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): Promise<Response>;
|
|
58147
58261
|
/**
|
|
58148
58262
|
* Update multiple item on the UltraCart account.
|
|
58149
58263
|
* @summary Update multiple items
|
|
@@ -58270,6 +58384,18 @@ export interface ItemApiInterface {
|
|
|
58270
58384
|
* @memberof ItemApiInterface
|
|
58271
58385
|
*/
|
|
58272
58386
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58387
|
+
/**
|
|
58388
|
+
* Retrieve an item shipping distribution center.
|
|
58389
|
+
* @summary Retrieve an item shipping distribution center
|
|
58390
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
58391
|
+
* @param {string} distribution_center_code
|
|
58392
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
58393
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
58394
|
+
* @param {*} [options] Override http request option.
|
|
58395
|
+
* @throws {RequiredError}
|
|
58396
|
+
* @memberof ItemApiInterface
|
|
58397
|
+
*/
|
|
58398
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemShippingDistributionCenterResponse>;
|
|
58273
58399
|
/**
|
|
58274
58400
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
58275
58401
|
* @summary Retrieve items
|
|
@@ -58390,6 +58516,17 @@ export interface ItemApiInterface {
|
|
|
58390
58516
|
* @memberof ItemApiInterface
|
|
58391
58517
|
*/
|
|
58392
58518
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58519
|
+
/**
|
|
58520
|
+
* Update an item shipping distribution center
|
|
58521
|
+
* @summary Update an item shipping distribution center
|
|
58522
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
58523
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
58524
|
+
* @param {string} distribution_center_code
|
|
58525
|
+
* @param {*} [options] Override http request option.
|
|
58526
|
+
* @throws {RequiredError}
|
|
58527
|
+
* @memberof ItemApiInterface
|
|
58528
|
+
*/
|
|
58529
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): Promise<{}>;
|
|
58393
58530
|
/**
|
|
58394
58531
|
* Update multiple item on the UltraCart account.
|
|
58395
58532
|
* @summary Update multiple items
|
|
@@ -58520,6 +58657,18 @@ export declare class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
58520
58657
|
* @memberof ItemApi
|
|
58521
58658
|
*/
|
|
58522
58659
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58660
|
+
/**
|
|
58661
|
+
* Retrieve an item shipping distribution center.
|
|
58662
|
+
* @summary Retrieve an item shipping distribution center
|
|
58663
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
58664
|
+
* @param {string} distribution_center_code
|
|
58665
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
58666
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
58667
|
+
* @param {*} [options] Override http request option.
|
|
58668
|
+
* @throws {RequiredError}
|
|
58669
|
+
* @memberof ItemApi
|
|
58670
|
+
*/
|
|
58671
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemShippingDistributionCenterResponse>;
|
|
58523
58672
|
/**
|
|
58524
58673
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
58525
58674
|
* @summary Retrieve items
|
|
@@ -58640,6 +58789,17 @@ export declare class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
58640
58789
|
* @memberof ItemApi
|
|
58641
58790
|
*/
|
|
58642
58791
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58792
|
+
/**
|
|
58793
|
+
* Update an item shipping distribution center
|
|
58794
|
+
* @summary Update an item shipping distribution center
|
|
58795
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
58796
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
58797
|
+
* @param {string} distribution_center_code
|
|
58798
|
+
* @param {*} [options] Override http request option.
|
|
58799
|
+
* @throws {RequiredError}
|
|
58800
|
+
* @memberof ItemApi
|
|
58801
|
+
*/
|
|
58802
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): Promise<Response>;
|
|
58643
58803
|
/**
|
|
58644
58804
|
* Update multiple item on the UltraCart account.
|
|
58645
58805
|
* @summary Update multiple items
|
package/dist/api.js
CHANGED
|
@@ -1073,6 +1073,8 @@ var ItemRelatedItem;
|
|
|
1073
1073
|
(function (TypeEnum) {
|
|
1074
1074
|
TypeEnum[TypeEnum["System"] = 'System'] = "System";
|
|
1075
1075
|
TypeEnum[TypeEnum["UserDefined"] = 'UserDefined'] = "UserDefined";
|
|
1076
|
+
TypeEnum[TypeEnum["Addon"] = 'Addon'] = "Addon";
|
|
1077
|
+
TypeEnum[TypeEnum["Complementary"] = 'Complementary'] = "Complementary";
|
|
1076
1078
|
})(TypeEnum = ItemRelatedItem.TypeEnum || (ItemRelatedItem.TypeEnum = {}));
|
|
1077
1079
|
})(ItemRelatedItem = exports.ItemRelatedItem || (exports.ItemRelatedItem = {}));
|
|
1078
1080
|
/**
|
|
@@ -25781,6 +25783,66 @@ var ItemApiFetchParamCreator = function (configuration) {
|
|
|
25781
25783
|
options: localVarRequestOptions,
|
|
25782
25784
|
};
|
|
25783
25785
|
},
|
|
25786
|
+
/**
|
|
25787
|
+
* Retrieve an item shipping distribution center.
|
|
25788
|
+
* @summary Retrieve an item shipping distribution center
|
|
25789
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
25790
|
+
* @param {string} distribution_center_code
|
|
25791
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
25792
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
25793
|
+
* @param {*} [options] Override http request option.
|
|
25794
|
+
* @throws {RequiredError}
|
|
25795
|
+
*/
|
|
25796
|
+
getItemShippingDistributionCenterByCode: function (merchant_item_oid, distribution_center_code, _expand, _placeholders, options) {
|
|
25797
|
+
if (options === void 0) { options = {}; }
|
|
25798
|
+
// verify required parameter 'merchant_item_oid' is not null or undefined
|
|
25799
|
+
if (merchant_item_oid === null || merchant_item_oid === undefined) {
|
|
25800
|
+
throw new RequiredError('merchant_item_oid', 'Required parameter merchant_item_oid was null or undefined when calling getItemShippingDistributionCenterByCode.');
|
|
25801
|
+
}
|
|
25802
|
+
// verify required parameter 'distribution_center_code' is not null or undefined
|
|
25803
|
+
if (distribution_center_code === null || distribution_center_code === undefined) {
|
|
25804
|
+
throw new RequiredError('distribution_center_code', 'Required parameter distribution_center_code was null or undefined when calling getItemShippingDistributionCenterByCode.');
|
|
25805
|
+
}
|
|
25806
|
+
var localVarPath = "/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}"
|
|
25807
|
+
.replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(merchant_item_oid)))
|
|
25808
|
+
.replace("{".concat("distribution_center_code", "}"), encodeURIComponent(String(distribution_center_code)));
|
|
25809
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
25810
|
+
var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
25811
|
+
var localVarHeaderParameter = {};
|
|
25812
|
+
var localVarQueryParameter = {};
|
|
25813
|
+
if (configuration && configuration.apiVersion) {
|
|
25814
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
25815
|
+
}
|
|
25816
|
+
// authentication ultraCartOauth required
|
|
25817
|
+
// oauth required
|
|
25818
|
+
if (configuration && configuration.accessToken) {
|
|
25819
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
25820
|
+
? configuration.accessToken("ultraCartOauth", ["item_read"])
|
|
25821
|
+
: configuration.accessToken;
|
|
25822
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
25823
|
+
}
|
|
25824
|
+
// authentication ultraCartSimpleApiKey required
|
|
25825
|
+
if (configuration && configuration.apiKey) {
|
|
25826
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
25827
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
25828
|
+
: configuration.apiKey;
|
|
25829
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
25830
|
+
}
|
|
25831
|
+
if (_expand !== undefined) {
|
|
25832
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
25833
|
+
}
|
|
25834
|
+
if (_placeholders !== undefined) {
|
|
25835
|
+
localVarQueryParameter['_placeholders'] = _placeholders;
|
|
25836
|
+
}
|
|
25837
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
25838
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
25839
|
+
delete localVarUrlObj.search;
|
|
25840
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
25841
|
+
return {
|
|
25842
|
+
url: url.format(localVarUrlObj),
|
|
25843
|
+
options: localVarRequestOptions,
|
|
25844
|
+
};
|
|
25845
|
+
},
|
|
25784
25846
|
/**
|
|
25785
25847
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
25786
25848
|
* @summary Retrieve items
|
|
@@ -26387,6 +26449,66 @@ var ItemApiFetchParamCreator = function (configuration) {
|
|
|
26387
26449
|
options: localVarRequestOptions,
|
|
26388
26450
|
};
|
|
26389
26451
|
},
|
|
26452
|
+
/**
|
|
26453
|
+
* Update an item shipping distribution center
|
|
26454
|
+
* @summary Update an item shipping distribution center
|
|
26455
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
26456
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
26457
|
+
* @param {string} distribution_center_code
|
|
26458
|
+
* @param {*} [options] Override http request option.
|
|
26459
|
+
* @throws {RequiredError}
|
|
26460
|
+
*/
|
|
26461
|
+
updateItemShippingDistributionCenterByCode: function (item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options) {
|
|
26462
|
+
if (options === void 0) { options = {}; }
|
|
26463
|
+
// verify required parameter 'item_shipping_distribution_center' is not null or undefined
|
|
26464
|
+
if (item_shipping_distribution_center === null || item_shipping_distribution_center === undefined) {
|
|
26465
|
+
throw new RequiredError('item_shipping_distribution_center', 'Required parameter item_shipping_distribution_center was null or undefined when calling updateItemShippingDistributionCenterByCode.');
|
|
26466
|
+
}
|
|
26467
|
+
// verify required parameter 'merchant_item_oid' is not null or undefined
|
|
26468
|
+
if (merchant_item_oid === null || merchant_item_oid === undefined) {
|
|
26469
|
+
throw new RequiredError('merchant_item_oid', 'Required parameter merchant_item_oid was null or undefined when calling updateItemShippingDistributionCenterByCode.');
|
|
26470
|
+
}
|
|
26471
|
+
// verify required parameter 'distribution_center_code' is not null or undefined
|
|
26472
|
+
if (distribution_center_code === null || distribution_center_code === undefined) {
|
|
26473
|
+
throw new RequiredError('distribution_center_code', 'Required parameter distribution_center_code was null or undefined when calling updateItemShippingDistributionCenterByCode.');
|
|
26474
|
+
}
|
|
26475
|
+
var localVarPath = "/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}"
|
|
26476
|
+
.replace("{".concat("merchant_item_oid", "}"), encodeURIComponent(String(merchant_item_oid)))
|
|
26477
|
+
.replace("{".concat("distribution_center_code", "}"), encodeURIComponent(String(distribution_center_code)));
|
|
26478
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
26479
|
+
var localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
26480
|
+
var localVarHeaderParameter = {};
|
|
26481
|
+
var localVarQueryParameter = {};
|
|
26482
|
+
if (configuration && configuration.apiVersion) {
|
|
26483
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
26484
|
+
}
|
|
26485
|
+
// authentication ultraCartOauth required
|
|
26486
|
+
// oauth required
|
|
26487
|
+
if (configuration && configuration.accessToken) {
|
|
26488
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
26489
|
+
? configuration.accessToken("ultraCartOauth", ["item_write"])
|
|
26490
|
+
: configuration.accessToken;
|
|
26491
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
26492
|
+
}
|
|
26493
|
+
// authentication ultraCartSimpleApiKey required
|
|
26494
|
+
if (configuration && configuration.apiKey) {
|
|
26495
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
26496
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
26497
|
+
: configuration.apiKey;
|
|
26498
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
26499
|
+
}
|
|
26500
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
26501
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
26502
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
26503
|
+
delete localVarUrlObj.search;
|
|
26504
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
26505
|
+
var needsSerialization = ("ItemShippingDistributionCenter" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
26506
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(item_shipping_distribution_center || {}) : (item_shipping_distribution_center || "");
|
|
26507
|
+
return {
|
|
26508
|
+
url: url.format(localVarUrlObj),
|
|
26509
|
+
options: localVarRequestOptions,
|
|
26510
|
+
};
|
|
26511
|
+
},
|
|
26390
26512
|
/**
|
|
26391
26513
|
* Update multiple item on the UltraCart account.
|
|
26392
26514
|
* @summary Update multiple items
|
|
@@ -26774,6 +26896,31 @@ var ItemApiFp = function (configuration) {
|
|
|
26774
26896
|
});
|
|
26775
26897
|
};
|
|
26776
26898
|
},
|
|
26899
|
+
/**
|
|
26900
|
+
* Retrieve an item shipping distribution center.
|
|
26901
|
+
* @summary Retrieve an item shipping distribution center
|
|
26902
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
26903
|
+
* @param {string} distribution_center_code
|
|
26904
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
26905
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
26906
|
+
* @param {*} [options] Override http request option.
|
|
26907
|
+
* @throws {RequiredError}
|
|
26908
|
+
*/
|
|
26909
|
+
getItemShippingDistributionCenterByCode: function (merchant_item_oid, distribution_center_code, _expand, _placeholders, options) {
|
|
26910
|
+
var localVarFetchArgs = (0, exports.ItemApiFetchParamCreator)(configuration).getItemShippingDistributionCenterByCode(merchant_item_oid, distribution_center_code, _expand, _placeholders, options);
|
|
26911
|
+
return function (fetch, basePath) {
|
|
26912
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
26913
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
26914
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
26915
|
+
if (response.status >= 200 && response.status < 300) {
|
|
26916
|
+
return response.json();
|
|
26917
|
+
}
|
|
26918
|
+
else {
|
|
26919
|
+
throw response;
|
|
26920
|
+
}
|
|
26921
|
+
});
|
|
26922
|
+
};
|
|
26923
|
+
},
|
|
26777
26924
|
/**
|
|
26778
26925
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
26779
26926
|
* @summary Retrieve items
|
|
@@ -27037,6 +27184,30 @@ var ItemApiFp = function (configuration) {
|
|
|
27037
27184
|
});
|
|
27038
27185
|
};
|
|
27039
27186
|
},
|
|
27187
|
+
/**
|
|
27188
|
+
* Update an item shipping distribution center
|
|
27189
|
+
* @summary Update an item shipping distribution center
|
|
27190
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
27191
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
27192
|
+
* @param {string} distribution_center_code
|
|
27193
|
+
* @param {*} [options] Override http request option.
|
|
27194
|
+
* @throws {RequiredError}
|
|
27195
|
+
*/
|
|
27196
|
+
updateItemShippingDistributionCenterByCode: function (item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options) {
|
|
27197
|
+
var localVarFetchArgs = (0, exports.ItemApiFetchParamCreator)(configuration).updateItemShippingDistributionCenterByCode(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options);
|
|
27198
|
+
return function (fetch, basePath) {
|
|
27199
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
27200
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
27201
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
27202
|
+
if (response.status >= 200 && response.status < 300) {
|
|
27203
|
+
return response;
|
|
27204
|
+
}
|
|
27205
|
+
else {
|
|
27206
|
+
throw response;
|
|
27207
|
+
}
|
|
27208
|
+
});
|
|
27209
|
+
};
|
|
27210
|
+
},
|
|
27040
27211
|
/**
|
|
27041
27212
|
* Update multiple item on the UltraCart account.
|
|
27042
27213
|
* @summary Update multiple items
|
|
@@ -27216,6 +27387,19 @@ var ItemApiFactory = function (configuration, fetch, basePath) {
|
|
|
27216
27387
|
getItemByMerchantItemId: function (merchant_item_id, _expand, _placeholders, options) {
|
|
27217
27388
|
return (0, exports.ItemApiFp)(configuration).getItemByMerchantItemId(merchant_item_id, _expand, _placeholders, options)(fetch, basePath);
|
|
27218
27389
|
},
|
|
27390
|
+
/**
|
|
27391
|
+
* Retrieve an item shipping distribution center.
|
|
27392
|
+
* @summary Retrieve an item shipping distribution center
|
|
27393
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
27394
|
+
* @param {string} distribution_center_code
|
|
27395
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
27396
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
27397
|
+
* @param {*} [options] Override http request option.
|
|
27398
|
+
* @throws {RequiredError}
|
|
27399
|
+
*/
|
|
27400
|
+
getItemShippingDistributionCenterByCode: function (merchant_item_oid, distribution_center_code, _expand, _placeholders, options) {
|
|
27401
|
+
return (0, exports.ItemApiFp)(configuration).getItemShippingDistributionCenterByCode(merchant_item_oid, distribution_center_code, _expand, _placeholders, options)(fetch, basePath);
|
|
27402
|
+
},
|
|
27219
27403
|
/**
|
|
27220
27404
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
27221
27405
|
* @summary Retrieve items
|
|
@@ -27347,6 +27531,18 @@ var ItemApiFactory = function (configuration, fetch, basePath) {
|
|
|
27347
27531
|
updateItem: function (item, merchant_item_oid, _expand, _placeholders, options) {
|
|
27348
27532
|
return (0, exports.ItemApiFp)(configuration).updateItem(item, merchant_item_oid, _expand, _placeholders, options)(fetch, basePath);
|
|
27349
27533
|
},
|
|
27534
|
+
/**
|
|
27535
|
+
* Update an item shipping distribution center
|
|
27536
|
+
* @summary Update an item shipping distribution center
|
|
27537
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
27538
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
27539
|
+
* @param {string} distribution_center_code
|
|
27540
|
+
* @param {*} [options] Override http request option.
|
|
27541
|
+
* @throws {RequiredError}
|
|
27542
|
+
*/
|
|
27543
|
+
updateItemShippingDistributionCenterByCode: function (item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options) {
|
|
27544
|
+
return (0, exports.ItemApiFp)(configuration).updateItemShippingDistributionCenterByCode(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options)(fetch, basePath);
|
|
27545
|
+
},
|
|
27350
27546
|
/**
|
|
27351
27547
|
* Update multiple item on the UltraCart account.
|
|
27352
27548
|
* @summary Update multiple items
|
|
@@ -27504,6 +27700,20 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
27504
27700
|
ItemApi.prototype.getItemByMerchantItemId = function (merchant_item_id, _expand, _placeholders, options) {
|
|
27505
27701
|
return (0, exports.ItemApiFp)(this.configuration).getItemByMerchantItemId(merchant_item_id, _expand, _placeholders, options)(this.fetch, this.basePath);
|
|
27506
27702
|
};
|
|
27703
|
+
/**
|
|
27704
|
+
* Retrieve an item shipping distribution center.
|
|
27705
|
+
* @summary Retrieve an item shipping distribution center
|
|
27706
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
27707
|
+
* @param {string} distribution_center_code
|
|
27708
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
27709
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
27710
|
+
* @param {*} [options] Override http request option.
|
|
27711
|
+
* @throws {RequiredError}
|
|
27712
|
+
* @memberof ItemApi
|
|
27713
|
+
*/
|
|
27714
|
+
ItemApi.prototype.getItemShippingDistributionCenterByCode = function (merchant_item_oid, distribution_center_code, _expand, _placeholders, options) {
|
|
27715
|
+
return (0, exports.ItemApiFp)(this.configuration).getItemShippingDistributionCenterByCode(merchant_item_oid, distribution_center_code, _expand, _placeholders, options)(this.fetch, this.basePath);
|
|
27716
|
+
};
|
|
27507
27717
|
/**
|
|
27508
27718
|
* Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
27509
27719
|
* @summary Retrieve items
|
|
@@ -27646,6 +27856,19 @@ var ItemApi = /** @class */ (function (_super) {
|
|
|
27646
27856
|
ItemApi.prototype.updateItem = function (item, merchant_item_oid, _expand, _placeholders, options) {
|
|
27647
27857
|
return (0, exports.ItemApiFp)(this.configuration).updateItem(item, merchant_item_oid, _expand, _placeholders, options)(this.fetch, this.basePath);
|
|
27648
27858
|
};
|
|
27859
|
+
/**
|
|
27860
|
+
* Update an item shipping distribution center
|
|
27861
|
+
* @summary Update an item shipping distribution center
|
|
27862
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
27863
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
27864
|
+
* @param {string} distribution_center_code
|
|
27865
|
+
* @param {*} [options] Override http request option.
|
|
27866
|
+
* @throws {RequiredError}
|
|
27867
|
+
* @memberof ItemApi
|
|
27868
|
+
*/
|
|
27869
|
+
ItemApi.prototype.updateItemShippingDistributionCenterByCode = function (item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options) {
|
|
27870
|
+
return (0, exports.ItemApiFp)(this.configuration).updateItemShippingDistributionCenterByCode(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options)(this.fetch, this.basePath);
|
|
27871
|
+
};
|
|
27649
27872
|
/**
|
|
27650
27873
|
* Update multiple item on the UltraCart account.
|
|
27651
27874
|
* @summary Update multiple items
|