ultracart_rest_api_v2_typescript 3.11.7 → 3.11.9
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 +404 -8
- package/dist/api.d.ts +246 -5
- package/dist/api.js +232 -7
- 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.9
|
|
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.9 --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.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |
|
|
58
|
+
| 3.11.8 | 04/22/2025 | order property fields for created_by and created_dts |
|
|
57
59
|
| 3.11.7 | 04/21/2025 | conversation agent additional fields |
|
|
58
60
|
| 3.11.6 | 04/16/2025 | added channel partner order item properties |
|
|
59
61
|
| 3.11.5 | 03/28/2025 | added paypal fastlane constants for payments |
|
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
|
|
@@ -7351,6 +7425,44 @@ export interface ConversationAgentProfileResponse {
|
|
|
7351
7425
|
warning?: Warning;
|
|
7352
7426
|
}
|
|
7353
7427
|
|
|
7428
|
+
/**
|
|
7429
|
+
*
|
|
7430
|
+
* @export
|
|
7431
|
+
* @interface ConversationAgentProfilesResponse
|
|
7432
|
+
*/
|
|
7433
|
+
export interface ConversationAgentProfilesResponse {
|
|
7434
|
+
/**
|
|
7435
|
+
*
|
|
7436
|
+
* @type {Array<ConversationAgentProfile>}
|
|
7437
|
+
* @memberof ConversationAgentProfilesResponse
|
|
7438
|
+
*/
|
|
7439
|
+
agent_profiles?: Array<ConversationAgentProfile>;
|
|
7440
|
+
/**
|
|
7441
|
+
*
|
|
7442
|
+
* @type {ModelError}
|
|
7443
|
+
* @memberof ConversationAgentProfilesResponse
|
|
7444
|
+
*/
|
|
7445
|
+
error?: ModelError;
|
|
7446
|
+
/**
|
|
7447
|
+
*
|
|
7448
|
+
* @type {ResponseMetadata}
|
|
7449
|
+
* @memberof ConversationAgentProfilesResponse
|
|
7450
|
+
*/
|
|
7451
|
+
metadata?: ResponseMetadata;
|
|
7452
|
+
/**
|
|
7453
|
+
* Indicates if API call was successful
|
|
7454
|
+
* @type {boolean}
|
|
7455
|
+
* @memberof ConversationAgentProfilesResponse
|
|
7456
|
+
*/
|
|
7457
|
+
success?: boolean;
|
|
7458
|
+
/**
|
|
7459
|
+
*
|
|
7460
|
+
* @type {Warning}
|
|
7461
|
+
* @memberof ConversationAgentProfilesResponse
|
|
7462
|
+
*/
|
|
7463
|
+
warning?: Warning;
|
|
7464
|
+
}
|
|
7465
|
+
|
|
7354
7466
|
/**
|
|
7355
7467
|
*
|
|
7356
7468
|
* @export
|
|
@@ -35001,6 +35113,18 @@ export interface OrderProcessPaymentResponse {
|
|
|
35001
35113
|
* @interface OrderProperty
|
|
35002
35114
|
*/
|
|
35003
35115
|
export interface OrderProperty {
|
|
35116
|
+
/**
|
|
35117
|
+
* Created by user
|
|
35118
|
+
* @type {string}
|
|
35119
|
+
* @memberof OrderProperty
|
|
35120
|
+
*/
|
|
35121
|
+
created_by?: string;
|
|
35122
|
+
/**
|
|
35123
|
+
* The date/time that the property was created by the user
|
|
35124
|
+
* @type {string}
|
|
35125
|
+
* @memberof OrderProperty
|
|
35126
|
+
*/
|
|
35127
|
+
created_dts?: string;
|
|
35004
35128
|
/**
|
|
35005
35129
|
* True if this property is displayed to the customer
|
|
35006
35130
|
* @type {boolean}
|
|
@@ -47594,6 +47718,58 @@ export const ChannelPartnerApiFetchParamCreator = function (configuration?: Conf
|
|
|
47594
47718
|
options: localVarRequestOptions,
|
|
47595
47719
|
};
|
|
47596
47720
|
},
|
|
47721
|
+
/**
|
|
47722
|
+
* Retrieve reject and refund reason codes.
|
|
47723
|
+
* @summary Retrieve reject and refund reason codes.
|
|
47724
|
+
* @param {number} channel_partner_oid
|
|
47725
|
+
* @param {*} [options] Override http request option.
|
|
47726
|
+
* @throws {RequiredError}
|
|
47727
|
+
*/
|
|
47728
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options: any = {}): FetchArgs {
|
|
47729
|
+
// verify required parameter 'channel_partner_oid' is not null or undefined
|
|
47730
|
+
if (channel_partner_oid === null || channel_partner_oid === undefined) {
|
|
47731
|
+
throw new RequiredError('channel_partner_oid','Required parameter channel_partner_oid was null or undefined when calling getChannelPartnerReasonCodes.');
|
|
47732
|
+
}
|
|
47733
|
+
const localVarPath = `/channel_partner/channel_partners/{channel_partner_oid}/reason_codes`
|
|
47734
|
+
.replace(`{${"channel_partner_oid"}}`, encodeURIComponent(String(channel_partner_oid)));
|
|
47735
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
47736
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
47737
|
+
const localVarHeaderParameter = {} as any;
|
|
47738
|
+
const localVarQueryParameter = {} as any;
|
|
47739
|
+
|
|
47740
|
+
if(configuration && configuration.apiVersion) {
|
|
47741
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
47742
|
+
}
|
|
47743
|
+
|
|
47744
|
+
|
|
47745
|
+
|
|
47746
|
+
// authentication ultraCartOauth required
|
|
47747
|
+
// oauth required
|
|
47748
|
+
if (configuration && configuration.accessToken) {
|
|
47749
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
47750
|
+
? configuration.accessToken("ultraCartOauth", ["channel_partner_read"])
|
|
47751
|
+
: configuration.accessToken;
|
|
47752
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
47753
|
+
}
|
|
47754
|
+
|
|
47755
|
+
// authentication ultraCartSimpleApiKey required
|
|
47756
|
+
if (configuration && configuration.apiKey) {
|
|
47757
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
47758
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
47759
|
+
: configuration.apiKey;
|
|
47760
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
47761
|
+
}
|
|
47762
|
+
|
|
47763
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
47764
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
47765
|
+
delete localVarUrlObj.search;
|
|
47766
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
47767
|
+
|
|
47768
|
+
return {
|
|
47769
|
+
url: url.format(localVarUrlObj),
|
|
47770
|
+
options: localVarRequestOptions,
|
|
47771
|
+
};
|
|
47772
|
+
},
|
|
47597
47773
|
/**
|
|
47598
47774
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
47599
47775
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -48193,6 +48369,27 @@ export const ChannelPartnerApiFp = function(configuration?: Configuration) {
|
|
|
48193
48369
|
});
|
|
48194
48370
|
};
|
|
48195
48371
|
},
|
|
48372
|
+
/**
|
|
48373
|
+
* Retrieve reject and refund reason codes.
|
|
48374
|
+
* @summary Retrieve reject and refund reason codes.
|
|
48375
|
+
* @param {number} channel_partner_oid
|
|
48376
|
+
* @param {*} [options] Override http request option.
|
|
48377
|
+
* @throws {RequiredError}
|
|
48378
|
+
*/
|
|
48379
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ChanelPartnerReasonCodesResponse> {
|
|
48380
|
+
const localVarFetchArgs = ChannelPartnerApiFetchParamCreator(configuration).getChannelPartnerReasonCodes(channel_partner_oid, options);
|
|
48381
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
48382
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
48383
|
+
|
|
48384
|
+
if (response.status >= 200 && response.status < 300) {
|
|
48385
|
+
return response.json();
|
|
48386
|
+
|
|
48387
|
+
} else {
|
|
48388
|
+
throw response;
|
|
48389
|
+
}
|
|
48390
|
+
});
|
|
48391
|
+
};
|
|
48392
|
+
},
|
|
48196
48393
|
/**
|
|
48197
48394
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
48198
48395
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -48434,6 +48631,16 @@ export const ChannelPartnerApiFactory = function (configuration?: Configuration,
|
|
|
48434
48631
|
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any) {
|
|
48435
48632
|
return ChannelPartnerApiFp(configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(fetch, basePath);
|
|
48436
48633
|
},
|
|
48634
|
+
/**
|
|
48635
|
+
* Retrieve reject and refund reason codes.
|
|
48636
|
+
* @summary Retrieve reject and refund reason codes.
|
|
48637
|
+
* @param {number} channel_partner_oid
|
|
48638
|
+
* @param {*} [options] Override http request option.
|
|
48639
|
+
* @throws {RequiredError}
|
|
48640
|
+
*/
|
|
48641
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any) {
|
|
48642
|
+
return ChannelPartnerApiFp(configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(fetch, basePath);
|
|
48643
|
+
},
|
|
48437
48644
|
/**
|
|
48438
48645
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
48439
48646
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -48598,6 +48805,16 @@ export interface ChannelPartnerApiInterface {
|
|
|
48598
48805
|
*/
|
|
48599
48806
|
getChannelPartnerOrderByChannelPartnerOrderId(order_id: string, _expand?: string, options?: any): Promise<OrderResponse>;
|
|
48600
48807
|
|
|
48808
|
+
/**
|
|
48809
|
+
* Retrieve reject and refund reason codes.
|
|
48810
|
+
* @summary Retrieve reject and refund reason codes.
|
|
48811
|
+
* @param {number} channel_partner_oid
|
|
48812
|
+
* @param {*} [options] Override http request option.
|
|
48813
|
+
* @throws {RequiredError}
|
|
48814
|
+
* @memberof ChannelPartnerApiInterface
|
|
48815
|
+
*/
|
|
48816
|
+
getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any): Promise<ChanelPartnerReasonCodesResponse>;
|
|
48817
|
+
|
|
48601
48818
|
/**
|
|
48602
48819
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
48603
48820
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -48776,6 +48993,18 @@ export class ChannelPartnerApi extends BaseAPI implements ChannelPartnerApiInter
|
|
|
48776
48993
|
return ChannelPartnerApiFp(this.configuration).getChannelPartnerOrderByChannelPartnerOrderId(order_id, _expand, options)(this.fetch, this.basePath);
|
|
48777
48994
|
}
|
|
48778
48995
|
|
|
48996
|
+
/**
|
|
48997
|
+
* Retrieve reject and refund reason codes.
|
|
48998
|
+
* @summary Retrieve reject and refund reason codes.
|
|
48999
|
+
* @param {number} channel_partner_oid
|
|
49000
|
+
* @param {*} [options] Override http request option.
|
|
49001
|
+
* @throws {RequiredError}
|
|
49002
|
+
* @memberof ChannelPartnerApi
|
|
49003
|
+
*/
|
|
49004
|
+
public getChannelPartnerReasonCodes(channel_partner_oid: number, options?: any) {
|
|
49005
|
+
return ChannelPartnerApiFp(this.configuration).getChannelPartnerReasonCodes(channel_partner_oid, options)(this.fetch, this.basePath);
|
|
49006
|
+
}
|
|
49007
|
+
|
|
48779
49008
|
/**
|
|
48780
49009
|
* Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
48781
49010
|
* @summary Retrieve the ship to preference associated with the channel partner and the specific id.
|
|
@@ -52550,6 +52779,52 @@ export const ConversationApiFetchParamCreator = function (configuration?: Config
|
|
|
52550
52779
|
|
|
52551
52780
|
|
|
52552
52781
|
|
|
52782
|
+
// authentication ultraCartOauth required
|
|
52783
|
+
// oauth required
|
|
52784
|
+
if (configuration && configuration.accessToken) {
|
|
52785
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
52786
|
+
? configuration.accessToken("ultraCartOauth", ["conversation_read"])
|
|
52787
|
+
: configuration.accessToken;
|
|
52788
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
52789
|
+
}
|
|
52790
|
+
|
|
52791
|
+
// authentication ultraCartSimpleApiKey required
|
|
52792
|
+
if (configuration && configuration.apiKey) {
|
|
52793
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
52794
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
52795
|
+
: configuration.apiKey;
|
|
52796
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
52797
|
+
}
|
|
52798
|
+
|
|
52799
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
52800
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
52801
|
+
delete localVarUrlObj.search;
|
|
52802
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
52803
|
+
|
|
52804
|
+
return {
|
|
52805
|
+
url: url.format(localVarUrlObj),
|
|
52806
|
+
options: localVarRequestOptions,
|
|
52807
|
+
};
|
|
52808
|
+
},
|
|
52809
|
+
/**
|
|
52810
|
+
* Retrieve the agents profile
|
|
52811
|
+
* @summary Get agent profiles
|
|
52812
|
+
* @param {*} [options] Override http request option.
|
|
52813
|
+
* @throws {RequiredError}
|
|
52814
|
+
*/
|
|
52815
|
+
getAgentProfiles(options: any = {}): FetchArgs {
|
|
52816
|
+
const localVarPath = `/conversation/agent/profiles`;
|
|
52817
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
52818
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
52819
|
+
const localVarHeaderParameter = {} as any;
|
|
52820
|
+
const localVarQueryParameter = {} as any;
|
|
52821
|
+
|
|
52822
|
+
if(configuration && configuration.apiVersion) {
|
|
52823
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
52824
|
+
}
|
|
52825
|
+
|
|
52826
|
+
|
|
52827
|
+
|
|
52553
52828
|
// authentication ultraCartOauth required
|
|
52554
52829
|
// oauth required
|
|
52555
52830
|
if (configuration && configuration.accessToken) {
|
|
@@ -56596,6 +56871,26 @@ export const ConversationApiFp = function(configuration?: Configuration) {
|
|
|
56596
56871
|
});
|
|
56597
56872
|
};
|
|
56598
56873
|
},
|
|
56874
|
+
/**
|
|
56875
|
+
* Retrieve the agents profile
|
|
56876
|
+
* @summary Get agent profiles
|
|
56877
|
+
* @param {*} [options] Override http request option.
|
|
56878
|
+
* @throws {RequiredError}
|
|
56879
|
+
*/
|
|
56880
|
+
getAgentProfiles(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<ConversationAgentProfilesResponse> {
|
|
56881
|
+
const localVarFetchArgs = ConversationApiFetchParamCreator(configuration).getAgentProfiles(options);
|
|
56882
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
56883
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
56884
|
+
|
|
56885
|
+
if (response.status >= 200 && response.status < 300) {
|
|
56886
|
+
return response.json();
|
|
56887
|
+
|
|
56888
|
+
} else {
|
|
56889
|
+
throw response;
|
|
56890
|
+
}
|
|
56891
|
+
});
|
|
56892
|
+
};
|
|
56893
|
+
},
|
|
56599
56894
|
/**
|
|
56600
56895
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
56601
56896
|
* @summary Get agent websocket authorization
|
|
@@ -58208,6 +58503,15 @@ export const ConversationApiFactory = function (configuration?: Configuration, f
|
|
|
58208
58503
|
getAgentProfile(options?: any) {
|
|
58209
58504
|
return ConversationApiFp(configuration).getAgentProfile(options)(fetch, basePath);
|
|
58210
58505
|
},
|
|
58506
|
+
/**
|
|
58507
|
+
* Retrieve the agents profile
|
|
58508
|
+
* @summary Get agent profiles
|
|
58509
|
+
* @param {*} [options] Override http request option.
|
|
58510
|
+
* @throws {RequiredError}
|
|
58511
|
+
*/
|
|
58512
|
+
getAgentProfiles(options?: any) {
|
|
58513
|
+
return ConversationApiFp(configuration).getAgentProfiles(options)(fetch, basePath);
|
|
58514
|
+
},
|
|
58211
58515
|
/**
|
|
58212
58516
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
58213
58517
|
* @summary Get agent websocket authorization
|
|
@@ -59050,6 +59354,15 @@ export interface ConversationApiInterface {
|
|
|
59050
59354
|
*/
|
|
59051
59355
|
getAgentProfile(options?: any): Promise<ConversationAgentProfileResponse>;
|
|
59052
59356
|
|
|
59357
|
+
/**
|
|
59358
|
+
* Retrieve the agents profile
|
|
59359
|
+
* @summary Get agent profiles
|
|
59360
|
+
* @param {*} [options] Override http request option.
|
|
59361
|
+
* @throws {RequiredError}
|
|
59362
|
+
* @memberof ConversationApiInterface
|
|
59363
|
+
*/
|
|
59364
|
+
getAgentProfiles(options?: any): Promise<ConversationAgentProfilesResponse>;
|
|
59365
|
+
|
|
59053
59366
|
/**
|
|
59054
59367
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
59055
59368
|
* @summary Get agent websocket authorization
|
|
@@ -59918,6 +60231,17 @@ export class ConversationApi extends BaseAPI implements ConversationApiInterface
|
|
|
59918
60231
|
return ConversationApiFp(this.configuration).getAgentProfile(options)(this.fetch, this.basePath);
|
|
59919
60232
|
}
|
|
59920
60233
|
|
|
60234
|
+
/**
|
|
60235
|
+
* Retrieve the agents profile
|
|
60236
|
+
* @summary Get agent profiles
|
|
60237
|
+
* @param {*} [options] Override http request option.
|
|
60238
|
+
* @throws {RequiredError}
|
|
60239
|
+
* @memberof ConversationApi
|
|
60240
|
+
*/
|
|
60241
|
+
public getAgentProfiles(options?: any) {
|
|
60242
|
+
return ConversationApiFp(this.configuration).getAgentProfiles(options)(this.fetch, this.basePath);
|
|
60243
|
+
}
|
|
60244
|
+
|
|
59921
60245
|
/**
|
|
59922
60246
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
59923
60247
|
* @summary Get agent websocket authorization
|
|
@@ -103488,13 +103812,21 @@ export const WebhookApiFetchParamCreator = function (configuration?: Configurati
|
|
|
103488
103812
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
103489
103813
|
* @summary Retrieve the log summaries
|
|
103490
103814
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
103815
|
+
* @param {string} [requestId]
|
|
103816
|
+
* @param {string} [beginDate]
|
|
103817
|
+
* @param {string} [endDate]
|
|
103818
|
+
* @param {string} [status]
|
|
103819
|
+
* @param {string} [event]
|
|
103820
|
+
* @param {string} [orderId]
|
|
103821
|
+
* @param {string} [request]
|
|
103822
|
+
* @param {number} [duration]
|
|
103491
103823
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
103492
103824
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
103493
103825
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
103494
103826
|
* @param {*} [options] Override http request option.
|
|
103495
103827
|
* @throws {RequiredError}
|
|
103496
103828
|
*/
|
|
103497
|
-
getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options: any = {}): FetchArgs {
|
|
103829
|
+
getWebhookLogSummaries(webhookOid: number, requestId?: string, beginDate?: string, endDate?: string, status?: string, event?: string, orderId?: string, request?: string, duration?: number, _limit?: number, _offset?: number, _since?: string, options: any = {}): FetchArgs {
|
|
103498
103830
|
// verify required parameter 'webhookOid' is not null or undefined
|
|
103499
103831
|
if (webhookOid === null || webhookOid === undefined) {
|
|
103500
103832
|
throw new RequiredError('webhookOid','Required parameter webhookOid was null or undefined when calling getWebhookLogSummaries.');
|
|
@@ -103529,6 +103861,38 @@ export const WebhookApiFetchParamCreator = function (configuration?: Configurati
|
|
|
103529
103861
|
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
103530
103862
|
}
|
|
103531
103863
|
|
|
103864
|
+
if (requestId !== undefined) {
|
|
103865
|
+
localVarQueryParameter['requestId'] = requestId;
|
|
103866
|
+
}
|
|
103867
|
+
|
|
103868
|
+
if (beginDate !== undefined) {
|
|
103869
|
+
localVarQueryParameter['beginDate'] = beginDate;
|
|
103870
|
+
}
|
|
103871
|
+
|
|
103872
|
+
if (endDate !== undefined) {
|
|
103873
|
+
localVarQueryParameter['endDate'] = endDate;
|
|
103874
|
+
}
|
|
103875
|
+
|
|
103876
|
+
if (status !== undefined) {
|
|
103877
|
+
localVarQueryParameter['status'] = status;
|
|
103878
|
+
}
|
|
103879
|
+
|
|
103880
|
+
if (event !== undefined) {
|
|
103881
|
+
localVarQueryParameter['event'] = event;
|
|
103882
|
+
}
|
|
103883
|
+
|
|
103884
|
+
if (orderId !== undefined) {
|
|
103885
|
+
localVarQueryParameter['orderId'] = orderId;
|
|
103886
|
+
}
|
|
103887
|
+
|
|
103888
|
+
if (request !== undefined) {
|
|
103889
|
+
localVarQueryParameter['request'] = request;
|
|
103890
|
+
}
|
|
103891
|
+
|
|
103892
|
+
if (duration !== undefined) {
|
|
103893
|
+
localVarQueryParameter['duration'] = duration;
|
|
103894
|
+
}
|
|
103895
|
+
|
|
103532
103896
|
if (_limit !== undefined) {
|
|
103533
103897
|
localVarQueryParameter['_limit'] = _limit;
|
|
103534
103898
|
}
|
|
@@ -103878,14 +104242,22 @@ export const WebhookApiFp = function(configuration?: Configuration) {
|
|
|
103878
104242
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
103879
104243
|
* @summary Retrieve the log summaries
|
|
103880
104244
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
104245
|
+
* @param {string} [requestId]
|
|
104246
|
+
* @param {string} [beginDate]
|
|
104247
|
+
* @param {string} [endDate]
|
|
104248
|
+
* @param {string} [status]
|
|
104249
|
+
* @param {string} [event]
|
|
104250
|
+
* @param {string} [orderId]
|
|
104251
|
+
* @param {string} [request]
|
|
104252
|
+
* @param {number} [duration]
|
|
103881
104253
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
103882
104254
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
103883
104255
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
103884
104256
|
* @param {*} [options] Override http request option.
|
|
103885
104257
|
* @throws {RequiredError}
|
|
103886
104258
|
*/
|
|
103887
|
-
getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WebhookLogSummariesResponse> {
|
|
103888
|
-
const localVarFetchArgs = WebhookApiFetchParamCreator(configuration).getWebhookLogSummaries(webhookOid, _limit, _offset, _since, options);
|
|
104259
|
+
getWebhookLogSummaries(webhookOid: number, requestId?: string, beginDate?: string, endDate?: string, status?: string, event?: string, orderId?: string, request?: string, duration?: number, _limit?: number, _offset?: number, _since?: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<WebhookLogSummariesResponse> {
|
|
104260
|
+
const localVarFetchArgs = WebhookApiFetchParamCreator(configuration).getWebhookLogSummaries(webhookOid, requestId, beginDate, endDate, status, event, orderId, request, duration, _limit, _offset, _since, options);
|
|
103889
104261
|
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
103890
104262
|
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
103891
104263
|
|
|
@@ -104033,14 +104405,22 @@ export const WebhookApiFactory = function (configuration?: Configuration, fetch?
|
|
|
104033
104405
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
104034
104406
|
* @summary Retrieve the log summaries
|
|
104035
104407
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
104408
|
+
* @param {string} [requestId]
|
|
104409
|
+
* @param {string} [beginDate]
|
|
104410
|
+
* @param {string} [endDate]
|
|
104411
|
+
* @param {string} [status]
|
|
104412
|
+
* @param {string} [event]
|
|
104413
|
+
* @param {string} [orderId]
|
|
104414
|
+
* @param {string} [request]
|
|
104415
|
+
* @param {number} [duration]
|
|
104036
104416
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
104037
104417
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
104038
104418
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
104039
104419
|
* @param {*} [options] Override http request option.
|
|
104040
104420
|
* @throws {RequiredError}
|
|
104041
104421
|
*/
|
|
104042
|
-
getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options?: any) {
|
|
104043
|
-
return WebhookApiFp(configuration).getWebhookLogSummaries(webhookOid, _limit, _offset, _since, options)(fetch, basePath);
|
|
104422
|
+
getWebhookLogSummaries(webhookOid: number, requestId?: string, beginDate?: string, endDate?: string, status?: string, event?: string, orderId?: string, request?: string, duration?: number, _limit?: number, _offset?: number, _since?: string, options?: any) {
|
|
104423
|
+
return WebhookApiFp(configuration).getWebhookLogSummaries(webhookOid, requestId, beginDate, endDate, status, event, orderId, request, duration, _limit, _offset, _since, options)(fetch, basePath);
|
|
104044
104424
|
},
|
|
104045
104425
|
/**
|
|
104046
104426
|
* Retrieves the webhooks associated with this application.
|
|
@@ -104133,6 +104513,14 @@ export interface WebhookApiInterface {
|
|
|
104133
104513
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
104134
104514
|
* @summary Retrieve the log summaries
|
|
104135
104515
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
104516
|
+
* @param {string} [requestId]
|
|
104517
|
+
* @param {string} [beginDate]
|
|
104518
|
+
* @param {string} [endDate]
|
|
104519
|
+
* @param {string} [status]
|
|
104520
|
+
* @param {string} [event]
|
|
104521
|
+
* @param {string} [orderId]
|
|
104522
|
+
* @param {string} [request]
|
|
104523
|
+
* @param {number} [duration]
|
|
104136
104524
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
104137
104525
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
104138
104526
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
@@ -104140,7 +104528,7 @@ export interface WebhookApiInterface {
|
|
|
104140
104528
|
* @throws {RequiredError}
|
|
104141
104529
|
* @memberof WebhookApiInterface
|
|
104142
104530
|
*/
|
|
104143
|
-
getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options?: any): Promise<WebhookLogSummariesResponse>;
|
|
104531
|
+
getWebhookLogSummaries(webhookOid: number, requestId?: string, beginDate?: string, endDate?: string, status?: string, event?: string, orderId?: string, request?: string, duration?: number, _limit?: number, _offset?: number, _since?: string, options?: any): Promise<WebhookLogSummariesResponse>;
|
|
104144
104532
|
|
|
104145
104533
|
/**
|
|
104146
104534
|
* Retrieves the webhooks associated with this application.
|
|
@@ -104239,6 +104627,14 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
104239
104627
|
* Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
104240
104628
|
* @summary Retrieve the log summaries
|
|
104241
104629
|
* @param {number} webhookOid The webhook oid to retrieve log summaries for.
|
|
104630
|
+
* @param {string} [requestId]
|
|
104631
|
+
* @param {string} [beginDate]
|
|
104632
|
+
* @param {string} [endDate]
|
|
104633
|
+
* @param {string} [status]
|
|
104634
|
+
* @param {string} [event]
|
|
104635
|
+
* @param {string} [orderId]
|
|
104636
|
+
* @param {string} [request]
|
|
104637
|
+
* @param {number} [duration]
|
|
104242
104638
|
* @param {number} [_limit] The maximum number of records to return on this one API call.
|
|
104243
104639
|
* @param {number} [_offset] Pagination of the record set. Offset is a zero based index.
|
|
104244
104640
|
* @param {string} [_since] Fetch log summaries that have been delivered since this date/time.
|
|
@@ -104246,8 +104642,8 @@ export class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
104246
104642
|
* @throws {RequiredError}
|
|
104247
104643
|
* @memberof WebhookApi
|
|
104248
104644
|
*/
|
|
104249
|
-
public getWebhookLogSummaries(webhookOid: number, _limit?: number, _offset?: number, _since?: string, options?: any) {
|
|
104250
|
-
return WebhookApiFp(this.configuration).getWebhookLogSummaries(webhookOid, _limit, _offset, _since, options)(this.fetch, this.basePath);
|
|
104645
|
+
public getWebhookLogSummaries(webhookOid: number, requestId?: string, beginDate?: string, endDate?: string, status?: string, event?: string, orderId?: string, request?: string, duration?: number, _limit?: number, _offset?: number, _since?: string, options?: any) {
|
|
104646
|
+
return WebhookApiFp(this.configuration).getWebhookLogSummaries(webhookOid, requestId, beginDate, endDate, status, event, orderId, request, duration, _limit, _offset, _since, options)(this.fetch, this.basePath);
|
|
104251
104647
|
}
|
|
104252
104648
|
|
|
104253
104649
|
/**
|