ultracart_rest_api_v2_typescript 3.11.6 → 3.11.8
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 +215 -0
- package/dist/api.d.ts +151 -0
- package/dist/api.js +89 -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.8
|
|
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.8 --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.8 | 04/22/2025 | order property fields for created_by and created_dts |
|
|
58
|
+
| 3.11.7 | 04/21/2025 | conversation agent additional fields |
|
|
57
59
|
| 3.11.6 | 04/16/2025 | added channel partner order item properties |
|
|
58
60
|
| 3.11.5 | 03/28/2025 | added paypal fastlane constants for payments |
|
|
59
61
|
| 3.11.4 | 03/07/2025 | updated github readme.md |
|
package/api.ts
CHANGED
|
@@ -5344,6 +5344,80 @@ export interface CartValidationResponse {
|
|
|
5344
5344
|
errors?: Array<string>;
|
|
5345
5345
|
}
|
|
5346
5346
|
|
|
5347
|
+
/**
|
|
5348
|
+
*
|
|
5349
|
+
* @export
|
|
5350
|
+
* @interface ChanelPartnerReasonCodesResponse
|
|
5351
|
+
*/
|
|
5352
|
+
export interface ChanelPartnerReasonCodesResponse {
|
|
5353
|
+
/**
|
|
5354
|
+
*
|
|
5355
|
+
* @type {ModelError}
|
|
5356
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5357
|
+
*/
|
|
5358
|
+
error?: ModelError;
|
|
5359
|
+
/**
|
|
5360
|
+
* True if the item level refund reason is required
|
|
5361
|
+
* @type {boolean}
|
|
5362
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5363
|
+
*/
|
|
5364
|
+
item_level_refund_reason_required?: boolean;
|
|
5365
|
+
/**
|
|
5366
|
+
* Reason codes available at the item level.
|
|
5367
|
+
* @type {Array<OrderReason>}
|
|
5368
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5369
|
+
*/
|
|
5370
|
+
item_level_refund_reasons?: Array<OrderReason>;
|
|
5371
|
+
/**
|
|
5372
|
+
* Return codes available at the item level.
|
|
5373
|
+
* @type {Array<OrderReason>}
|
|
5374
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5375
|
+
*/
|
|
5376
|
+
item_level_return_reasons?: Array<OrderReason>;
|
|
5377
|
+
/**
|
|
5378
|
+
*
|
|
5379
|
+
* @type {ResponseMetadata}
|
|
5380
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5381
|
+
*/
|
|
5382
|
+
metadata?: ResponseMetadata;
|
|
5383
|
+
/**
|
|
5384
|
+
* True if the order level refund reason is required
|
|
5385
|
+
* @type {boolean}
|
|
5386
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5387
|
+
*/
|
|
5388
|
+
order_level_refund_reason_required?: boolean;
|
|
5389
|
+
/**
|
|
5390
|
+
* Reason codes available at the order level.
|
|
5391
|
+
* @type {Array<OrderReason>}
|
|
5392
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5393
|
+
*/
|
|
5394
|
+
order_level_refund_reasons?: Array<OrderReason>;
|
|
5395
|
+
/**
|
|
5396
|
+
* True if the order level reject reason is required
|
|
5397
|
+
* @type {boolean}
|
|
5398
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5399
|
+
*/
|
|
5400
|
+
order_level_reject_reason_required?: boolean;
|
|
5401
|
+
/**
|
|
5402
|
+
* Reject codes available at the order level.
|
|
5403
|
+
* @type {Array<OrderReason>}
|
|
5404
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5405
|
+
*/
|
|
5406
|
+
order_level_reject_reasons?: Array<OrderReason>;
|
|
5407
|
+
/**
|
|
5408
|
+
* Indicates if API call was successful
|
|
5409
|
+
* @type {boolean}
|
|
5410
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5411
|
+
*/
|
|
5412
|
+
success?: boolean;
|
|
5413
|
+
/**
|
|
5414
|
+
*
|
|
5415
|
+
* @type {Warning}
|
|
5416
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5417
|
+
*/
|
|
5418
|
+
warning?: Warning;
|
|
5419
|
+
}
|
|
5420
|
+
|
|
5347
5421
|
/**
|
|
5348
5422
|
*
|
|
5349
5423
|
* @export
|
|
@@ -7229,6 +7303,30 @@ export interface ConversationAgentAuthResponse {
|
|
|
7229
7303
|
* @interface ConversationAgentProfile
|
|
7230
7304
|
*/
|
|
7231
7305
|
export interface ConversationAgentProfile {
|
|
7306
|
+
/**
|
|
7307
|
+
* AI powered chat bot
|
|
7308
|
+
* @type {boolean}
|
|
7309
|
+
* @memberof ConversationAgentProfile
|
|
7310
|
+
*/
|
|
7311
|
+
ai?: boolean;
|
|
7312
|
+
/**
|
|
7313
|
+
* Additional instructions for this AI when handle web chats
|
|
7314
|
+
* @type {string}
|
|
7315
|
+
* @memberof ConversationAgentProfile
|
|
7316
|
+
*/
|
|
7317
|
+
ai_chat_instructions?: string;
|
|
7318
|
+
/**
|
|
7319
|
+
* Persona of this AI agent
|
|
7320
|
+
* @type {string}
|
|
7321
|
+
* @memberof ConversationAgentProfile
|
|
7322
|
+
*/
|
|
7323
|
+
ai_persona?: string;
|
|
7324
|
+
/**
|
|
7325
|
+
* Additional instructions for this AI when handle SMS messages
|
|
7326
|
+
* @type {string}
|
|
7327
|
+
* @memberof ConversationAgentProfile
|
|
7328
|
+
*/
|
|
7329
|
+
ai_sms_instructions?: string;
|
|
7232
7330
|
/**
|
|
7233
7331
|
* The number of engagement chats that can be pushed on them at any given time.
|
|
7234
7332
|
* @type {number}
|
|
@@ -34977,6 +35075,18 @@ export interface OrderProcessPaymentResponse {
|
|
|
34977
35075
|
* @interface OrderProperty
|
|
34978
35076
|
*/
|
|
34979
35077
|
export interface OrderProperty {
|
|
35078
|
+
/**
|
|
35079
|
+
* Created by user
|
|
35080
|
+
* @type {string}
|
|
35081
|
+
* @memberof OrderProperty
|
|
35082
|
+
*/
|
|
35083
|
+
created_by?: string;
|
|
35084
|
+
/**
|
|
35085
|
+
* The date/time that the property was created by the user
|
|
35086
|
+
* @type {string}
|
|
35087
|
+
* @memberof OrderProperty
|
|
35088
|
+
*/
|
|
35089
|
+
created_dts?: string;
|
|
34980
35090
|
/**
|
|
34981
35091
|
* True if this property is displayed to the customer
|
|
34982
35092
|
* @type {boolean}
|
|
@@ -47570,6 +47680,58 @@ export const ChannelPartnerApiFetchParamCreator = function (configuration?: Conf
|
|
|
47570
47680
|
options: localVarRequestOptions,
|
|
47571
47681
|
};
|
|
47572
47682
|
},
|
|
47683
|
+
/**
|
|
47684
|
+
* Retrieve reject and refund reason codes.
|
|
47685
|
+
* @summary Retrieve reject and refund reason codes.
|
|
47686
|
+
* @param {number} channel_partner_oid
|
|
47687
|
+
* @param {*} [options] Override http request option.
|
|
47688
|
+
* @throws {RequiredError}
|
|
47689
|
+
*/
|
|
47690
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options: any = {}): FetchArgs {
|
|
47691
|
+
// verify required parameter 'channel_partner_oid' is not null or undefined
|
|
47692
|
+
if (channel_partner_oid === null || channel_partner_oid === undefined) {
|
|
47693
|
+
throw new RequiredError('channel_partner_oid','Required parameter channel_partner_oid was null or undefined when calling getChannelPartnerReasonCodes.');
|
|
47694
|
+
}
|
|
47695
|
+
const localVarPath = `/channel_partner/channel_partners/{channel_partner_oid}/reason_codes`
|
|
47696
|
+
.replace(`{${"channel_partner_oid"}}`, encodeURIComponent(String(channel_partner_oid)));
|
|
47697
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
47698
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
47699
|
+
const localVarHeaderParameter = {} as any;
|
|
47700
|
+
const localVarQueryParameter = {} as any;
|
|
47701
|
+
|
|
47702
|
+
if(configuration && configuration.apiVersion) {
|
|
47703
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
47704
|
+
}
|
|
47705
|
+
|
|
47706
|
+
|
|
47707
|
+
|
|
47708
|
+
// authentication ultraCartOauth required
|
|
47709
|
+
// oauth required
|
|
47710
|
+
if (configuration && configuration.accessToken) {
|
|
47711
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
47712
|
+
? configuration.accessToken("ultraCartOauth", ["channel_partner_read"])
|
|
47713
|
+
: configuration.accessToken;
|
|
47714
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
47715
|
+
}
|
|
47716
|
+
|
|
47717
|
+
// authentication ultraCartSimpleApiKey required
|
|
47718
|
+
if (configuration && configuration.apiKey) {
|
|
47719
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
47720
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
47721
|
+
: configuration.apiKey;
|
|
47722
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
47723
|
+
}
|
|
47724
|
+
|
|
47725
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
47726
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
47727
|
+
delete localVarUrlObj.search;
|
|
47728
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
47729
|
+
|
|
47730
|
+
return {
|
|
47731
|
+
url: url.format(localVarUrlObj),
|
|
47732
|
+
options: localVarRequestOptions,
|
|
47733
|
+
};
|
|
47734
|
+
},
|
|
47573
47735
|
/**
|
|
47574
47736
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
47575
47737
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -48169,6 +48331,27 @@ export const ChannelPartnerApiFp = function(configuration?: Configuration) {
|
|
|
48169
48331
|
});
|
|
48170
48332
|
};
|
|
48171
48333
|
},
|
|
48334
|
+
/**
|
|
48335
|
+
* Retrieve reject and refund reason codes.
|
|
48336
|
+
* @summary Retrieve reject and refund reason codes.
|
|
48337
|
+
* @param {number} channel_partner_oid
|
|
48338
|
+
* @param {*} [options] Override http request option.
|
|
48339
|
+
* @throws {RequiredError}
|
|
48340
|
+
*/
|
|
48341
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ChanelPartnerReasonCodesResponse> {
|
|
48342
|
+
const localVarFetchArgs = ChannelPartnerApiFetchParamCreator(configuration).getChannelPartnerReasonCodes(channel_partner_oid, options);
|
|
48343
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
48344
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
48345
|
+
|
|
48346
|
+
if (response.status >= 200 && response.status < 300) {
|
|
48347
|
+
return response.json();
|
|
48348
|
+
|
|
48349
|
+
} else {
|
|
48350
|
+
throw response;
|
|
48351
|
+
}
|
|
48352
|
+
});
|
|
48353
|
+
};
|
|
48354
|
+
},
|
|
48172
48355
|
/**
|
|
48173
48356
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
48174
48357
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -48410,6 +48593,16 @@ export const ChannelPartnerApiFactory = function (configuration?: Configuration,
|
|
|
48410
48593
|
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any) {
|
|
48411
48594
|
return ChannelPartnerApiFp(configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(fetch, basePath);
|
|
48412
48595
|
},
|
|
48596
|
+
/**
|
|
48597
|
+
* Retrieve reject and refund reason codes.
|
|
48598
|
+
* @summary Retrieve reject and refund reason codes.
|
|
48599
|
+
* @param {number} channel_partner_oid
|
|
48600
|
+
* @param {*} [options] Override http request option.
|
|
48601
|
+
* @throws {RequiredError}
|
|
48602
|
+
*/
|
|
48603
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any) {
|
|
48604
|
+
return ChannelPartnerApiFp(configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(fetch, basePath);
|
|
48605
|
+
},
|
|
48413
48606
|
/**
|
|
48414
48607
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
48415
48608
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -48574,6 +48767,16 @@ export interface ChannelPartnerApiInterface {
|
|
|
48574
48767
|
*/
|
|
48575
48768
|
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
48576
48769
|
|
|
48770
|
+
/**
|
|
48771
|
+
* Retrieve reject and refund reason codes.
|
|
48772
|
+
* @summary Retrieve reject and refund reason codes.
|
|
48773
|
+
* @param {number} channel_partner_oid
|
|
48774
|
+
* @param {*} [options] Override http request option.
|
|
48775
|
+
* @throws {RequiredError}
|
|
48776
|
+
* @memberof ChannelPartnerApiInterface
|
|
48777
|
+
*/
|
|
48778
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): Promise<ChanelPartnerReasonCodesResponse>;
|
|
48779
|
+
|
|
48577
48780
|
/**
|
|
48578
48781
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
48579
48782
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -48752,6 +48955,18 @@ export class ChannelPartnerApi extends BaseAPI implements ChannelPartnerApiInter
|
|
|
48752
48955
|
return ChannelPartnerApiFp(this.configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(this.fetch, this.basePath);
|
|
48753
48956
|
}
|
|
48754
48957
|
|
|
48958
|
+
/**
|
|
48959
|
+
* Retrieve reject and refund reason codes.
|
|
48960
|
+
* @summary Retrieve reject and refund reason codes.
|
|
48961
|
+
* @param {number} channel_partner_oid
|
|
48962
|
+
* @param {*} [options] Override http request option.
|
|
48963
|
+
* @throws {RequiredError}
|
|
48964
|
+
* @memberof ChannelPartnerApi
|
|
48965
|
+
*/
|
|
48966
|
+
public getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any) {
|
|
48967
|
+
return ChannelPartnerApiFp(this.configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(this.fetch, this.basePath);
|
|
48968
|
+
}
|
|
48969
|
+
|
|
48755
48970
|
/**
|
|
48756
48971
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
48757
48972
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
package/dist/api.d.ts
CHANGED
|
@@ -5214,6 +5214,79 @@ export interface CartValidationResponse {
|
|
|
5214
5214
|
*/
|
|
5215
5215
|
errors?: Array<string>;
|
|
5216
5216
|
}
|
|
5217
|
+
/**
|
|
5218
|
+
*
|
|
5219
|
+
* @export
|
|
5220
|
+
* @interface ChanelPartnerReasonCodesResponse
|
|
5221
|
+
*/
|
|
5222
|
+
export interface ChanelPartnerReasonCodesResponse {
|
|
5223
|
+
/**
|
|
5224
|
+
*
|
|
5225
|
+
* @type {ModelError}
|
|
5226
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5227
|
+
*/
|
|
5228
|
+
error?: ModelError;
|
|
5229
|
+
/**
|
|
5230
|
+
* True if the item level refund reason is required
|
|
5231
|
+
* @type {boolean}
|
|
5232
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5233
|
+
*/
|
|
5234
|
+
item_level_refund_reason_required?: boolean;
|
|
5235
|
+
/**
|
|
5236
|
+
* Reason codes available at the item level.
|
|
5237
|
+
* @type {Array<OrderReason>}
|
|
5238
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5239
|
+
*/
|
|
5240
|
+
item_level_refund_reasons?: Array<OrderReason>;
|
|
5241
|
+
/**
|
|
5242
|
+
* Return codes available at the item level.
|
|
5243
|
+
* @type {Array<OrderReason>}
|
|
5244
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5245
|
+
*/
|
|
5246
|
+
item_level_return_reasons?: Array<OrderReason>;
|
|
5247
|
+
/**
|
|
5248
|
+
*
|
|
5249
|
+
* @type {ResponseMetadata}
|
|
5250
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5251
|
+
*/
|
|
5252
|
+
metadata?: ResponseMetadata;
|
|
5253
|
+
/**
|
|
5254
|
+
* True if the order level refund reason is required
|
|
5255
|
+
* @type {boolean}
|
|
5256
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5257
|
+
*/
|
|
5258
|
+
order_level_refund_reason_required?: boolean;
|
|
5259
|
+
/**
|
|
5260
|
+
* Reason codes available at the order level.
|
|
5261
|
+
* @type {Array<OrderReason>}
|
|
5262
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5263
|
+
*/
|
|
5264
|
+
order_level_refund_reasons?: Array<OrderReason>;
|
|
5265
|
+
/**
|
|
5266
|
+
* True if the order level reject reason is required
|
|
5267
|
+
* @type {boolean}
|
|
5268
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5269
|
+
*/
|
|
5270
|
+
order_level_reject_reason_required?: boolean;
|
|
5271
|
+
/**
|
|
5272
|
+
* Reject codes available at the order level.
|
|
5273
|
+
* @type {Array<OrderReason>}
|
|
5274
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5275
|
+
*/
|
|
5276
|
+
order_level_reject_reasons?: Array<OrderReason>;
|
|
5277
|
+
/**
|
|
5278
|
+
* Indicates if API call was successful
|
|
5279
|
+
* @type {boolean}
|
|
5280
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5281
|
+
*/
|
|
5282
|
+
success?: boolean;
|
|
5283
|
+
/**
|
|
5284
|
+
*
|
|
5285
|
+
* @type {Warning}
|
|
5286
|
+
* @memberof ChanelPartnerReasonCodesResponse
|
|
5287
|
+
*/
|
|
5288
|
+
warning?: Warning;
|
|
5289
|
+
}
|
|
5217
5290
|
/**
|
|
5218
5291
|
*
|
|
5219
5292
|
* @export
|
|
@@ -7066,6 +7139,30 @@ export interface ConversationAgentAuthResponse {
|
|
|
7066
7139
|
* @interface ConversationAgentProfile
|
|
7067
7140
|
*/
|
|
7068
7141
|
export interface ConversationAgentProfile {
|
|
7142
|
+
/**
|
|
7143
|
+
* AI powered chat bot
|
|
7144
|
+
* @type {boolean}
|
|
7145
|
+
* @memberof ConversationAgentProfile
|
|
7146
|
+
*/
|
|
7147
|
+
ai?: boolean;
|
|
7148
|
+
/**
|
|
7149
|
+
* Additional instructions for this AI when handle web chats
|
|
7150
|
+
* @type {string}
|
|
7151
|
+
* @memberof ConversationAgentProfile
|
|
7152
|
+
*/
|
|
7153
|
+
ai_chat_instructions?: string;
|
|
7154
|
+
/**
|
|
7155
|
+
* Persona of this AI agent
|
|
7156
|
+
* @type {string}
|
|
7157
|
+
* @memberof ConversationAgentProfile
|
|
7158
|
+
*/
|
|
7159
|
+
ai_persona?: string;
|
|
7160
|
+
/**
|
|
7161
|
+
* Additional instructions for this AI when handle SMS messages
|
|
7162
|
+
* @type {string}
|
|
7163
|
+
* @memberof ConversationAgentProfile
|
|
7164
|
+
*/
|
|
7165
|
+
ai_sms_instructions?: string;
|
|
7069
7166
|
/**
|
|
7070
7167
|
* The number of engagement chats that can be pushed on them at any given time.
|
|
7071
7168
|
* @type {number}
|
|
@@ -34240,6 +34337,18 @@ export interface OrderProcessPaymentResponse {
|
|
|
34240
34337
|
* @interface OrderProperty
|
|
34241
34338
|
*/
|
|
34242
34339
|
export interface OrderProperty {
|
|
34340
|
+
/**
|
|
34341
|
+
* Created by user
|
|
34342
|
+
* @type {string}
|
|
34343
|
+
* @memberof OrderProperty
|
|
34344
|
+
*/
|
|
34345
|
+
created_by?: string;
|
|
34346
|
+
/**
|
|
34347
|
+
* The date/time that the property was created by the user
|
|
34348
|
+
* @type {string}
|
|
34349
|
+
* @memberof OrderProperty
|
|
34350
|
+
*/
|
|
34351
|
+
created_dts?: string;
|
|
34243
34352
|
/**
|
|
34244
34353
|
* True if this property is displayed to the customer
|
|
34245
34354
|
* @type {boolean}
|
|
@@ -45231,6 +45340,14 @@ export declare const ChannelPartnerApiFetchParamCreator: (configuration?: Config
|
|
|
45231
45340
|
* @throws {RequiredError}
|
|
45232
45341
|
*/
|
|
45233
45342
|
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): FetchArgs;
|
|
45343
|
+
/**
|
|
45344
|
+
* Retrieve reject and refund reason codes.
|
|
45345
|
+
* @summary Retrieve reject and refund reason codes.
|
|
45346
|
+
* @param {number} channel_partner_oid
|
|
45347
|
+
* @param {*} [options] Override http request option.
|
|
45348
|
+
* @throws {RequiredError}
|
|
45349
|
+
*/
|
|
45350
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): FetchArgs;
|
|
45234
45351
|
/**
|
|
45235
45352
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
45236
45353
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -45364,6 +45481,14 @@ export declare const ChannelPartnerApiFp: (configuration?: Configuration) => {
|
|
|
45364
45481
|
* @throws {RequiredError}
|
|
45365
45482
|
*/
|
|
45366
45483
|
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<OrderResponse>;
|
|
45484
|
+
/**
|
|
45485
|
+
* Retrieve reject and refund reason codes.
|
|
45486
|
+
* @summary Retrieve reject and refund reason codes.
|
|
45487
|
+
* @param {number} channel_partner_oid
|
|
45488
|
+
* @param {*} [options] Override http request option.
|
|
45489
|
+
* @throws {RequiredError}
|
|
45490
|
+
*/
|
|
45491
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ChanelPartnerReasonCodesResponse>;
|
|
45367
45492
|
/**
|
|
45368
45493
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
45369
45494
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -45497,6 +45622,14 @@ export declare const ChannelPartnerApiFactory: (configuration?: Configuration, f
|
|
|
45497
45622
|
* @throws {RequiredError}
|
|
45498
45623
|
*/
|
|
45499
45624
|
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
45625
|
+
/**
|
|
45626
|
+
* Retrieve reject and refund reason codes.
|
|
45627
|
+
* @summary Retrieve reject and refund reason codes.
|
|
45628
|
+
* @param {number} channel_partner_oid
|
|
45629
|
+
* @param {*} [options] Override http request option.
|
|
45630
|
+
* @throws {RequiredError}
|
|
45631
|
+
*/
|
|
45632
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): Promise<ChanelPartnerReasonCodesResponse>;
|
|
45500
45633
|
/**
|
|
45501
45634
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
45502
45635
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -45638,6 +45771,15 @@ export interface ChannelPartnerApiInterface {
|
|
|
45638
45771
|
* @memberof ChannelPartnerApiInterface
|
|
45639
45772
|
*/
|
|
45640
45773
|
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
45774
|
+
/**
|
|
45775
|
+
* Retrieve reject and refund reason codes.
|
|
45776
|
+
* @summary Retrieve reject and refund reason codes.
|
|
45777
|
+
* @param {number} channel_partner_oid
|
|
45778
|
+
* @param {*} [options] Override http request option.
|
|
45779
|
+
* @throws {RequiredError}
|
|
45780
|
+
* @memberof ChannelPartnerApiInterface
|
|
45781
|
+
*/
|
|
45782
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): Promise<ChanelPartnerReasonCodesResponse>;
|
|
45641
45783
|
/**
|
|
45642
45784
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
45643
45785
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -45787,6 +45929,15 @@ export declare class ChannelPartnerApi extends BaseAPI implements ChannelPartner
|
|
|
45787
45929
|
* @memberof ChannelPartnerApi
|
|
45788
45930
|
*/
|
|
45789
45931
|
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
45932
|
+
/**
|
|
45933
|
+
* Retrieve reject and refund reason codes.
|
|
45934
|
+
* @summary Retrieve reject and refund reason codes.
|
|
45935
|
+
* @param {number} channel_partner_oid
|
|
45936
|
+
* @param {*} [options] Override http request option.
|
|
45937
|
+
* @throws {RequiredError}
|
|
45938
|
+
* @memberof ChannelPartnerApi
|
|
45939
|
+
*/
|
|
45940
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): Promise<ChanelPartnerReasonCodesResponse>;
|
|
45790
45941
|
/**
|
|
45791
45942
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
45792
45943
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
package/dist/api.js
CHANGED
|
@@ -3846,6 +3846,52 @@ var ChannelPartnerApiFetchParamCreator = function (configuration) {
|
|
|
3846
3846
|
options: localVarRequestOptions,
|
|
3847
3847
|
};
|
|
3848
3848
|
},
|
|
3849
|
+
/**
|
|
3850
|
+
* Retrieve reject and refund reason codes.
|
|
3851
|
+
* @summary Retrieve reject and refund reason codes.
|
|
3852
|
+
* @param {number} channel_partner_oid
|
|
3853
|
+
* @param {*} [options] Override http request option.
|
|
3854
|
+
* @throws {RequiredError}
|
|
3855
|
+
*/
|
|
3856
|
+
getChannelPartnerReasonCodes: function (channel_partner_oid, options) {
|
|
3857
|
+
if (options === void 0) { options = {}; }
|
|
3858
|
+
// verify required parameter 'channel_partner_oid' is not null or undefined
|
|
3859
|
+
if (channel_partner_oid === null || channel_partner_oid === undefined) {
|
|
3860
|
+
throw new RequiredError('channel_partner_oid', 'Required parameter channel_partner_oid was null or undefined when calling getChannelPartnerReasonCodes.');
|
|
3861
|
+
}
|
|
3862
|
+
var localVarPath = "/channel_partner/channel_partners/{channel_partner_oid}/reason_codes"
|
|
3863
|
+
.replace("{".concat("channel_partner_oid", "}"), encodeURIComponent(String(channel_partner_oid)));
|
|
3864
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
3865
|
+
var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
3866
|
+
var localVarHeaderParameter = {};
|
|
3867
|
+
var localVarQueryParameter = {};
|
|
3868
|
+
if (configuration && configuration.apiVersion) {
|
|
3869
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
3870
|
+
}
|
|
3871
|
+
// authentication ultraCartOauth required
|
|
3872
|
+
// oauth required
|
|
3873
|
+
if (configuration && configuration.accessToken) {
|
|
3874
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
3875
|
+
? configuration.accessToken("ultraCartOauth", ["channel_partner_read"])
|
|
3876
|
+
: configuration.accessToken;
|
|
3877
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
3878
|
+
}
|
|
3879
|
+
// authentication ultraCartSimpleApiKey required
|
|
3880
|
+
if (configuration && configuration.apiKey) {
|
|
3881
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
3882
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
3883
|
+
: configuration.apiKey;
|
|
3884
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
3885
|
+
}
|
|
3886
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
3887
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
3888
|
+
delete localVarUrlObj.search;
|
|
3889
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
3890
|
+
return {
|
|
3891
|
+
url: url.format(localVarUrlObj),
|
|
3892
|
+
options: localVarRequestOptions,
|
|
3893
|
+
};
|
|
3894
|
+
},
|
|
3849
3895
|
/**
|
|
3850
3896
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
3851
3897
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -4398,6 +4444,28 @@ var ChannelPartnerApiFp = function (configuration) {
|
|
|
4398
4444
|
});
|
|
4399
4445
|
};
|
|
4400
4446
|
},
|
|
4447
|
+
/**
|
|
4448
|
+
* Retrieve reject and refund reason codes.
|
|
4449
|
+
* @summary Retrieve reject and refund reason codes.
|
|
4450
|
+
* @param {number} channel_partner_oid
|
|
4451
|
+
* @param {*} [options] Override http request option.
|
|
4452
|
+
* @throws {RequiredError}
|
|
4453
|
+
*/
|
|
4454
|
+
getChannelPartnerReasonCodes: function (channel_partner_oid, options) {
|
|
4455
|
+
var localVarFetchArgs = (0, exports.ChannelPartnerApiFetchParamCreator)(configuration).getChannelPartnerReasonCodes(channel_partner_oid, options);
|
|
4456
|
+
return function (fetch, basePath) {
|
|
4457
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
4458
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
4459
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
4460
|
+
if (response.status >= 200 && response.status < 300) {
|
|
4461
|
+
return response.json();
|
|
4462
|
+
}
|
|
4463
|
+
else {
|
|
4464
|
+
throw response;
|
|
4465
|
+
}
|
|
4466
|
+
});
|
|
4467
|
+
};
|
|
4468
|
+
},
|
|
4401
4469
|
/**
|
|
4402
4470
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
4403
4471
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -4646,6 +4714,16 @@ var ChannelPartnerApiFactory = function (configuration, fetch, basePath) {
|
|
|
4646
4714
|
getChannelPartnerOrderByChannelPartnerOrderId: function (order_id, _expand, options) {
|
|
4647
4715
|
return (0, exports.ChannelPartnerApiFp)(configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(fetch, basePath);
|
|
4648
4716
|
},
|
|
4717
|
+
/**
|
|
4718
|
+
* Retrieve reject and refund reason codes.
|
|
4719
|
+
* @summary Retrieve reject and refund reason codes.
|
|
4720
|
+
* @param {number} channel_partner_oid
|
|
4721
|
+
* @param {*} [options] Override http request option.
|
|
4722
|
+
* @throws {RequiredError}
|
|
4723
|
+
*/
|
|
4724
|
+
getChannelPartnerReasonCodes: function (channel_partner_oid, options) {
|
|
4725
|
+
return (0, exports.ChannelPartnerApiFp)(configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(fetch, basePath);
|
|
4726
|
+
},
|
|
4649
4727
|
/**
|
|
4650
4728
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
4651
4729
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -4822,6 +4900,17 @@ var ChannelPartnerApi = /** @class */ (function (_super) {
|
|
|
4822
4900
|
ChannelPartnerApi.prototype.getChannelPartnerOrderByChannelPartnerOrderId = function (order_id, _expand, options) {
|
|
4823
4901
|
return (0, exports.ChannelPartnerApiFp)(this.configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(this.fetch, this.basePath);
|
|
4824
4902
|
};
|
|
4903
|
+
/**
|
|
4904
|
+
* Retrieve reject and refund reason codes.
|
|
4905
|
+
* @summary Retrieve reject and refund reason codes.
|
|
4906
|
+
* @param {number} channel_partner_oid
|
|
4907
|
+
* @param {*} [options] Override http request option.
|
|
4908
|
+
* @throws {RequiredError}
|
|
4909
|
+
* @memberof ChannelPartnerApi
|
|
4910
|
+
*/
|
|
4911
|
+
ChannelPartnerApi.prototype.getChannelPartnerReasonCodes = function (channel_partner_oid, options) {
|
|
4912
|
+
return (0, exports.ChannelPartnerApiFp)(this.configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(this.fetch, this.basePath);
|
|
4913
|
+
};
|
|
4825
4914
|
/**
|
|
4826
4915
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
4827
4916
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|