ultracart_rest_api_v2_typescript 3.11.17 → 3.11.19
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 +235 -8
- package/dist/api.d.ts +160 -7
- package/dist/api.js +98 -2
- 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.19
|
|
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.19 --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.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
|
|
58
|
+
| 3.11.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
|
|
57
59
|
| 3.11.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
|
|
58
60
|
| 3.11.16 | 07/28/2025 | updated doc samples |
|
|
59
61
|
| 3.11.15 | 07/28/2025 | new order methods for blocking and unblocking refunds |
|
package/api.ts
CHANGED
|
@@ -11383,6 +11383,12 @@ export interface ConversationVirtualAgentCapabilities {
|
|
|
11383
11383
|
* @memberof ConversationVirtualAgentCapabilities
|
|
11384
11384
|
*/
|
|
11385
11385
|
open_support_ticket_channel_email?: string;
|
|
11386
|
+
/**
|
|
11387
|
+
* Department ID to open a Zoho Desk ticket for
|
|
11388
|
+
* @type {string}
|
|
11389
|
+
* @memberof ConversationVirtualAgentCapabilities
|
|
11390
|
+
*/
|
|
11391
|
+
open_support_ticket_zoho_desk_department_id?: string;
|
|
11386
11392
|
/**
|
|
11387
11393
|
*
|
|
11388
11394
|
* @type {boolean}
|
|
@@ -11407,6 +11413,18 @@ export interface ConversationVirtualAgentCapabilities {
|
|
|
11407
11413
|
* @memberof ConversationVirtualAgentCapabilities
|
|
11408
11414
|
*/
|
|
11409
11415
|
update_subscription_credit_card?: boolean;
|
|
11416
|
+
/**
|
|
11417
|
+
* True if Zoho Desk is connected to UltraCart
|
|
11418
|
+
* @type {boolean}
|
|
11419
|
+
* @memberof ConversationVirtualAgentCapabilities
|
|
11420
|
+
*/
|
|
11421
|
+
zoho_desk_available?: boolean;
|
|
11422
|
+
/**
|
|
11423
|
+
* Array of Zoho Desk Department if zoho desk is connected to UltraCart
|
|
11424
|
+
* @type {Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>}
|
|
11425
|
+
* @memberof ConversationVirtualAgentCapabilities
|
|
11426
|
+
*/
|
|
11427
|
+
zoho_desk_departments?: Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>;
|
|
11410
11428
|
}
|
|
11411
11429
|
|
|
11412
11430
|
/**
|
|
@@ -11421,8 +11439,8 @@ export namespace ConversationVirtualAgentCapabilities {
|
|
|
11421
11439
|
export enum OpenSupportTicketChannelEnum {
|
|
11422
11440
|
None = <any> 'none',
|
|
11423
11441
|
Email = <any> 'email',
|
|
11424
|
-
|
|
11425
|
-
ZohoDeskTicket = <any> '
|
|
11442
|
+
UltracartTask = <any> 'ultracart_task',
|
|
11443
|
+
ZohoDeskTicket = <any> 'zoho_desk_ticket'
|
|
11426
11444
|
}
|
|
11427
11445
|
}
|
|
11428
11446
|
|
|
@@ -11464,6 +11482,26 @@ export interface ConversationVirtualAgentCapabilitiesResponse {
|
|
|
11464
11482
|
warning?: Warning;
|
|
11465
11483
|
}
|
|
11466
11484
|
|
|
11485
|
+
/**
|
|
11486
|
+
*
|
|
11487
|
+
* @export
|
|
11488
|
+
* @interface ConversationVirtualAgentCapabilityZohoDeskDepartment
|
|
11489
|
+
*/
|
|
11490
|
+
export interface ConversationVirtualAgentCapabilityZohoDeskDepartment {
|
|
11491
|
+
/**
|
|
11492
|
+
*
|
|
11493
|
+
* @type {string}
|
|
11494
|
+
* @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
|
|
11495
|
+
*/
|
|
11496
|
+
department_id?: string;
|
|
11497
|
+
/**
|
|
11498
|
+
*
|
|
11499
|
+
* @type {string}
|
|
11500
|
+
* @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
|
|
11501
|
+
*/
|
|
11502
|
+
department_name?: string;
|
|
11503
|
+
}
|
|
11504
|
+
|
|
11467
11505
|
/**
|
|
11468
11506
|
*
|
|
11469
11507
|
* @export
|
|
@@ -14625,6 +14663,44 @@ export interface CustomDashboard {
|
|
|
14625
14663
|
* @memberof CustomDashboard
|
|
14626
14664
|
*/
|
|
14627
14665
|
pages?: Array<CustomDashboardPage>;
|
|
14666
|
+
/**
|
|
14667
|
+
*
|
|
14668
|
+
* @type {Array<CustomDashboardExecutionParameter>}
|
|
14669
|
+
* @memberof CustomDashboard
|
|
14670
|
+
*/
|
|
14671
|
+
parameters?: Array<CustomDashboardExecutionParameter>;
|
|
14672
|
+
}
|
|
14673
|
+
|
|
14674
|
+
/**
|
|
14675
|
+
*
|
|
14676
|
+
* @export
|
|
14677
|
+
* @interface CustomDashboardExecutionParameter
|
|
14678
|
+
*/
|
|
14679
|
+
export interface CustomDashboardExecutionParameter {
|
|
14680
|
+
/**
|
|
14681
|
+
*
|
|
14682
|
+
* @type {string}
|
|
14683
|
+
* @memberof CustomDashboardExecutionParameter
|
|
14684
|
+
*/
|
|
14685
|
+
name?: string;
|
|
14686
|
+
/**
|
|
14687
|
+
*
|
|
14688
|
+
* @type {string}
|
|
14689
|
+
* @memberof CustomDashboardExecutionParameter
|
|
14690
|
+
*/
|
|
14691
|
+
quick_pick_key?: string;
|
|
14692
|
+
/**
|
|
14693
|
+
*
|
|
14694
|
+
* @type {string}
|
|
14695
|
+
* @memberof CustomDashboardExecutionParameter
|
|
14696
|
+
*/
|
|
14697
|
+
type?: string;
|
|
14698
|
+
/**
|
|
14699
|
+
*
|
|
14700
|
+
* @type {string}
|
|
14701
|
+
* @memberof CustomDashboardExecutionParameter
|
|
14702
|
+
*/
|
|
14703
|
+
value?: string;
|
|
14628
14704
|
}
|
|
14629
14705
|
|
|
14630
14706
|
/**
|
|
@@ -14947,6 +15023,12 @@ export interface CustomReportExecutionParameter {
|
|
|
14947
15023
|
* @memberof CustomReportExecutionParameter
|
|
14948
15024
|
*/
|
|
14949
15025
|
name?: string;
|
|
15026
|
+
/**
|
|
15027
|
+
*
|
|
15028
|
+
* @type {string}
|
|
15029
|
+
* @memberof CustomReportExecutionParameter
|
|
15030
|
+
*/
|
|
15031
|
+
quick_pick_key?: string;
|
|
14950
15032
|
/**
|
|
14951
15033
|
*
|
|
14952
15034
|
* @type {string}
|
|
@@ -20245,6 +20327,44 @@ export interface EmailEditorTokenResponse {
|
|
|
20245
20327
|
warning?: Warning;
|
|
20246
20328
|
}
|
|
20247
20329
|
|
|
20330
|
+
/**
|
|
20331
|
+
*
|
|
20332
|
+
* @export
|
|
20333
|
+
* @interface EmailEditorValuesResponse
|
|
20334
|
+
*/
|
|
20335
|
+
export interface EmailEditorValuesResponse {
|
|
20336
|
+
/**
|
|
20337
|
+
*
|
|
20338
|
+
* @type {ModelError}
|
|
20339
|
+
* @memberof EmailEditorValuesResponse
|
|
20340
|
+
*/
|
|
20341
|
+
error?: ModelError;
|
|
20342
|
+
/**
|
|
20343
|
+
*
|
|
20344
|
+
* @type {Array<string>}
|
|
20345
|
+
* @memberof EmailEditorValuesResponse
|
|
20346
|
+
*/
|
|
20347
|
+
loyalty_tiers?: Array<string>;
|
|
20348
|
+
/**
|
|
20349
|
+
*
|
|
20350
|
+
* @type {ResponseMetadata}
|
|
20351
|
+
* @memberof EmailEditorValuesResponse
|
|
20352
|
+
*/
|
|
20353
|
+
metadata?: ResponseMetadata;
|
|
20354
|
+
/**
|
|
20355
|
+
* Indicates if API call was successful
|
|
20356
|
+
* @type {boolean}
|
|
20357
|
+
* @memberof EmailEditorValuesResponse
|
|
20358
|
+
*/
|
|
20359
|
+
success?: boolean;
|
|
20360
|
+
/**
|
|
20361
|
+
*
|
|
20362
|
+
* @type {Warning}
|
|
20363
|
+
* @memberof EmailEditorValuesResponse
|
|
20364
|
+
*/
|
|
20365
|
+
warning?: Warning;
|
|
20366
|
+
}
|
|
20367
|
+
|
|
20248
20368
|
/**
|
|
20249
20369
|
*
|
|
20250
20370
|
* @export
|
|
@@ -24257,12 +24377,6 @@ export interface EmailWebhookEditorValuesResponse {
|
|
|
24257
24377
|
* @memberof EmailWebhookEditorValuesResponse
|
|
24258
24378
|
*/
|
|
24259
24379
|
error?: ModelError;
|
|
24260
|
-
/**
|
|
24261
|
-
*
|
|
24262
|
-
* @type {Array<string>}
|
|
24263
|
-
* @memberof EmailWebhookEditorValuesResponse
|
|
24264
|
-
*/
|
|
24265
|
-
loyalty_tiers?: Array<string>;
|
|
24266
24380
|
/**
|
|
24267
24381
|
*
|
|
24268
24382
|
* @type {ResponseMetadata}
|
|
@@ -82582,6 +82696,66 @@ export const StorefrontApiFetchParamCreator = function (configuration?: Configur
|
|
|
82582
82696
|
|
|
82583
82697
|
|
|
82584
82698
|
|
|
82699
|
+
// authentication ultraCartBrowserApiKey required
|
|
82700
|
+
if (configuration && configuration.apiKey) {
|
|
82701
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
82702
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
82703
|
+
: configuration.apiKey;
|
|
82704
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
82705
|
+
}
|
|
82706
|
+
|
|
82707
|
+
// authentication ultraCartOauth required
|
|
82708
|
+
// oauth required
|
|
82709
|
+
if (configuration && configuration.accessToken) {
|
|
82710
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
82711
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_read"])
|
|
82712
|
+
: configuration.accessToken;
|
|
82713
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
82714
|
+
}
|
|
82715
|
+
|
|
82716
|
+
// authentication ultraCartSimpleApiKey required
|
|
82717
|
+
if (configuration && configuration.apiKey) {
|
|
82718
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
82719
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
82720
|
+
: configuration.apiKey;
|
|
82721
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
82722
|
+
}
|
|
82723
|
+
|
|
82724
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
82725
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
82726
|
+
delete localVarUrlObj.search;
|
|
82727
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
82728
|
+
|
|
82729
|
+
return {
|
|
82730
|
+
url: url.format(localVarUrlObj),
|
|
82731
|
+
options: localVarRequestOptions,
|
|
82732
|
+
};
|
|
82733
|
+
},
|
|
82734
|
+
/**
|
|
82735
|
+
*
|
|
82736
|
+
* @summary Get email merchant specific editor values
|
|
82737
|
+
* @param {number} storefront_oid
|
|
82738
|
+
* @param {*} [options] Override http request option.
|
|
82739
|
+
* @throws {RequiredError}
|
|
82740
|
+
*/
|
|
82741
|
+
getEmailCommseqEditorValues(storefront_oid: number, options: any = {}): FetchArgs {
|
|
82742
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
82743
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
82744
|
+
throw new RequiredError('storefront_oid','Required parameter storefront_oid was null or undefined when calling getEmailCommseqEditorValues.');
|
|
82745
|
+
}
|
|
82746
|
+
const localVarPath = `/storefront/{storefront_oid}/email/commseqs/editorValues`
|
|
82747
|
+
.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(storefront_oid)));
|
|
82748
|
+
const localVarUrlObj = url.parse(localVarPath, true);
|
|
82749
|
+
const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
82750
|
+
const localVarHeaderParameter = {} as any;
|
|
82751
|
+
const localVarQueryParameter = {} as any;
|
|
82752
|
+
|
|
82753
|
+
if(configuration && configuration.apiVersion) {
|
|
82754
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
82755
|
+
}
|
|
82756
|
+
|
|
82757
|
+
|
|
82758
|
+
|
|
82585
82759
|
// authentication ultraCartBrowserApiKey required
|
|
82586
82760
|
if (configuration && configuration.apiKey) {
|
|
82587
82761
|
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
@@ -92845,6 +93019,27 @@ export const StorefrontApiFp = function(configuration?: Configuration) {
|
|
|
92845
93019
|
});
|
|
92846
93020
|
};
|
|
92847
93021
|
},
|
|
93022
|
+
/**
|
|
93023
|
+
*
|
|
93024
|
+
* @summary Get email merchant specific editor values
|
|
93025
|
+
* @param {number} storefront_oid
|
|
93026
|
+
* @param {*} [options] Override http request option.
|
|
93027
|
+
* @throws {RequiredError}
|
|
93028
|
+
*/
|
|
93029
|
+
getEmailCommseqEditorValues(storefront_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailEditorValuesResponse> {
|
|
93030
|
+
const localVarFetchArgs = StorefrontApiFetchParamCreator(configuration).getEmailCommseqEditorValues(storefront_oid, options);
|
|
93031
|
+
return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
|
|
93032
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
|
|
93033
|
+
|
|
93034
|
+
if (response.status >= 200 && response.status < 300) {
|
|
93035
|
+
return response.json();
|
|
93036
|
+
|
|
93037
|
+
} else {
|
|
93038
|
+
throw response;
|
|
93039
|
+
}
|
|
93040
|
+
});
|
|
93041
|
+
};
|
|
93042
|
+
},
|
|
92848
93043
|
/**
|
|
92849
93044
|
*
|
|
92850
93045
|
* @summary Get email communication sequence emails stats
|
|
@@ -96360,6 +96555,16 @@ export const StorefrontApiFactory = function (configuration?: Configuration, fet
|
|
|
96360
96555
|
getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any) {
|
|
96361
96556
|
return StorefrontApiFp(configuration).getEmailCommseq(storefront_oid, commseq_uuid, options)(fetch, basePath);
|
|
96362
96557
|
},
|
|
96558
|
+
/**
|
|
96559
|
+
*
|
|
96560
|
+
* @summary Get email merchant specific editor values
|
|
96561
|
+
* @param {number} storefront_oid
|
|
96562
|
+
* @param {*} [options] Override http request option.
|
|
96563
|
+
* @throws {RequiredError}
|
|
96564
|
+
*/
|
|
96565
|
+
getEmailCommseqEditorValues(storefront_oid: number, options?: any) {
|
|
96566
|
+
return StorefrontApiFp(configuration).getEmailCommseqEditorValues(storefront_oid, options)(fetch, basePath);
|
|
96567
|
+
},
|
|
96363
96568
|
/**
|
|
96364
96569
|
*
|
|
96365
96570
|
* @summary Get email communication sequence emails stats
|
|
@@ -98357,6 +98562,16 @@ export interface StorefrontApiInterface {
|
|
|
98357
98562
|
*/
|
|
98358
98563
|
getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailCommseqResponse>;
|
|
98359
98564
|
|
|
98565
|
+
/**
|
|
98566
|
+
*
|
|
98567
|
+
* @summary Get email merchant specific editor values
|
|
98568
|
+
* @param {number} storefront_oid
|
|
98569
|
+
* @param {*} [options] Override http request option.
|
|
98570
|
+
* @throws {RequiredError}
|
|
98571
|
+
* @memberof StorefrontApiInterface
|
|
98572
|
+
*/
|
|
98573
|
+
getEmailCommseqEditorValues(storefront_oid: number, options?: any): Promise<EmailEditorValuesResponse>;
|
|
98574
|
+
|
|
98360
98575
|
/**
|
|
98361
98576
|
*
|
|
98362
98577
|
* @summary Get email communication sequence emails stats
|
|
@@ -100434,6 +100649,18 @@ export class StorefrontApi extends BaseAPI implements StorefrontApiInterface {
|
|
|
100434
100649
|
return StorefrontApiFp(this.configuration).getEmailCommseq(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
|
|
100435
100650
|
}
|
|
100436
100651
|
|
|
100652
|
+
/**
|
|
100653
|
+
*
|
|
100654
|
+
* @summary Get email merchant specific editor values
|
|
100655
|
+
* @param {number} storefront_oid
|
|
100656
|
+
* @param {*} [options] Override http request option.
|
|
100657
|
+
* @throws {RequiredError}
|
|
100658
|
+
* @memberof StorefrontApi
|
|
100659
|
+
*/
|
|
100660
|
+
public getEmailCommseqEditorValues(storefront_oid: number, options?: any) {
|
|
100661
|
+
return StorefrontApiFp(this.configuration).getEmailCommseqEditorValues(storefront_oid, options)(this.fetch, this.basePath);
|
|
100662
|
+
}
|
|
100663
|
+
|
|
100437
100664
|
/**
|
|
100438
100665
|
*
|
|
100439
100666
|
* @summary Get email communication sequence emails stats
|
package/dist/api.d.ts
CHANGED
|
@@ -11114,6 +11114,12 @@ export interface ConversationVirtualAgentCapabilities {
|
|
|
11114
11114
|
* @memberof ConversationVirtualAgentCapabilities
|
|
11115
11115
|
*/
|
|
11116
11116
|
open_support_ticket_channel_email?: string;
|
|
11117
|
+
/**
|
|
11118
|
+
* Department ID to open a Zoho Desk ticket for
|
|
11119
|
+
* @type {string}
|
|
11120
|
+
* @memberof ConversationVirtualAgentCapabilities
|
|
11121
|
+
*/
|
|
11122
|
+
open_support_ticket_zoho_desk_department_id?: string;
|
|
11117
11123
|
/**
|
|
11118
11124
|
*
|
|
11119
11125
|
* @type {boolean}
|
|
@@ -11138,6 +11144,18 @@ export interface ConversationVirtualAgentCapabilities {
|
|
|
11138
11144
|
* @memberof ConversationVirtualAgentCapabilities
|
|
11139
11145
|
*/
|
|
11140
11146
|
update_subscription_credit_card?: boolean;
|
|
11147
|
+
/**
|
|
11148
|
+
* True if Zoho Desk is connected to UltraCart
|
|
11149
|
+
* @type {boolean}
|
|
11150
|
+
* @memberof ConversationVirtualAgentCapabilities
|
|
11151
|
+
*/
|
|
11152
|
+
zoho_desk_available?: boolean;
|
|
11153
|
+
/**
|
|
11154
|
+
* Array of Zoho Desk Department if zoho desk is connected to UltraCart
|
|
11155
|
+
* @type {Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>}
|
|
11156
|
+
* @memberof ConversationVirtualAgentCapabilities
|
|
11157
|
+
*/
|
|
11158
|
+
zoho_desk_departments?: Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>;
|
|
11141
11159
|
}
|
|
11142
11160
|
/**
|
|
11143
11161
|
* @export
|
|
@@ -11151,7 +11169,7 @@ export declare namespace ConversationVirtualAgentCapabilities {
|
|
|
11151
11169
|
enum OpenSupportTicketChannelEnum {
|
|
11152
11170
|
None,
|
|
11153
11171
|
Email,
|
|
11154
|
-
|
|
11172
|
+
UltracartTask,
|
|
11155
11173
|
ZohoDeskTicket
|
|
11156
11174
|
}
|
|
11157
11175
|
}
|
|
@@ -11192,6 +11210,25 @@ export interface ConversationVirtualAgentCapabilitiesResponse {
|
|
|
11192
11210
|
*/
|
|
11193
11211
|
warning?: Warning;
|
|
11194
11212
|
}
|
|
11213
|
+
/**
|
|
11214
|
+
*
|
|
11215
|
+
* @export
|
|
11216
|
+
* @interface ConversationVirtualAgentCapabilityZohoDeskDepartment
|
|
11217
|
+
*/
|
|
11218
|
+
export interface ConversationVirtualAgentCapabilityZohoDeskDepartment {
|
|
11219
|
+
/**
|
|
11220
|
+
*
|
|
11221
|
+
* @type {string}
|
|
11222
|
+
* @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
|
|
11223
|
+
*/
|
|
11224
|
+
department_id?: string;
|
|
11225
|
+
/**
|
|
11226
|
+
*
|
|
11227
|
+
* @type {string}
|
|
11228
|
+
* @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
|
|
11229
|
+
*/
|
|
11230
|
+
department_name?: string;
|
|
11231
|
+
}
|
|
11195
11232
|
/**
|
|
11196
11233
|
*
|
|
11197
11234
|
* @export
|
|
@@ -14269,6 +14306,43 @@ export interface CustomDashboard {
|
|
|
14269
14306
|
* @memberof CustomDashboard
|
|
14270
14307
|
*/
|
|
14271
14308
|
pages?: Array<CustomDashboardPage>;
|
|
14309
|
+
/**
|
|
14310
|
+
*
|
|
14311
|
+
* @type {Array<CustomDashboardExecutionParameter>}
|
|
14312
|
+
* @memberof CustomDashboard
|
|
14313
|
+
*/
|
|
14314
|
+
parameters?: Array<CustomDashboardExecutionParameter>;
|
|
14315
|
+
}
|
|
14316
|
+
/**
|
|
14317
|
+
*
|
|
14318
|
+
* @export
|
|
14319
|
+
* @interface CustomDashboardExecutionParameter
|
|
14320
|
+
*/
|
|
14321
|
+
export interface CustomDashboardExecutionParameter {
|
|
14322
|
+
/**
|
|
14323
|
+
*
|
|
14324
|
+
* @type {string}
|
|
14325
|
+
* @memberof CustomDashboardExecutionParameter
|
|
14326
|
+
*/
|
|
14327
|
+
name?: string;
|
|
14328
|
+
/**
|
|
14329
|
+
*
|
|
14330
|
+
* @type {string}
|
|
14331
|
+
* @memberof CustomDashboardExecutionParameter
|
|
14332
|
+
*/
|
|
14333
|
+
quick_pick_key?: string;
|
|
14334
|
+
/**
|
|
14335
|
+
*
|
|
14336
|
+
* @type {string}
|
|
14337
|
+
* @memberof CustomDashboardExecutionParameter
|
|
14338
|
+
*/
|
|
14339
|
+
type?: string;
|
|
14340
|
+
/**
|
|
14341
|
+
*
|
|
14342
|
+
* @type {string}
|
|
14343
|
+
* @memberof CustomDashboardExecutionParameter
|
|
14344
|
+
*/
|
|
14345
|
+
value?: string;
|
|
14272
14346
|
}
|
|
14273
14347
|
/**
|
|
14274
14348
|
*
|
|
@@ -14583,6 +14657,12 @@ export interface CustomReportExecutionParameter {
|
|
|
14583
14657
|
* @memberof CustomReportExecutionParameter
|
|
14584
14658
|
*/
|
|
14585
14659
|
name?: string;
|
|
14660
|
+
/**
|
|
14661
|
+
*
|
|
14662
|
+
* @type {string}
|
|
14663
|
+
* @memberof CustomReportExecutionParameter
|
|
14664
|
+
*/
|
|
14665
|
+
quick_pick_key?: string;
|
|
14586
14666
|
/**
|
|
14587
14667
|
*
|
|
14588
14668
|
* @type {string}
|
|
@@ -19785,6 +19865,43 @@ export interface EmailEditorTokenResponse {
|
|
|
19785
19865
|
*/
|
|
19786
19866
|
warning?: Warning;
|
|
19787
19867
|
}
|
|
19868
|
+
/**
|
|
19869
|
+
*
|
|
19870
|
+
* @export
|
|
19871
|
+
* @interface EmailEditorValuesResponse
|
|
19872
|
+
*/
|
|
19873
|
+
export interface EmailEditorValuesResponse {
|
|
19874
|
+
/**
|
|
19875
|
+
*
|
|
19876
|
+
* @type {ModelError}
|
|
19877
|
+
* @memberof EmailEditorValuesResponse
|
|
19878
|
+
*/
|
|
19879
|
+
error?: ModelError;
|
|
19880
|
+
/**
|
|
19881
|
+
*
|
|
19882
|
+
* @type {Array<string>}
|
|
19883
|
+
* @memberof EmailEditorValuesResponse
|
|
19884
|
+
*/
|
|
19885
|
+
loyalty_tiers?: Array<string>;
|
|
19886
|
+
/**
|
|
19887
|
+
*
|
|
19888
|
+
* @type {ResponseMetadata}
|
|
19889
|
+
* @memberof EmailEditorValuesResponse
|
|
19890
|
+
*/
|
|
19891
|
+
metadata?: ResponseMetadata;
|
|
19892
|
+
/**
|
|
19893
|
+
* Indicates if API call was successful
|
|
19894
|
+
* @type {boolean}
|
|
19895
|
+
* @memberof EmailEditorValuesResponse
|
|
19896
|
+
*/
|
|
19897
|
+
success?: boolean;
|
|
19898
|
+
/**
|
|
19899
|
+
*
|
|
19900
|
+
* @type {Warning}
|
|
19901
|
+
* @memberof EmailEditorValuesResponse
|
|
19902
|
+
*/
|
|
19903
|
+
warning?: Warning;
|
|
19904
|
+
}
|
|
19788
19905
|
/**
|
|
19789
19906
|
*
|
|
19790
19907
|
* @export
|
|
@@ -23718,12 +23835,6 @@ export interface EmailWebhookEditorValuesResponse {
|
|
|
23718
23835
|
* @memberof EmailWebhookEditorValuesResponse
|
|
23719
23836
|
*/
|
|
23720
23837
|
error?: ModelError;
|
|
23721
|
-
/**
|
|
23722
|
-
*
|
|
23723
|
-
* @type {Array<string>}
|
|
23724
|
-
* @memberof EmailWebhookEditorValuesResponse
|
|
23725
|
-
*/
|
|
23726
|
-
loyalty_tiers?: Array<string>;
|
|
23727
23838
|
/**
|
|
23728
23839
|
*
|
|
23729
23840
|
* @type {ResponseMetadata}
|
|
@@ -59630,6 +59741,14 @@ export declare const StorefrontApiFetchParamCreator: (configuration?: Configurat
|
|
|
59630
59741
|
* @throws {RequiredError}
|
|
59631
59742
|
*/
|
|
59632
59743
|
getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): FetchArgs;
|
|
59744
|
+
/**
|
|
59745
|
+
*
|
|
59746
|
+
* @summary Get email merchant specific editor values
|
|
59747
|
+
* @param {number} storefront_oid
|
|
59748
|
+
* @param {*} [options] Override http request option.
|
|
59749
|
+
* @throws {RequiredError}
|
|
59750
|
+
*/
|
|
59751
|
+
getEmailCommseqEditorValues(storefront_oid: number, options?: any): FetchArgs;
|
|
59633
59752
|
/**
|
|
59634
59753
|
*
|
|
59635
59754
|
* @summary Get email communication sequence emails stats
|
|
@@ -61268,6 +61387,14 @@ export declare const StorefrontApiFp: (configuration?: Configuration) => {
|
|
|
61268
61387
|
* @throws {RequiredError}
|
|
61269
61388
|
*/
|
|
61270
61389
|
getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailCommseqResponse>;
|
|
61390
|
+
/**
|
|
61391
|
+
*
|
|
61392
|
+
* @summary Get email merchant specific editor values
|
|
61393
|
+
* @param {number} storefront_oid
|
|
61394
|
+
* @param {*} [options] Override http request option.
|
|
61395
|
+
* @throws {RequiredError}
|
|
61396
|
+
*/
|
|
61397
|
+
getEmailCommseqEditorValues(storefront_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailEditorValuesResponse>;
|
|
61271
61398
|
/**
|
|
61272
61399
|
*
|
|
61273
61400
|
* @summary Get email communication sequence emails stats
|
|
@@ -62906,6 +63033,14 @@ export declare const StorefrontApiFactory: (configuration?: Configuration, fetch
|
|
|
62906
63033
|
* @throws {RequiredError}
|
|
62907
63034
|
*/
|
|
62908
63035
|
getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailCommseqResponse>;
|
|
63036
|
+
/**
|
|
63037
|
+
*
|
|
63038
|
+
* @summary Get email merchant specific editor values
|
|
63039
|
+
* @param {number} storefront_oid
|
|
63040
|
+
* @param {*} [options] Override http request option.
|
|
63041
|
+
* @throws {RequiredError}
|
|
63042
|
+
*/
|
|
63043
|
+
getEmailCommseqEditorValues(storefront_oid: number, options?: any): Promise<EmailEditorValuesResponse>;
|
|
62909
63044
|
/**
|
|
62910
63045
|
*
|
|
62911
63046
|
* @summary Get email communication sequence emails stats
|
|
@@ -64585,6 +64720,15 @@ export interface StorefrontApiInterface {
|
|
|
64585
64720
|
* @memberof StorefrontApiInterface
|
|
64586
64721
|
*/
|
|
64587
64722
|
getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailCommseqResponse>;
|
|
64723
|
+
/**
|
|
64724
|
+
*
|
|
64725
|
+
* @summary Get email merchant specific editor values
|
|
64726
|
+
* @param {number} storefront_oid
|
|
64727
|
+
* @param {*} [options] Override http request option.
|
|
64728
|
+
* @throws {RequiredError}
|
|
64729
|
+
* @memberof StorefrontApiInterface
|
|
64730
|
+
*/
|
|
64731
|
+
getEmailCommseqEditorValues(storefront_oid: number, options?: any): Promise<EmailEditorValuesResponse>;
|
|
64588
64732
|
/**
|
|
64589
64733
|
*
|
|
64590
64734
|
* @summary Get email communication sequence emails stats
|
|
@@ -66403,6 +66547,15 @@ export declare class StorefrontApi extends BaseAPI implements StorefrontApiInter
|
|
|
66403
66547
|
* @memberof StorefrontApi
|
|
66404
66548
|
*/
|
|
66405
66549
|
getEmailCommseq(storefront_oid: number, commseq_uuid: string, options?: any): Promise<EmailCommseqResponse>;
|
|
66550
|
+
/**
|
|
66551
|
+
*
|
|
66552
|
+
* @summary Get email merchant specific editor values
|
|
66553
|
+
* @param {number} storefront_oid
|
|
66554
|
+
* @param {*} [options] Override http request option.
|
|
66555
|
+
* @throws {RequiredError}
|
|
66556
|
+
* @memberof StorefrontApi
|
|
66557
|
+
*/
|
|
66558
|
+
getEmailCommseqEditorValues(storefront_oid: number, options?: any): Promise<EmailEditorValuesResponse>;
|
|
66406
66559
|
/**
|
|
66407
66560
|
*
|
|
66408
66561
|
* @summary Get email communication sequence emails stats
|
package/dist/api.js
CHANGED
|
@@ -770,8 +770,8 @@ var ConversationVirtualAgentCapabilities;
|
|
|
770
770
|
(function (OpenSupportTicketChannelEnum) {
|
|
771
771
|
OpenSupportTicketChannelEnum[OpenSupportTicketChannelEnum["None"] = 'none'] = "None";
|
|
772
772
|
OpenSupportTicketChannelEnum[OpenSupportTicketChannelEnum["Email"] = 'email'] = "Email";
|
|
773
|
-
OpenSupportTicketChannelEnum[OpenSupportTicketChannelEnum["
|
|
774
|
-
OpenSupportTicketChannelEnum[OpenSupportTicketChannelEnum["ZohoDeskTicket"] = '
|
|
773
|
+
OpenSupportTicketChannelEnum[OpenSupportTicketChannelEnum["UltracartTask"] = 'ultracart_task'] = "UltracartTask";
|
|
774
|
+
OpenSupportTicketChannelEnum[OpenSupportTicketChannelEnum["ZohoDeskTicket"] = 'zoho_desk_ticket'] = "ZohoDeskTicket";
|
|
775
775
|
})(OpenSupportTicketChannelEnum = ConversationVirtualAgentCapabilities.OpenSupportTicketChannelEnum || (ConversationVirtualAgentCapabilities.OpenSupportTicketChannelEnum = {}));
|
|
776
776
|
})(ConversationVirtualAgentCapabilities = exports.ConversationVirtualAgentCapabilities || (exports.ConversationVirtualAgentCapabilities = {}));
|
|
777
777
|
/**
|
|
@@ -32580,6 +32580,59 @@ var StorefrontApiFetchParamCreator = function (configuration) {
|
|
|
32580
32580
|
options: localVarRequestOptions,
|
|
32581
32581
|
};
|
|
32582
32582
|
},
|
|
32583
|
+
/**
|
|
32584
|
+
*
|
|
32585
|
+
* @summary Get email merchant specific editor values
|
|
32586
|
+
* @param {number} storefront_oid
|
|
32587
|
+
* @param {*} [options] Override http request option.
|
|
32588
|
+
* @throws {RequiredError}
|
|
32589
|
+
*/
|
|
32590
|
+
getEmailCommseqEditorValues: function (storefront_oid, options) {
|
|
32591
|
+
if (options === void 0) { options = {}; }
|
|
32592
|
+
// verify required parameter 'storefront_oid' is not null or undefined
|
|
32593
|
+
if (storefront_oid === null || storefront_oid === undefined) {
|
|
32594
|
+
throw new RequiredError('storefront_oid', 'Required parameter storefront_oid was null or undefined when calling getEmailCommseqEditorValues.');
|
|
32595
|
+
}
|
|
32596
|
+
var localVarPath = "/storefront/{storefront_oid}/email/commseqs/editorValues"
|
|
32597
|
+
.replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(storefront_oid)));
|
|
32598
|
+
var localVarUrlObj = url.parse(localVarPath, true);
|
|
32599
|
+
var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
|
|
32600
|
+
var localVarHeaderParameter = {};
|
|
32601
|
+
var localVarQueryParameter = {};
|
|
32602
|
+
if (configuration && configuration.apiVersion) {
|
|
32603
|
+
localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
|
|
32604
|
+
}
|
|
32605
|
+
// authentication ultraCartBrowserApiKey required
|
|
32606
|
+
if (configuration && configuration.apiKey) {
|
|
32607
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
32608
|
+
? configuration.apiKey("x-ultracart-browser-key")
|
|
32609
|
+
: configuration.apiKey;
|
|
32610
|
+
localVarHeaderParameter["x-ultracart-browser-key"] = localVarApiKeyValue;
|
|
32611
|
+
}
|
|
32612
|
+
// authentication ultraCartOauth required
|
|
32613
|
+
// oauth required
|
|
32614
|
+
if (configuration && configuration.accessToken) {
|
|
32615
|
+
var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
32616
|
+
? configuration.accessToken("ultraCartOauth", ["storefront_read"])
|
|
32617
|
+
: configuration.accessToken;
|
|
32618
|
+
localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
32619
|
+
}
|
|
32620
|
+
// authentication ultraCartSimpleApiKey required
|
|
32621
|
+
if (configuration && configuration.apiKey) {
|
|
32622
|
+
var localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
32623
|
+
? configuration.apiKey("x-ultracart-simple-key")
|
|
32624
|
+
: configuration.apiKey;
|
|
32625
|
+
localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
|
|
32626
|
+
}
|
|
32627
|
+
localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
|
|
32628
|
+
// fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
|
|
32629
|
+
delete localVarUrlObj.search;
|
|
32630
|
+
localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
|
|
32631
|
+
return {
|
|
32632
|
+
url: url.format(localVarUrlObj),
|
|
32633
|
+
options: localVarRequestOptions,
|
|
32634
|
+
};
|
|
32635
|
+
},
|
|
32583
32636
|
/**
|
|
32584
32637
|
*
|
|
32585
32638
|
* @summary Get email communication sequence emails stats
|
|
@@ -41785,6 +41838,28 @@ var StorefrontApiFp = function (configuration) {
|
|
|
41785
41838
|
});
|
|
41786
41839
|
};
|
|
41787
41840
|
},
|
|
41841
|
+
/**
|
|
41842
|
+
*
|
|
41843
|
+
* @summary Get email merchant specific editor values
|
|
41844
|
+
* @param {number} storefront_oid
|
|
41845
|
+
* @param {*} [options] Override http request option.
|
|
41846
|
+
* @throws {RequiredError}
|
|
41847
|
+
*/
|
|
41848
|
+
getEmailCommseqEditorValues: function (storefront_oid, options) {
|
|
41849
|
+
var localVarFetchArgs = (0, exports.StorefrontApiFetchParamCreator)(configuration).getEmailCommseqEditorValues(storefront_oid, options);
|
|
41850
|
+
return function (fetch, basePath) {
|
|
41851
|
+
if (fetch === void 0) { fetch = portableFetch; }
|
|
41852
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
41853
|
+
return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
|
|
41854
|
+
if (response.status >= 200 && response.status < 300) {
|
|
41855
|
+
return response.json();
|
|
41856
|
+
}
|
|
41857
|
+
else {
|
|
41858
|
+
throw response;
|
|
41859
|
+
}
|
|
41860
|
+
});
|
|
41861
|
+
};
|
|
41862
|
+
},
|
|
41788
41863
|
/**
|
|
41789
41864
|
*
|
|
41790
41865
|
* @summary Get email communication sequence emails stats
|
|
@@ -45438,6 +45513,16 @@ var StorefrontApiFactory = function (configuration, fetch, basePath) {
|
|
|
45438
45513
|
getEmailCommseq: function (storefront_oid, commseq_uuid, options) {
|
|
45439
45514
|
return (0, exports.StorefrontApiFp)(configuration).getEmailCommseq(storefront_oid, commseq_uuid, options)(fetch, basePath);
|
|
45440
45515
|
},
|
|
45516
|
+
/**
|
|
45517
|
+
*
|
|
45518
|
+
* @summary Get email merchant specific editor values
|
|
45519
|
+
* @param {number} storefront_oid
|
|
45520
|
+
* @param {*} [options] Override http request option.
|
|
45521
|
+
* @throws {RequiredError}
|
|
45522
|
+
*/
|
|
45523
|
+
getEmailCommseqEditorValues: function (storefront_oid, options) {
|
|
45524
|
+
return (0, exports.StorefrontApiFp)(configuration).getEmailCommseqEditorValues(storefront_oid, options)(fetch, basePath);
|
|
45525
|
+
},
|
|
45441
45526
|
/**
|
|
45442
45527
|
*
|
|
45443
45528
|
* @summary Get email communication sequence emails stats
|
|
@@ -47480,6 +47565,17 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
47480
47565
|
StorefrontApi.prototype.getEmailCommseq = function (storefront_oid, commseq_uuid, options) {
|
|
47481
47566
|
return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseq(storefront_oid, commseq_uuid, options)(this.fetch, this.basePath);
|
|
47482
47567
|
};
|
|
47568
|
+
/**
|
|
47569
|
+
*
|
|
47570
|
+
* @summary Get email merchant specific editor values
|
|
47571
|
+
* @param {number} storefront_oid
|
|
47572
|
+
* @param {*} [options] Override http request option.
|
|
47573
|
+
* @throws {RequiredError}
|
|
47574
|
+
* @memberof StorefrontApi
|
|
47575
|
+
*/
|
|
47576
|
+
StorefrontApi.prototype.getEmailCommseqEditorValues = function (storefront_oid, options) {
|
|
47577
|
+
return (0, exports.StorefrontApiFp)(this.configuration).getEmailCommseqEditorValues(storefront_oid, options)(this.fetch, this.basePath);
|
|
47578
|
+
};
|
|
47483
47579
|
/**
|
|
47484
47580
|
*
|
|
47485
47581
|
* @summary Get email communication sequence emails stats
|