ultracart_rest_api_v2_typescript 3.11.18 → 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 +3 -2
- package/api.ts +84 -2
- package/dist/api.d.ts +81 -1
- package/dist/api.js +2 -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,7 @@ 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 |
|
|
57
58
|
| 3.11.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
|
|
58
59
|
| 3.11.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
|
|
59
60
|
| 3.11.16 | 07/28/2025 | updated doc samples |
|
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}
|
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}
|
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
|
/**
|