ultracart_rest_api_v2_typescript 3.11.35 → 3.11.37
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.37
|
|
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.37 --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.37 | 12/29/2025 | conversations - pbx agent AI flag |
|
|
58
|
+
| 3.11.36 | 12/22/2025 | conversation - agent auth worker token v2 |
|
|
57
59
|
| 3.11.35 | 12/02/2025 | caching option added to getCustomers, created new method searchCustomers |
|
|
58
60
|
| 3.11.34 | 12/02/2025 | coupons - added optional free specific shipping method to two coupons |
|
|
59
61
|
| 3.11.33 | 11/26/2025 | conversation - AI agent profile fields |
|
package/api.ts
CHANGED
|
@@ -7041,6 +7041,12 @@ export interface ConversationAgentAuth {
|
|
|
7041
7041
|
* @memberof ConversationAgentAuth
|
|
7042
7042
|
*/
|
|
7043
7043
|
pbx_worker_token?: string;
|
|
7044
|
+
/**
|
|
7045
|
+
*
|
|
7046
|
+
* @type {string}
|
|
7047
|
+
* @memberof ConversationAgentAuth
|
|
7048
|
+
*/
|
|
7049
|
+
pbx_worker_token_v2?: string;
|
|
7044
7050
|
/**
|
|
7045
7051
|
*
|
|
7046
7052
|
* @type {Array<ConversationTwilioAccount>}
|
|
@@ -9175,6 +9181,12 @@ export interface ConversationParticipant {
|
|
|
9175
9181
|
* @interface ConversationPbxAgent
|
|
9176
9182
|
*/
|
|
9177
9183
|
export interface ConversationPbxAgent {
|
|
9184
|
+
/**
|
|
9185
|
+
* Flag to indicate if the agent is AI
|
|
9186
|
+
* @type {boolean}
|
|
9187
|
+
* @memberof ConversationPbxAgent
|
|
9188
|
+
*/
|
|
9189
|
+
ai?: boolean;
|
|
9178
9190
|
/**
|
|
9179
9191
|
* Cellphone number of agent in E.164 format
|
|
9180
9192
|
* @type {string}
|
|
@@ -30844,7 +30856,9 @@ export namespace ItemRelatedItem {
|
|
|
30844
30856
|
*/
|
|
30845
30857
|
export enum TypeEnum {
|
|
30846
30858
|
System = <any> 'System',
|
|
30847
|
-
UserDefined = <any> 'UserDefined'
|
|
30859
|
+
UserDefined = <any> 'UserDefined',
|
|
30860
|
+
Addon = <any> 'Addon',
|
|
30861
|
+
Complementary = <any> 'Complementary'
|
|
30848
30862
|
}
|
|
30849
30863
|
}
|
|
30850
30864
|
|
|
@@ -32000,6 +32014,44 @@ export interface ItemShippingDistributionCenter {
|
|
|
32000
32014
|
stock_picking_location?: string;
|
|
32001
32015
|
}
|
|
32002
32016
|
|
|
32017
|
+
/**
|
|
32018
|
+
*
|
|
32019
|
+
* @export
|
|
32020
|
+
* @interface ItemShippingDistributionCenterResponse
|
|
32021
|
+
*/
|
|
32022
|
+
export interface ItemShippingDistributionCenterResponse {
|
|
32023
|
+
/**
|
|
32024
|
+
*
|
|
32025
|
+
* @type {ModelError}
|
|
32026
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32027
|
+
*/
|
|
32028
|
+
error?: ModelError;
|
|
32029
|
+
/**
|
|
32030
|
+
*
|
|
32031
|
+
* @type {ItemShippingDistributionCenter}
|
|
32032
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32033
|
+
*/
|
|
32034
|
+
itemShippingDistributionCenter?: ItemShippingDistributionCenter;
|
|
32035
|
+
/**
|
|
32036
|
+
*
|
|
32037
|
+
* @type {ResponseMetadata}
|
|
32038
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32039
|
+
*/
|
|
32040
|
+
metadata?: ResponseMetadata;
|
|
32041
|
+
/**
|
|
32042
|
+
* Indicates if API call was successful
|
|
32043
|
+
* @type {boolean}
|
|
32044
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32045
|
+
*/
|
|
32046
|
+
success?: boolean;
|
|
32047
|
+
/**
|
|
32048
|
+
*
|
|
32049
|
+
* @type {Warning}
|
|
32050
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
32051
|
+
*/
|
|
32052
|
+
warning?: Warning;
|
|
32053
|
+
}
|
|
32054
|
+
|
|
32003
32055
|
/**
|
|
32004
32056
|
*
|
|
32005
32057
|
* @export
|
|
@@ -75344,6 +75396,74 @@ export const ItemApiFetchParamCreator = function (configuration?: Configuration)
|
|
|
75344
75396
|
|
|
75345
75397
|
|
|
75346
75398
|
|
|
75399
|
+
// authentication ultraCartOauth required
|
|
75400
|
+
// oauth required
|
|
75401
|
+
if (configuration && configuration.accessToken) {
|
|
75402
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
75403
|
+
? configuration.accessToken("ultraCartOauth", ["item_read"])
|
|
75404
|
+
: configuration.accessToken;
|
|
75405
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
75406
|
+
}
|
|
75407
|
+
|
|
75408
|
+
// authentication ultraCartSimpleApiKey required
|
|
75409
|
+
if (configuration && configuration.apiKey) {
|
|
75410
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
75411
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
75412
|
+
: configuration.apiKey;
|
|
75413
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
75414
|
+
}
|
|
75415
|
+
|
|
75416
|
+
if (_expand !== undefined) {
|
|
75417
|
+
localVarQueryParameter['_expand'] = _expand;
|
|
75418
|
+
}
|
|
75419
|
+
|
|
75420
|
+
if (_placeholders !== undefined) {
|
|
75421
|
+
localVarQueryParameter['_placeholders'] = _placeholders;
|
|
75422
|
+
}
|
|
75423
|
+
|
|
75424
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
75425
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
75426
|
+
delete localVarUrlObj.search;
|
|
75427
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
75428
|
+
|
|
75429
|
+
return {
|
|
75430
|
+
url: url.format(localVarUrlObj),
|
|
75431
|
+
options: localVarRequestOptions,
|
|
75432
|
+
};
|
|
75433
|
+
},
|
|
75434
|
+
/**
|
|
75435
|
+
* Retrieve an item shipping distribution center.
|
|
75436
|
+
* @summary Retrieve an item shipping distribution center
|
|
75437
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
75438
|
+
* @param {string} distribution_center_code
|
|
75439
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
75440
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
75441
|
+
* @param {*} [options] Override http request option.
|
|
75442
|
+
* @throws {RequiredError}
|
|
75443
|
+
*/
|
|
75444
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options: any = {}): FetchArgs {
|
|
75445
|
+
// verify required parameter 'merchant_item_oid' is not null or undefined
|
|
75446
|
+
if (merchant_item_oid === null || merchant_item_oid === undefined) {
|
|
75447
|
+
throw new RequiredError('merchant_item_oid','Required parameter merchant_item_oid was null or undefined when calling getItemShippingDistributionCenterByCode.');
|
|
75448
|
+
}
|
|
75449
|
+
// verify required parameter 'distribution_center_code' is not null or undefined
|
|
75450
|
+
if (distribution_center_code === null || distribution_center_code === undefined) {
|
|
75451
|
+
throw new RequiredError('distribution_center_code','Required parameter distribution_center_code was null or undefined when calling getItemShippingDistributionCenterByCode.');
|
|
75452
|
+
}
|
|
75453
|
+
const localVarPath = `/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}`
|
|
75454
|
+
.replace(`{${"merchant_item_oid"}}`, encodeURIComponent(String(merchant_item_oid)))
|
|
75455
|
+
.replace(`{${"distribution_center_code"}}`, encodeURIComponent(String(distribution_center_code)));
|
|
75456
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
75457
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
75458
|
+
const localVarHeaderParameter = {} as any;
|
|
75459
|
+
const localVarQueryParameter = {} as any;
|
|
75460
|
+
|
|
75461
|
+
if(configuration && configuration.apiVersion) {
|
|
75462
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
75463
|
+
}
|
|
75464
|
+
|
|
75465
|
+
|
|
75466
|
+
|
|
75347
75467
|
// authentication ultraCartOauth required
|
|
75348
75468
|
// oauth required
|
|
75349
75469
|
if (configuration && configuration.accessToken) {
|
|
@@ -76076,6 +76196,73 @@ export const ItemApiFetchParamCreator = function (configuration?: Configuration)
|
|
|
76076
76196
|
options: localVarRequestOptions,
|
|
76077
76197
|
};
|
|
76078
76198
|
},
|
|
76199
|
+
/**
|
|
76200
|
+
* Update an item shipping distribution center
|
|
76201
|
+
* @summary Update an item shipping distribution center
|
|
76202
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
76203
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
76204
|
+
* @param {string} distribution_center_code
|
|
76205
|
+
* @param {*} [options] Override http request option.
|
|
76206
|
+
* @throws {RequiredError}
|
|
76207
|
+
*/
|
|
76208
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options: any = {}): FetchArgs {
|
|
76209
|
+
// verify required parameter 'item_shipping_distribution_center' is not null or undefined
|
|
76210
|
+
if (item_shipping_distribution_center === null || item_shipping_distribution_center === undefined) {
|
|
76211
|
+
throw new RequiredError('item_shipping_distribution_center','Required parameter item_shipping_distribution_center was null or undefined when calling updateItemShippingDistributionCenterByCode.');
|
|
76212
|
+
}
|
|
76213
|
+
// verify required parameter 'merchant_item_oid' is not null or undefined
|
|
76214
|
+
if (merchant_item_oid === null || merchant_item_oid === undefined) {
|
|
76215
|
+
throw new RequiredError('merchant_item_oid','Required parameter merchant_item_oid was null or undefined when calling updateItemShippingDistributionCenterByCode.');
|
|
76216
|
+
}
|
|
76217
|
+
// verify required parameter 'distribution_center_code' is not null or undefined
|
|
76218
|
+
if (distribution_center_code === null || distribution_center_code === undefined) {
|
|
76219
|
+
throw new RequiredError('distribution_center_code','Required parameter distribution_center_code was null or undefined when calling updateItemShippingDistributionCenterByCode.');
|
|
76220
|
+
}
|
|
76221
|
+
const localVarPath = `/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}`
|
|
76222
|
+
.replace(`{${"merchant_item_oid"}}`, encodeURIComponent(String(merchant_item_oid)))
|
|
76223
|
+
.replace(`{${"distribution_center_code"}}`, encodeURIComponent(String(distribution_center_code)));
|
|
76224
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
76225
|
+
const localVarRequestOptions = Object.assign({ method: 'PUT' }, options);
|
|
76226
|
+
const localVarHeaderParameter = {} as any;
|
|
76227
|
+
const localVarQueryParameter = {} as any;
|
|
76228
|
+
|
|
76229
|
+
if(configuration && configuration.apiVersion) {
|
|
76230
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
76231
|
+
}
|
|
76232
|
+
|
|
76233
|
+
|
|
76234
|
+
|
|
76235
|
+
// authentication ultraCartOauth required
|
|
76236
|
+
// oauth required
|
|
76237
|
+
if (configuration && configuration.accessToken) {
|
|
76238
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
76239
|
+
? configuration.accessToken("ultraCartOauth", ["item_write"])
|
|
76240
|
+
: configuration.accessToken;
|
|
76241
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
76242
|
+
}
|
|
76243
|
+
|
|
76244
|
+
// authentication ultraCartSimpleApiKey required
|
|
76245
|
+
if (configuration && configuration.apiKey) {
|
|
76246
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
76247
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
76248
|
+
: configuration.apiKey;
|
|
76249
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
76250
|
+
}
|
|
76251
|
+
|
|
76252
|
+
localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
|
|
76253
|
+
|
|
76254
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
76255
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
76256
|
+
delete localVarUrlObj.search;
|
|
76257
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
76258
|
+
const needsSerialization = (<any>"ItemShippingDistributionCenter" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
|
|
76259
|
+
localVarRequestOptions.body = needsSerialization ? JSON.stringify(item_shipping_distribution_center || {}) : (item_shipping_distribution_center || "");
|
|
76260
|
+
|
|
76261
|
+
return {
|
|
76262
|
+
url: url.format(localVarUrlObj),
|
|
76263
|
+
options: localVarRequestOptions,
|
|
76264
|
+
};
|
|
76265
|
+
},
|
|
76079
76266
|
/**
|
|
76080
76267
|
* Update multiple item on the UltraCart account.
|
|
76081
76268
|
* @summary Update multiple items
|
|
@@ -76479,6 +76666,30 @@ export const ItemApiFp = function(configuration?: Configuration) {
|
|
|
76479
76666
|
});
|
|
76480
76667
|
};
|
|
76481
76668
|
},
|
|
76669
|
+
/**
|
|
76670
|
+
* Retrieve an item shipping distribution center.
|
|
76671
|
+
* @summary Retrieve an item shipping distribution center
|
|
76672
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
76673
|
+
* @param {string} distribution_center_code
|
|
76674
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
76675
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
76676
|
+
* @param {*} [options] Override http request option.
|
|
76677
|
+
* @throws {RequiredError}
|
|
76678
|
+
*/
|
|
76679
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemShippingDistributionCenterResponse> {
|
|
76680
|
+
const localVarFetchArgs = ItemApiFetchParamCreator(configuration).getItemShippingDistributionCenterByCode(merchant_item_oid, distribution_center_code, _expand, _placeholders, options);
|
|
76681
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
76682
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
76683
|
+
|
|
76684
|
+
if (response.status >= 200 && response.status < 300) {
|
|
76685
|
+
return response.json();
|
|
76686
|
+
|
|
76687
|
+
} else {
|
|
76688
|
+
throw response;
|
|
76689
|
+
}
|
|
76690
|
+
});
|
|
76691
|
+
};
|
|
76692
|
+
},
|
|
76482
76693
|
/**
|
|
76483
76694
|
* 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.
|
|
76484
76695
|
* @summary Retrieve items
|
|
@@ -76731,6 +76942,29 @@ export const ItemApiFp = function(configuration?: Configuration) {
|
|
|
76731
76942
|
});
|
|
76732
76943
|
};
|
|
76733
76944
|
},
|
|
76945
|
+
/**
|
|
76946
|
+
* Update an item shipping distribution center
|
|
76947
|
+
* @summary Update an item shipping distribution center
|
|
76948
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
76949
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
76950
|
+
* @param {string} distribution_center_code
|
|
76951
|
+
* @param {*} [options] Override http request option.
|
|
76952
|
+
* @throws {RequiredError}
|
|
76953
|
+
*/
|
|
76954
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response> {
|
|
76955
|
+
const localVarFetchArgs = ItemApiFetchParamCreator(configuration).updateItemShippingDistributionCenterByCode(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options);
|
|
76956
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
76957
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
76958
|
+
|
|
76959
|
+
if (response.status >= 200 && response.status < 300) {
|
|
76960
|
+
return response;
|
|
76961
|
+
|
|
76962
|
+
} else {
|
|
76963
|
+
throw response;
|
|
76964
|
+
}
|
|
76965
|
+
});
|
|
76966
|
+
};
|
|
76967
|
+
},
|
|
76734
76968
|
/**
|
|
76735
76969
|
* Update multiple item on the UltraCart account.
|
|
76736
76970
|
* @summary Update multiple items
|
|
@@ -76907,6 +77141,19 @@ export const ItemApiFactory = function (configuration?: Configuration, fetch?: F
|
|
|
76907
77141
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any) {
|
|
76908
77142
|
return ItemApiFp(configuration).getItemByMerchantItemId(merchant_item_id, _expand, _placeholders, options)(fetch, basePath);
|
|
76909
77143
|
},
|
|
77144
|
+
/**
|
|
77145
|
+
* Retrieve an item shipping distribution center.
|
|
77146
|
+
* @summary Retrieve an item shipping distribution center
|
|
77147
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
77148
|
+
* @param {string} distribution_center_code
|
|
77149
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
77150
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
77151
|
+
* @param {*} [options] Override http request option.
|
|
77152
|
+
* @throws {RequiredError}
|
|
77153
|
+
*/
|
|
77154
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any) {
|
|
77155
|
+
return ItemApiFp(configuration).getItemShippingDistributionCenterByCode(merchant_item_oid, distribution_center_code, _expand, _placeholders, options)(fetch, basePath);
|
|
77156
|
+
},
|
|
76910
77157
|
/**
|
|
76911
77158
|
* 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.
|
|
76912
77159
|
* @summary Retrieve items
|
|
@@ -77038,6 +77285,18 @@ export const ItemApiFactory = function (configuration?: Configuration, fetch?: F
|
|
|
77038
77285
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any) {
|
|
77039
77286
|
return ItemApiFp(configuration).updateItem(item, merchant_item_oid, _expand, _placeholders, options)(fetch, basePath);
|
|
77040
77287
|
},
|
|
77288
|
+
/**
|
|
77289
|
+
* Update an item shipping distribution center
|
|
77290
|
+
* @summary Update an item shipping distribution center
|
|
77291
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
77292
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
77293
|
+
* @param {string} distribution_center_code
|
|
77294
|
+
* @param {*} [options] Override http request option.
|
|
77295
|
+
* @throws {RequiredError}
|
|
77296
|
+
*/
|
|
77297
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any) {
|
|
77298
|
+
return ItemApiFp(configuration).updateItemShippingDistributionCenterByCode(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options)(fetch, basePath);
|
|
77299
|
+
},
|
|
77041
77300
|
/**
|
|
77042
77301
|
* Update multiple item on the UltraCart account.
|
|
77043
77302
|
* @summary Update multiple items
|
|
@@ -77181,6 +77440,19 @@ export interface ItemApiInterface {
|
|
|
77181
77440
|
*/
|
|
77182
77441
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
77183
77442
|
|
|
77443
|
+
/**
|
|
77444
|
+
* Retrieve an item shipping distribution center.
|
|
77445
|
+
* @summary Retrieve an item shipping distribution center
|
|
77446
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
77447
|
+
* @param {string} distribution_center_code
|
|
77448
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
77449
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
77450
|
+
* @param {*} [options] Override http request option.
|
|
77451
|
+
* @throws {RequiredError}
|
|
77452
|
+
* @memberof ItemApiInterface
|
|
77453
|
+
*/
|
|
77454
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemShippingDistributionCenterResponse>;
|
|
77455
|
+
|
|
77184
77456
|
/**
|
|
77185
77457
|
* 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.
|
|
77186
77458
|
* @summary Retrieve items
|
|
@@ -77312,6 +77584,18 @@ export interface ItemApiInterface {
|
|
|
77312
77584
|
*/
|
|
77313
77585
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
77314
77586
|
|
|
77587
|
+
/**
|
|
77588
|
+
* Update an item shipping distribution center
|
|
77589
|
+
* @summary Update an item shipping distribution center
|
|
77590
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
77591
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
77592
|
+
* @param {string} distribution_center_code
|
|
77593
|
+
* @param {*} [options] Override http request option.
|
|
77594
|
+
* @throws {RequiredError}
|
|
77595
|
+
* @memberof ItemApiInterface
|
|
77596
|
+
*/
|
|
77597
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): Promise<{}>;
|
|
77598
|
+
|
|
77315
77599
|
/**
|
|
77316
77600
|
* Update multiple item on the UltraCart account.
|
|
77317
77601
|
* @summary Update multiple items
|
|
@@ -77473,6 +77757,21 @@ export class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
77473
77757
|
return ItemApiFp(this.configuration).getItemByMerchantItemId(merchant_item_id, _expand, _placeholders, options)(this.fetch, this.basePath);
|
|
77474
77758
|
}
|
|
77475
77759
|
|
|
77760
|
+
/**
|
|
77761
|
+
* Retrieve an item shipping distribution center.
|
|
77762
|
+
* @summary Retrieve an item shipping distribution center
|
|
77763
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
77764
|
+
* @param {string} distribution_center_code
|
|
77765
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
77766
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
77767
|
+
* @param {*} [options] Override http request option.
|
|
77768
|
+
* @throws {RequiredError}
|
|
77769
|
+
* @memberof ItemApi
|
|
77770
|
+
*/
|
|
77771
|
+
public getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any) {
|
|
77772
|
+
return ItemApiFp(this.configuration).getItemShippingDistributionCenterByCode(merchant_item_oid, distribution_center_code, _expand, _placeholders, options)(this.fetch, this.basePath);
|
|
77773
|
+
}
|
|
77774
|
+
|
|
77476
77775
|
/**
|
|
77477
77776
|
* 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.
|
|
77478
77777
|
* @summary Retrieve items
|
|
@@ -77626,6 +77925,20 @@ export class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
77626
77925
|
return ItemApiFp(this.configuration).updateItem(item, merchant_item_oid, _expand, _placeholders, options)(this.fetch, this.basePath);
|
|
77627
77926
|
}
|
|
77628
77927
|
|
|
77928
|
+
/**
|
|
77929
|
+
* Update an item shipping distribution center
|
|
77930
|
+
* @summary Update an item shipping distribution center
|
|
77931
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
77932
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
77933
|
+
* @param {string} distribution_center_code
|
|
77934
|
+
* @param {*} [options] Override http request option.
|
|
77935
|
+
* @throws {RequiredError}
|
|
77936
|
+
* @memberof ItemApi
|
|
77937
|
+
*/
|
|
77938
|
+
public updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any) {
|
|
77939
|
+
return ItemApiFp(this.configuration).updateItemShippingDistributionCenterByCode(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, options)(this.fetch, this.basePath);
|
|
77940
|
+
}
|
|
77941
|
+
|
|
77629
77942
|
/**
|
|
77630
77943
|
* Update multiple item on the UltraCart account.
|
|
77631
77944
|
* @summary Update multiple items
|
package/dist/api.d.ts
CHANGED
|
@@ -6882,6 +6882,12 @@ export interface ConversationAgentAuth {
|
|
|
6882
6882
|
* @memberof ConversationAgentAuth
|
|
6883
6883
|
*/
|
|
6884
6884
|
pbx_worker_token?: string;
|
|
6885
|
+
/**
|
|
6886
|
+
*
|
|
6887
|
+
* @type {string}
|
|
6888
|
+
* @memberof ConversationAgentAuth
|
|
6889
|
+
*/
|
|
6890
|
+
pbx_worker_token_v2?: string;
|
|
6885
6891
|
/**
|
|
6886
6892
|
*
|
|
6887
6893
|
* @type {Array<ConversationTwilioAccount>}
|
|
@@ -8956,6 +8962,12 @@ export interface ConversationParticipant {
|
|
|
8956
8962
|
* @interface ConversationPbxAgent
|
|
8957
8963
|
*/
|
|
8958
8964
|
export interface ConversationPbxAgent {
|
|
8965
|
+
/**
|
|
8966
|
+
* Flag to indicate if the agent is AI
|
|
8967
|
+
* @type {boolean}
|
|
8968
|
+
* @memberof ConversationPbxAgent
|
|
8969
|
+
*/
|
|
8970
|
+
ai?: boolean;
|
|
8959
8971
|
/**
|
|
8960
8972
|
* Cellphone number of agent in E.164 format
|
|
8961
8973
|
* @type {string}
|
|
@@ -30182,7 +30194,9 @@ export declare namespace ItemRelatedItem {
|
|
|
30182
30194
|
*/
|
|
30183
30195
|
enum TypeEnum {
|
|
30184
30196
|
System,
|
|
30185
|
-
UserDefined
|
|
30197
|
+
UserDefined,
|
|
30198
|
+
Addon,
|
|
30199
|
+
Complementary
|
|
30186
30200
|
}
|
|
30187
30201
|
}
|
|
30188
30202
|
/**
|
|
@@ -31319,6 +31333,43 @@ export interface ItemShippingDistributionCenter {
|
|
|
31319
31333
|
*/
|
|
31320
31334
|
stock_picking_location?: string;
|
|
31321
31335
|
}
|
|
31336
|
+
/**
|
|
31337
|
+
*
|
|
31338
|
+
* @export
|
|
31339
|
+
* @interface ItemShippingDistributionCenterResponse
|
|
31340
|
+
*/
|
|
31341
|
+
export interface ItemShippingDistributionCenterResponse {
|
|
31342
|
+
/**
|
|
31343
|
+
*
|
|
31344
|
+
* @type {ModelError}
|
|
31345
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31346
|
+
*/
|
|
31347
|
+
error?: ModelError;
|
|
31348
|
+
/**
|
|
31349
|
+
*
|
|
31350
|
+
* @type {ItemShippingDistributionCenter}
|
|
31351
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31352
|
+
*/
|
|
31353
|
+
itemShippingDistributionCenter?: ItemShippingDistributionCenter;
|
|
31354
|
+
/**
|
|
31355
|
+
*
|
|
31356
|
+
* @type {ResponseMetadata}
|
|
31357
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31358
|
+
*/
|
|
31359
|
+
metadata?: ResponseMetadata;
|
|
31360
|
+
/**
|
|
31361
|
+
* Indicates if API call was successful
|
|
31362
|
+
* @type {boolean}
|
|
31363
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31364
|
+
*/
|
|
31365
|
+
success?: boolean;
|
|
31366
|
+
/**
|
|
31367
|
+
*
|
|
31368
|
+
* @type {Warning}
|
|
31369
|
+
* @memberof ItemShippingDistributionCenterResponse
|
|
31370
|
+
*/
|
|
31371
|
+
warning?: Warning;
|
|
31372
|
+
}
|
|
31322
31373
|
/**
|
|
31323
31374
|
*
|
|
31324
31375
|
* @export
|
|
@@ -57579,6 +57630,17 @@ export declare const ItemApiFetchParamCreator: (configuration?: Configuration) =
|
|
|
57579
57630
|
* @throws {RequiredError}
|
|
57580
57631
|
*/
|
|
57581
57632
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): FetchArgs;
|
|
57633
|
+
/**
|
|
57634
|
+
* Retrieve an item shipping distribution center.
|
|
57635
|
+
* @summary Retrieve an item shipping distribution center
|
|
57636
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
57637
|
+
* @param {string} distribution_center_code
|
|
57638
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
57639
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
57640
|
+
* @param {*} [options] Override http request option.
|
|
57641
|
+
* @throws {RequiredError}
|
|
57642
|
+
*/
|
|
57643
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): FetchArgs;
|
|
57582
57644
|
/**
|
|
57583
57645
|
* 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.
|
|
57584
57646
|
* @summary Retrieve items
|
|
@@ -57688,6 +57750,16 @@ export declare const ItemApiFetchParamCreator: (configuration?: Configuration) =
|
|
|
57688
57750
|
* @throws {RequiredError}
|
|
57689
57751
|
*/
|
|
57690
57752
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): FetchArgs;
|
|
57753
|
+
/**
|
|
57754
|
+
* Update an item shipping distribution center
|
|
57755
|
+
* @summary Update an item shipping distribution center
|
|
57756
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
57757
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
57758
|
+
* @param {string} distribution_center_code
|
|
57759
|
+
* @param {*} [options] Override http request option.
|
|
57760
|
+
* @throws {RequiredError}
|
|
57761
|
+
*/
|
|
57762
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): FetchArgs;
|
|
57691
57763
|
/**
|
|
57692
57764
|
* Update multiple item on the UltraCart account.
|
|
57693
57765
|
* @summary Update multiple items
|
|
@@ -57804,6 +57876,17 @@ export declare const ItemApiFp: (configuration?: Configuration) => {
|
|
|
57804
57876
|
* @throws {RequiredError}
|
|
57805
57877
|
*/
|
|
57806
57878
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemResponse>;
|
|
57879
|
+
/**
|
|
57880
|
+
* Retrieve an item shipping distribution center.
|
|
57881
|
+
* @summary Retrieve an item shipping distribution center
|
|
57882
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
57883
|
+
* @param {string} distribution_center_code
|
|
57884
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
57885
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
57886
|
+
* @param {*} [options] Override http request option.
|
|
57887
|
+
* @throws {RequiredError}
|
|
57888
|
+
*/
|
|
57889
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemShippingDistributionCenterResponse>;
|
|
57807
57890
|
/**
|
|
57808
57891
|
* 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.
|
|
57809
57892
|
* @summary Retrieve items
|
|
@@ -57913,6 +57996,16 @@ export declare const ItemApiFp: (configuration?: Configuration) => {
|
|
|
57913
57996
|
* @throws {RequiredError}
|
|
57914
57997
|
*/
|
|
57915
57998
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ItemResponse>;
|
|
57999
|
+
/**
|
|
58000
|
+
* Update an item shipping distribution center
|
|
58001
|
+
* @summary Update an item shipping distribution center
|
|
58002
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
58003
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
58004
|
+
* @param {string} distribution_center_code
|
|
58005
|
+
* @param {*} [options] Override http request option.
|
|
58006
|
+
* @throws {RequiredError}
|
|
58007
|
+
*/
|
|
58008
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<Response>;
|
|
57916
58009
|
/**
|
|
57917
58010
|
* Update multiple item on the UltraCart account.
|
|
57918
58011
|
* @summary Update multiple items
|
|
@@ -58029,6 +58122,17 @@ export declare const ItemApiFactory: (configuration?: Configuration, fetch?: Fet
|
|
|
58029
58122
|
* @throws {RequiredError}
|
|
58030
58123
|
*/
|
|
58031
58124
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58125
|
+
/**
|
|
58126
|
+
* Retrieve an item shipping distribution center.
|
|
58127
|
+
* @summary Retrieve an item shipping distribution center
|
|
58128
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
58129
|
+
* @param {string} distribution_center_code
|
|
58130
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
58131
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
58132
|
+
* @param {*} [options] Override http request option.
|
|
58133
|
+
* @throws {RequiredError}
|
|
58134
|
+
*/
|
|
58135
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemShippingDistributionCenterResponse>;
|
|
58032
58136
|
/**
|
|
58033
58137
|
* 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.
|
|
58034
58138
|
* @summary Retrieve items
|
|
@@ -58138,6 +58242,16 @@ export declare const ItemApiFactory: (configuration?: Configuration, fetch?: Fet
|
|
|
58138
58242
|
* @throws {RequiredError}
|
|
58139
58243
|
*/
|
|
58140
58244
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58245
|
+
/**
|
|
58246
|
+
* Update an item shipping distribution center
|
|
58247
|
+
* @summary Update an item shipping distribution center
|
|
58248
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
58249
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
58250
|
+
* @param {string} distribution_center_code
|
|
58251
|
+
* @param {*} [options] Override http request option.
|
|
58252
|
+
* @throws {RequiredError}
|
|
58253
|
+
*/
|
|
58254
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): Promise<Response>;
|
|
58141
58255
|
/**
|
|
58142
58256
|
* Update multiple item on the UltraCart account.
|
|
58143
58257
|
* @summary Update multiple items
|
|
@@ -58264,6 +58378,18 @@ export interface ItemApiInterface {
|
|
|
58264
58378
|
* @memberof ItemApiInterface
|
|
58265
58379
|
*/
|
|
58266
58380
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58381
|
+
/**
|
|
58382
|
+
* Retrieve an item shipping distribution center.
|
|
58383
|
+
* @summary Retrieve an item shipping distribution center
|
|
58384
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
58385
|
+
* @param {string} distribution_center_code
|
|
58386
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
58387
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
58388
|
+
* @param {*} [options] Override http request option.
|
|
58389
|
+
* @throws {RequiredError}
|
|
58390
|
+
* @memberof ItemApiInterface
|
|
58391
|
+
*/
|
|
58392
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemShippingDistributionCenterResponse>;
|
|
58267
58393
|
/**
|
|
58268
58394
|
* 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.
|
|
58269
58395
|
* @summary Retrieve items
|
|
@@ -58384,6 +58510,17 @@ export interface ItemApiInterface {
|
|
|
58384
58510
|
* @memberof ItemApiInterface
|
|
58385
58511
|
*/
|
|
58386
58512
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58513
|
+
/**
|
|
58514
|
+
* Update an item shipping distribution center
|
|
58515
|
+
* @summary Update an item shipping distribution center
|
|
58516
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
58517
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
58518
|
+
* @param {string} distribution_center_code
|
|
58519
|
+
* @param {*} [options] Override http request option.
|
|
58520
|
+
* @throws {RequiredError}
|
|
58521
|
+
* @memberof ItemApiInterface
|
|
58522
|
+
*/
|
|
58523
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): Promise<{}>;
|
|
58387
58524
|
/**
|
|
58388
58525
|
* Update multiple item on the UltraCart account.
|
|
58389
58526
|
* @summary Update multiple items
|
|
@@ -58514,6 +58651,18 @@ export declare class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
58514
58651
|
* @memberof ItemApi
|
|
58515
58652
|
*/
|
|
58516
58653
|
getItemByMerchantItemId(merchant_item_id: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58654
|
+
/**
|
|
58655
|
+
* Retrieve an item shipping distribution center.
|
|
58656
|
+
* @summary Retrieve an item shipping distribution center
|
|
58657
|
+
* @param {number} merchant_item_oid The item oid to retrieve.
|
|
58658
|
+
* @param {string} distribution_center_code
|
|
58659
|
+
* @param {string} [_expand] The object expansion to perform on the result. See documentation for examples
|
|
58660
|
+
* @param {boolean} [_placeholders] Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
58661
|
+
* @param {*} [options] Override http request option.
|
|
58662
|
+
* @throws {RequiredError}
|
|
58663
|
+
* @memberof ItemApi
|
|
58664
|
+
*/
|
|
58665
|
+
getItemShippingDistributionCenterByCode(merchant_item_oid: number, distribution_center_code: string, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemShippingDistributionCenterResponse>;
|
|
58517
58666
|
/**
|
|
58518
58667
|
* 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.
|
|
58519
58668
|
* @summary Retrieve items
|
|
@@ -58634,6 +58783,17 @@ export declare class ItemApi extends BaseAPI implements ItemApiInterface {
|
|
|
58634
58783
|
* @memberof ItemApi
|
|
58635
58784
|
*/
|
|
58636
58785
|
updateItem(item: Item, merchant_item_oid: number, _expand?: string, _placeholders?: boolean, options?: any): Promise<ItemResponse>;
|
|
58786
|
+
/**
|
|
58787
|
+
* Update an item shipping distribution center
|
|
58788
|
+
* @summary Update an item shipping distribution center
|
|
58789
|
+
* @param {ItemShippingDistributionCenter} item_shipping_distribution_center Item shipping distribution center
|
|
58790
|
+
* @param {number} merchant_item_oid The item oid to update.
|
|
58791
|
+
* @param {string} distribution_center_code
|
|
58792
|
+
* @param {*} [options] Override http request option.
|
|
58793
|
+
* @throws {RequiredError}
|
|
58794
|
+
* @memberof ItemApi
|
|
58795
|
+
*/
|
|
58796
|
+
updateItemShippingDistributionCenterByCode(item_shipping_distribution_center: ItemShippingDistributionCenter, merchant_item_oid: number, distribution_center_code: string, options?: any): Promise<Response>;
|
|
58637
58797
|
/**
|
|
58638
58798
|
* Update multiple item on the UltraCart account.
|
|
58639
58799
|
* @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
|