ultracart_rest_api_v2_typescript 4.1.18 → 4.1.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.
@@ -249,6 +249,7 @@ src/models/ConversationVirtualAgentBudget.ts
249
249
  src/models/ConversationVirtualAgentBudgetResponse.ts
250
250
  src/models/ConversationVirtualAgentCapabilities.ts
251
251
  src/models/ConversationVirtualAgentCapabilitiesResponse.ts
252
+ src/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.ts
252
253
  src/models/ConversationWebchatContext.ts
253
254
  src/models/ConversationWebchatQueueStatus.ts
254
255
  src/models/ConversationWebchatQueueStatusAgent.ts
@@ -330,6 +331,7 @@ src/models/CouponsRequest.ts
330
331
  src/models/CouponsResponse.ts
331
332
  src/models/Currency.ts
332
333
  src/models/CustomDashboard.ts
334
+ src/models/CustomDashboardExecutionParameter.ts
333
335
  src/models/CustomDashboardPage.ts
334
336
  src/models/CustomDashboardPageReport.ts
335
337
  src/models/CustomDashboardResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.18
2
+ ## ultracart_rest_api_v2_typescript@4.1.19
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.18 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.19 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
88
89
  | 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
89
90
  | 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
90
91
  | 4.1.16 | 07/28/2025 | updated doc samples |
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { ConversationVirtualAgentCapabilityZohoDeskDepartment } from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -57,6 +58,12 @@ export interface ConversationVirtualAgentCapabilities {
57
58
  * @memberof ConversationVirtualAgentCapabilities
58
59
  */
59
60
  open_support_ticket_channel_email?: string;
61
+ /**
62
+ * Department ID to open a Zoho Desk ticket for
63
+ * @type {string}
64
+ * @memberof ConversationVirtualAgentCapabilities
65
+ */
66
+ open_support_ticket_zoho_desk_department_id?: string;
60
67
  /**
61
68
  *
62
69
  * @type {boolean}
@@ -81,6 +88,18 @@ export interface ConversationVirtualAgentCapabilities {
81
88
  * @memberof ConversationVirtualAgentCapabilities
82
89
  */
83
90
  update_subscription_credit_card?: boolean;
91
+ /**
92
+ * True if Zoho Desk is connected to UltraCart
93
+ * @type {boolean}
94
+ * @memberof ConversationVirtualAgentCapabilities
95
+ */
96
+ zoho_desk_available?: boolean;
97
+ /**
98
+ * Array of Zoho Desk Department if zoho desk is connected to UltraCart
99
+ * @type {Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>}
100
+ * @memberof ConversationVirtualAgentCapabilities
101
+ */
102
+ zoho_desk_departments?: Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>;
84
103
  }
85
104
  /**
86
105
  * @export
@@ -88,8 +107,8 @@ export interface ConversationVirtualAgentCapabilities {
88
107
  export declare const ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum: {
89
108
  readonly None: "none";
90
109
  readonly Email: "email";
91
- readonly UltraCartTask: "UltraCart Task";
92
- readonly ZohoDeskTicket: "Zoho Desk Ticket";
110
+ readonly UltracartTask: "ultracart_task";
111
+ readonly ZohoDeskTicket: "zoho_desk_ticket";
93
112
  };
94
113
  export type ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum = typeof ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum[keyof typeof ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum];
95
114
  /**
@@ -15,14 +15,15 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.ConversationVirtualAgentCapabilitiesToJSON = exports.ConversationVirtualAgentCapabilitiesFromJSONTyped = exports.ConversationVirtualAgentCapabilitiesFromJSON = exports.instanceOfConversationVirtualAgentCapabilities = exports.ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum = void 0;
17
17
  var runtime_1 = require("../runtime");
18
+ var ConversationVirtualAgentCapabilityZohoDeskDepartment_1 = require("./ConversationVirtualAgentCapabilityZohoDeskDepartment");
18
19
  /**
19
20
  * @export
20
21
  */
21
22
  exports.ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum = {
22
23
  None: 'none',
23
24
  Email: 'email',
24
- UltraCartTask: 'UltraCart Task',
25
- ZohoDeskTicket: 'Zoho Desk Ticket'
25
+ UltracartTask: 'ultracart_task',
26
+ ZohoDeskTicket: 'zoho_desk_ticket'
26
27
  };
27
28
  /**
28
29
  * Check if a given object implements the ConversationVirtualAgentCapabilities interface.
@@ -48,10 +49,13 @@ function ConversationVirtualAgentCapabilitiesFromJSONTyped(json, ignoreDiscrimin
48
49
  'open_support_ticket': !(0, runtime_1.exists)(json, 'open_support_ticket') ? undefined : json['open_support_ticket'],
49
50
  'open_support_ticket_channel': !(0, runtime_1.exists)(json, 'open_support_ticket_channel') ? undefined : json['open_support_ticket_channel'],
50
51
  'open_support_ticket_channel_email': !(0, runtime_1.exists)(json, 'open_support_ticket_channel_email') ? undefined : json['open_support_ticket_channel_email'],
52
+ 'open_support_ticket_zoho_desk_department_id': !(0, runtime_1.exists)(json, 'open_support_ticket_zoho_desk_department_id') ? undefined : json['open_support_ticket_zoho_desk_department_id'],
51
53
  'pause_subscription': !(0, runtime_1.exists)(json, 'pause_subscription') ? undefined : json['pause_subscription'],
52
54
  'resume_subscription': !(0, runtime_1.exists)(json, 'resume_subscription') ? undefined : json['resume_subscription'],
53
55
  'transfer_chat_to_live_agent': !(0, runtime_1.exists)(json, 'transfer_chat_to_live_agent') ? undefined : json['transfer_chat_to_live_agent'],
54
56
  'update_subscription_credit_card': !(0, runtime_1.exists)(json, 'update_subscription_credit_card') ? undefined : json['update_subscription_credit_card'],
57
+ 'zoho_desk_available': !(0, runtime_1.exists)(json, 'zoho_desk_available') ? undefined : json['zoho_desk_available'],
58
+ 'zoho_desk_departments': !(0, runtime_1.exists)(json, 'zoho_desk_departments') ? undefined : (json['zoho_desk_departments'].map(ConversationVirtualAgentCapabilityZohoDeskDepartment_1.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON)),
55
59
  };
56
60
  }
57
61
  exports.ConversationVirtualAgentCapabilitiesFromJSONTyped = ConversationVirtualAgentCapabilitiesFromJSONTyped;
@@ -70,10 +74,13 @@ function ConversationVirtualAgentCapabilitiesToJSON(value) {
70
74
  'open_support_ticket': value.open_support_ticket,
71
75
  'open_support_ticket_channel': value.open_support_ticket_channel,
72
76
  'open_support_ticket_channel_email': value.open_support_ticket_channel_email,
77
+ 'open_support_ticket_zoho_desk_department_id': value.open_support_ticket_zoho_desk_department_id,
73
78
  'pause_subscription': value.pause_subscription,
74
79
  'resume_subscription': value.resume_subscription,
75
80
  'transfer_chat_to_live_agent': value.transfer_chat_to_live_agent,
76
81
  'update_subscription_credit_card': value.update_subscription_credit_card,
82
+ 'zoho_desk_available': value.zoho_desk_available,
83
+ 'zoho_desk_departments': value.zoho_desk_departments === undefined ? undefined : (value.zoho_desk_departments.map(ConversationVirtualAgentCapabilityZohoDeskDepartment_1.ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON)),
77
84
  };
78
85
  }
79
86
  exports.ConversationVirtualAgentCapabilitiesToJSON = ConversationVirtualAgentCapabilitiesToJSON;
@@ -0,0 +1,37 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface ConversationVirtualAgentCapabilityZohoDeskDepartment
16
+ */
17
+ export interface ConversationVirtualAgentCapabilityZohoDeskDepartment {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
22
+ */
23
+ department_id?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
28
+ */
29
+ department_name?: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the ConversationVirtualAgentCapabilityZohoDeskDepartment interface.
33
+ */
34
+ export declare function instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment(value: object): boolean;
35
+ export declare function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON(json: any): ConversationVirtualAgentCapabilityZohoDeskDepartment;
36
+ export declare function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentCapabilityZohoDeskDepartment;
37
+ export declare function ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON(value?: ConversationVirtualAgentCapabilityZohoDeskDepartment | null): any;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON = exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped = exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON = exports.instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the ConversationVirtualAgentCapabilityZohoDeskDepartment interface.
20
+ */
21
+ function instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment = instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment;
26
+ function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON(json) {
27
+ return ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped(json, false);
28
+ }
29
+ exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON = ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON;
30
+ function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'department_id': !(0, runtime_1.exists)(json, 'department_id') ? undefined : json['department_id'],
36
+ 'department_name': !(0, runtime_1.exists)(json, 'department_name') ? undefined : json['department_name'],
37
+ };
38
+ }
39
+ exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped = ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped;
40
+ function ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON(value) {
41
+ if (value === undefined) {
42
+ return undefined;
43
+ }
44
+ if (value === null) {
45
+ return null;
46
+ }
47
+ return {
48
+ 'department_id': value.department_id,
49
+ 'department_name': value.department_name,
50
+ };
51
+ }
52
+ exports.ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON = ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON;
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { CustomDashboardExecutionParameter } from './CustomDashboardExecutionParameter';
12
13
  import { CustomDashboardPage } from './CustomDashboardPage';
13
14
  /**
14
15
  *
@@ -40,6 +41,12 @@ export interface CustomDashboard {
40
41
  * @memberof CustomDashboard
41
42
  */
42
43
  pages?: Array<CustomDashboardPage>;
44
+ /**
45
+ *
46
+ * @type {Array<CustomDashboardExecutionParameter>}
47
+ * @memberof CustomDashboard
48
+ */
49
+ parameters?: Array<CustomDashboardExecutionParameter>;
43
50
  }
44
51
  /**
45
52
  * Check if a given object implements the CustomDashboard interface.
@@ -15,6 +15,7 @@
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.CustomDashboardToJSON = exports.CustomDashboardFromJSONTyped = exports.CustomDashboardFromJSON = exports.instanceOfCustomDashboard = void 0;
17
17
  var runtime_1 = require("../runtime");
18
+ var CustomDashboardExecutionParameter_1 = require("./CustomDashboardExecutionParameter");
18
19
  var CustomDashboardPage_1 = require("./CustomDashboardPage");
19
20
  /**
20
21
  * Check if a given object implements the CustomDashboard interface.
@@ -37,6 +38,7 @@ function CustomDashboardFromJSONTyped(json, ignoreDiscriminator) {
37
38
  'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
38
39
  'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
39
40
  'pages': !(0, runtime_1.exists)(json, 'pages') ? undefined : (json['pages'].map(CustomDashboardPage_1.CustomDashboardPageFromJSON)),
41
+ 'parameters': !(0, runtime_1.exists)(json, 'parameters') ? undefined : (json['parameters'].map(CustomDashboardExecutionParameter_1.CustomDashboardExecutionParameterFromJSON)),
40
42
  };
41
43
  }
42
44
  exports.CustomDashboardFromJSONTyped = CustomDashboardFromJSONTyped;
@@ -52,6 +54,7 @@ function CustomDashboardToJSON(value) {
52
54
  'merchant_id': value.merchant_id,
53
55
  'name': value.name,
54
56
  'pages': value.pages === undefined ? undefined : (value.pages.map(CustomDashboardPage_1.CustomDashboardPageToJSON)),
57
+ 'parameters': value.parameters === undefined ? undefined : (value.parameters.map(CustomDashboardExecutionParameter_1.CustomDashboardExecutionParameterToJSON)),
55
58
  };
56
59
  }
57
60
  exports.CustomDashboardToJSON = CustomDashboardToJSON;
@@ -0,0 +1,49 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface CustomDashboardExecutionParameter
16
+ */
17
+ export interface CustomDashboardExecutionParameter {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof CustomDashboardExecutionParameter
22
+ */
23
+ name?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof CustomDashboardExecutionParameter
28
+ */
29
+ quick_pick_key?: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof CustomDashboardExecutionParameter
34
+ */
35
+ type?: string;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof CustomDashboardExecutionParameter
40
+ */
41
+ value?: string;
42
+ }
43
+ /**
44
+ * Check if a given object implements the CustomDashboardExecutionParameter interface.
45
+ */
46
+ export declare function instanceOfCustomDashboardExecutionParameter(value: object): boolean;
47
+ export declare function CustomDashboardExecutionParameterFromJSON(json: any): CustomDashboardExecutionParameter;
48
+ export declare function CustomDashboardExecutionParameterFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomDashboardExecutionParameter;
49
+ export declare function CustomDashboardExecutionParameterToJSON(value?: CustomDashboardExecutionParameter | null): any;
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * UltraCart Rest API V2
6
+ * UltraCart REST API Version 2
7
+ *
8
+ * The version of the OpenAPI document: 2.0.0
9
+ * Contact: support@ultracart.com
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CustomDashboardExecutionParameterToJSON = exports.CustomDashboardExecutionParameterFromJSONTyped = exports.CustomDashboardExecutionParameterFromJSON = exports.instanceOfCustomDashboardExecutionParameter = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the CustomDashboardExecutionParameter interface.
20
+ */
21
+ function instanceOfCustomDashboardExecutionParameter(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfCustomDashboardExecutionParameter = instanceOfCustomDashboardExecutionParameter;
26
+ function CustomDashboardExecutionParameterFromJSON(json) {
27
+ return CustomDashboardExecutionParameterFromJSONTyped(json, false);
28
+ }
29
+ exports.CustomDashboardExecutionParameterFromJSON = CustomDashboardExecutionParameterFromJSON;
30
+ function CustomDashboardExecutionParameterFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
36
+ 'quick_pick_key': !(0, runtime_1.exists)(json, 'quick_pick_key') ? undefined : json['quick_pick_key'],
37
+ 'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
38
+ 'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
39
+ };
40
+ }
41
+ exports.CustomDashboardExecutionParameterFromJSONTyped = CustomDashboardExecutionParameterFromJSONTyped;
42
+ function CustomDashboardExecutionParameterToJSON(value) {
43
+ if (value === undefined) {
44
+ return undefined;
45
+ }
46
+ if (value === null) {
47
+ return null;
48
+ }
49
+ return {
50
+ 'name': value.name,
51
+ 'quick_pick_key': value.quick_pick_key,
52
+ 'type': value.type,
53
+ 'value': value.value,
54
+ };
55
+ }
56
+ exports.CustomDashboardExecutionParameterToJSON = CustomDashboardExecutionParameterToJSON;
@@ -21,6 +21,12 @@ export interface CustomReportExecutionParameter {
21
21
  * @memberof CustomReportExecutionParameter
22
22
  */
23
23
  name?: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof CustomReportExecutionParameter
28
+ */
29
+ quick_pick_key?: string;
24
30
  /**
25
31
  *
26
32
  * @type {string}
@@ -33,6 +33,7 @@ function CustomReportExecutionParameterFromJSONTyped(json, ignoreDiscriminator)
33
33
  }
34
34
  return {
35
35
  'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
36
+ 'quick_pick_key': !(0, runtime_1.exists)(json, 'quick_pick_key') ? undefined : json['quick_pick_key'],
36
37
  'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
37
38
  'value': !(0, runtime_1.exists)(json, 'value') ? undefined : json['value'],
38
39
  };
@@ -47,6 +48,7 @@ function CustomReportExecutionParameterToJSON(value) {
47
48
  }
48
49
  return {
49
50
  'name': value.name,
51
+ 'quick_pick_key': value.quick_pick_key,
50
52
  'type': value.type,
51
53
  'value': value.value,
52
54
  };
@@ -222,6 +222,7 @@ export * from './ConversationVirtualAgentBudget';
222
222
  export * from './ConversationVirtualAgentBudgetResponse';
223
223
  export * from './ConversationVirtualAgentCapabilities';
224
224
  export * from './ConversationVirtualAgentCapabilitiesResponse';
225
+ export * from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
225
226
  export * from './ConversationWebchatContext';
226
227
  export * from './ConversationWebchatQueueStatus';
227
228
  export * from './ConversationWebchatQueueStatusAgent';
@@ -303,6 +304,7 @@ export * from './CouponsRequest';
303
304
  export * from './CouponsResponse';
304
305
  export * from './Currency';
305
306
  export * from './CustomDashboard';
307
+ export * from './CustomDashboardExecutionParameter';
306
308
  export * from './CustomDashboardPage';
307
309
  export * from './CustomDashboardPageReport';
308
310
  export * from './CustomDashboardResponse';
@@ -240,6 +240,7 @@ __exportStar(require("./ConversationVirtualAgentBudget"), exports);
240
240
  __exportStar(require("./ConversationVirtualAgentBudgetResponse"), exports);
241
241
  __exportStar(require("./ConversationVirtualAgentCapabilities"), exports);
242
242
  __exportStar(require("./ConversationVirtualAgentCapabilitiesResponse"), exports);
243
+ __exportStar(require("./ConversationVirtualAgentCapabilityZohoDeskDepartment"), exports);
243
244
  __exportStar(require("./ConversationWebchatContext"), exports);
244
245
  __exportStar(require("./ConversationWebchatQueueStatus"), exports);
245
246
  __exportStar(require("./ConversationWebchatQueueStatusAgent"), exports);
@@ -321,6 +322,7 @@ __exportStar(require("./CouponsRequest"), exports);
321
322
  __exportStar(require("./CouponsResponse"), exports);
322
323
  __exportStar(require("./Currency"), exports);
323
324
  __exportStar(require("./CustomDashboard"), exports);
325
+ __exportStar(require("./CustomDashboardExecutionParameter"), exports);
324
326
  __exportStar(require("./CustomDashboardPage"), exports);
325
327
  __exportStar(require("./CustomDashboardPageReport"), exports);
326
328
  __exportStar(require("./CustomDashboardResponse"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.1.18",
3
+ "version": "4.1.19",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -13,6 +13,13 @@
13
13
  */
14
14
 
15
15
  import { exists, mapValues } from '../runtime';
16
+ import {
17
+ ConversationVirtualAgentCapabilityZohoDeskDepartment,
18
+ ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON,
19
+ ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped,
20
+ ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON,
21
+ } from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
22
+
16
23
  /**
17
24
  *
18
25
  * @export
@@ -61,6 +68,12 @@ export interface ConversationVirtualAgentCapabilities {
61
68
  * @memberof ConversationVirtualAgentCapabilities
62
69
  */
63
70
  open_support_ticket_channel_email?: string;
71
+ /**
72
+ * Department ID to open a Zoho Desk ticket for
73
+ * @type {string}
74
+ * @memberof ConversationVirtualAgentCapabilities
75
+ */
76
+ open_support_ticket_zoho_desk_department_id?: string;
64
77
  /**
65
78
  *
66
79
  * @type {boolean}
@@ -85,6 +98,18 @@ export interface ConversationVirtualAgentCapabilities {
85
98
  * @memberof ConversationVirtualAgentCapabilities
86
99
  */
87
100
  update_subscription_credit_card?: boolean;
101
+ /**
102
+ * True if Zoho Desk is connected to UltraCart
103
+ * @type {boolean}
104
+ * @memberof ConversationVirtualAgentCapabilities
105
+ */
106
+ zoho_desk_available?: boolean;
107
+ /**
108
+ * Array of Zoho Desk Department if zoho desk is connected to UltraCart
109
+ * @type {Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>}
110
+ * @memberof ConversationVirtualAgentCapabilities
111
+ */
112
+ zoho_desk_departments?: Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>;
88
113
  }
89
114
 
90
115
 
@@ -95,8 +120,8 @@ export interface ConversationVirtualAgentCapabilities {
95
120
  export const ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum = {
96
121
  None: 'none',
97
122
  Email: 'email',
98
- UltraCartTask: 'UltraCart Task',
99
- ZohoDeskTicket: 'Zoho Desk Ticket'
123
+ UltracartTask: 'ultracart_task',
124
+ ZohoDeskTicket: 'zoho_desk_ticket'
100
125
  } as const;
101
126
  export type ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum = typeof ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum[keyof typeof ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum];
102
127
 
@@ -127,10 +152,13 @@ export function ConversationVirtualAgentCapabilitiesFromJSONTyped(json: any, ign
127
152
  'open_support_ticket': !exists(json, 'open_support_ticket') ? undefined : json['open_support_ticket'],
128
153
  'open_support_ticket_channel': !exists(json, 'open_support_ticket_channel') ? undefined : json['open_support_ticket_channel'],
129
154
  'open_support_ticket_channel_email': !exists(json, 'open_support_ticket_channel_email') ? undefined : json['open_support_ticket_channel_email'],
155
+ 'open_support_ticket_zoho_desk_department_id': !exists(json, 'open_support_ticket_zoho_desk_department_id') ? undefined : json['open_support_ticket_zoho_desk_department_id'],
130
156
  'pause_subscription': !exists(json, 'pause_subscription') ? undefined : json['pause_subscription'],
131
157
  'resume_subscription': !exists(json, 'resume_subscription') ? undefined : json['resume_subscription'],
132
158
  'transfer_chat_to_live_agent': !exists(json, 'transfer_chat_to_live_agent') ? undefined : json['transfer_chat_to_live_agent'],
133
159
  'update_subscription_credit_card': !exists(json, 'update_subscription_credit_card') ? undefined : json['update_subscription_credit_card'],
160
+ 'zoho_desk_available': !exists(json, 'zoho_desk_available') ? undefined : json['zoho_desk_available'],
161
+ 'zoho_desk_departments': !exists(json, 'zoho_desk_departments') ? undefined : ((json['zoho_desk_departments'] as Array<any>).map(ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON)),
134
162
  };
135
163
  }
136
164
 
@@ -150,10 +178,13 @@ export function ConversationVirtualAgentCapabilitiesToJSON(value?: ConversationV
150
178
  'open_support_ticket': value.open_support_ticket,
151
179
  'open_support_ticket_channel': value.open_support_ticket_channel,
152
180
  'open_support_ticket_channel_email': value.open_support_ticket_channel_email,
181
+ 'open_support_ticket_zoho_desk_department_id': value.open_support_ticket_zoho_desk_department_id,
153
182
  'pause_subscription': value.pause_subscription,
154
183
  'resume_subscription': value.resume_subscription,
155
184
  'transfer_chat_to_live_agent': value.transfer_chat_to_live_agent,
156
185
  'update_subscription_credit_card': value.update_subscription_credit_card,
186
+ 'zoho_desk_available': value.zoho_desk_available,
187
+ 'zoho_desk_departments': value.zoho_desk_departments === undefined ? undefined : ((value.zoho_desk_departments as Array<any>).map(ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON)),
157
188
  };
158
189
  }
159
190
 
@@ -0,0 +1,75 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ConversationVirtualAgentCapabilityZohoDeskDepartment
20
+ */
21
+ export interface ConversationVirtualAgentCapabilityZohoDeskDepartment {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
26
+ */
27
+ department_id?: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof ConversationVirtualAgentCapabilityZohoDeskDepartment
32
+ */
33
+ department_name?: string;
34
+ }
35
+
36
+
37
+
38
+ /**
39
+ * Check if a given object implements the ConversationVirtualAgentCapabilityZohoDeskDepartment interface.
40
+ */
41
+ export function instanceOfConversationVirtualAgentCapabilityZohoDeskDepartment(value: object): boolean {
42
+ let isInstance = true;
43
+
44
+ return isInstance;
45
+ }
46
+
47
+ export function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON(json: any): ConversationVirtualAgentCapabilityZohoDeskDepartment {
48
+ return ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped(json, false);
49
+ }
50
+
51
+ export function ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentCapabilityZohoDeskDepartment {
52
+ if ((json === undefined) || (json === null)) {
53
+ return json;
54
+ }
55
+ return {
56
+
57
+ 'department_id': !exists(json, 'department_id') ? undefined : json['department_id'],
58
+ 'department_name': !exists(json, 'department_name') ? undefined : json['department_name'],
59
+ };
60
+ }
61
+
62
+ export function ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON(value?: ConversationVirtualAgentCapabilityZohoDeskDepartment | null): any {
63
+ if (value === undefined) {
64
+ return undefined;
65
+ }
66
+ if (value === null) {
67
+ return null;
68
+ }
69
+ return {
70
+
71
+ 'department_id': value.department_id,
72
+ 'department_name': value.department_name,
73
+ };
74
+ }
75
+
@@ -13,6 +13,12 @@
13
13
  */
14
14
 
15
15
  import { exists, mapValues } from '../runtime';
16
+ import {
17
+ CustomDashboardExecutionParameter,
18
+ CustomDashboardExecutionParameterFromJSON,
19
+ CustomDashboardExecutionParameterFromJSONTyped,
20
+ CustomDashboardExecutionParameterToJSON,
21
+ } from './CustomDashboardExecutionParameter';
16
22
  import {
17
23
  CustomDashboardPage,
18
24
  CustomDashboardPageFromJSON,
@@ -50,6 +56,12 @@ export interface CustomDashboard {
50
56
  * @memberof CustomDashboard
51
57
  */
52
58
  pages?: Array<CustomDashboardPage>;
59
+ /**
60
+ *
61
+ * @type {Array<CustomDashboardExecutionParameter>}
62
+ * @memberof CustomDashboard
63
+ */
64
+ parameters?: Array<CustomDashboardExecutionParameter>;
53
65
  }
54
66
 
55
67
 
@@ -77,6 +89,7 @@ export function CustomDashboardFromJSONTyped(json: any, ignoreDiscriminator: boo
77
89
  'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
78
90
  'name': !exists(json, 'name') ? undefined : json['name'],
79
91
  'pages': !exists(json, 'pages') ? undefined : ((json['pages'] as Array<any>).map(CustomDashboardPageFromJSON)),
92
+ 'parameters': !exists(json, 'parameters') ? undefined : ((json['parameters'] as Array<any>).map(CustomDashboardExecutionParameterFromJSON)),
80
93
  };
81
94
  }
82
95
 
@@ -93,6 +106,7 @@ export function CustomDashboardToJSON(value?: CustomDashboard | null): any {
93
106
  'merchant_id': value.merchant_id,
94
107
  'name': value.name,
95
108
  'pages': value.pages === undefined ? undefined : ((value.pages as Array<any>).map(CustomDashboardPageToJSON)),
109
+ 'parameters': value.parameters === undefined ? undefined : ((value.parameters as Array<any>).map(CustomDashboardExecutionParameterToJSON)),
96
110
  };
97
111
  }
98
112
 
@@ -0,0 +1,91 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * UltraCart Rest API V2
5
+ * UltraCart REST API Version 2
6
+ *
7
+ * The version of the OpenAPI document: 2.0.0
8
+ * Contact: support@ultracart.com
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { exists, mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface CustomDashboardExecutionParameter
20
+ */
21
+ export interface CustomDashboardExecutionParameter {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof CustomDashboardExecutionParameter
26
+ */
27
+ name?: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof CustomDashboardExecutionParameter
32
+ */
33
+ quick_pick_key?: string;
34
+ /**
35
+ *
36
+ * @type {string}
37
+ * @memberof CustomDashboardExecutionParameter
38
+ */
39
+ type?: string;
40
+ /**
41
+ *
42
+ * @type {string}
43
+ * @memberof CustomDashboardExecutionParameter
44
+ */
45
+ value?: string;
46
+ }
47
+
48
+
49
+
50
+ /**
51
+ * Check if a given object implements the CustomDashboardExecutionParameter interface.
52
+ */
53
+ export function instanceOfCustomDashboardExecutionParameter(value: object): boolean {
54
+ let isInstance = true;
55
+
56
+ return isInstance;
57
+ }
58
+
59
+ export function CustomDashboardExecutionParameterFromJSON(json: any): CustomDashboardExecutionParameter {
60
+ return CustomDashboardExecutionParameterFromJSONTyped(json, false);
61
+ }
62
+
63
+ export function CustomDashboardExecutionParameterFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomDashboardExecutionParameter {
64
+ if ((json === undefined) || (json === null)) {
65
+ return json;
66
+ }
67
+ return {
68
+
69
+ 'name': !exists(json, 'name') ? undefined : json['name'],
70
+ 'quick_pick_key': !exists(json, 'quick_pick_key') ? undefined : json['quick_pick_key'],
71
+ 'type': !exists(json, 'type') ? undefined : json['type'],
72
+ 'value': !exists(json, 'value') ? undefined : json['value'],
73
+ };
74
+ }
75
+
76
+ export function CustomDashboardExecutionParameterToJSON(value?: CustomDashboardExecutionParameter | null): any {
77
+ if (value === undefined) {
78
+ return undefined;
79
+ }
80
+ if (value === null) {
81
+ return null;
82
+ }
83
+ return {
84
+
85
+ 'name': value.name,
86
+ 'quick_pick_key': value.quick_pick_key,
87
+ 'type': value.type,
88
+ 'value': value.value,
89
+ };
90
+ }
91
+
@@ -25,6 +25,12 @@ export interface CustomReportExecutionParameter {
25
25
  * @memberof CustomReportExecutionParameter
26
26
  */
27
27
  name?: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof CustomReportExecutionParameter
32
+ */
33
+ quick_pick_key?: string;
28
34
  /**
29
35
  *
30
36
  * @type {string}
@@ -61,6 +67,7 @@ export function CustomReportExecutionParameterFromJSONTyped(json: any, ignoreDis
61
67
  return {
62
68
 
63
69
  'name': !exists(json, 'name') ? undefined : json['name'],
70
+ 'quick_pick_key': !exists(json, 'quick_pick_key') ? undefined : json['quick_pick_key'],
64
71
  'type': !exists(json, 'type') ? undefined : json['type'],
65
72
  'value': !exists(json, 'value') ? undefined : json['value'],
66
73
  };
@@ -76,6 +83,7 @@ export function CustomReportExecutionParameterToJSON(value?: CustomReportExecuti
76
83
  return {
77
84
 
78
85
  'name': value.name,
86
+ 'quick_pick_key': value.quick_pick_key,
79
87
  'type': value.type,
80
88
  'value': value.value,
81
89
  };
@@ -224,6 +224,7 @@ export * from './ConversationVirtualAgentBudget';
224
224
  export * from './ConversationVirtualAgentBudgetResponse';
225
225
  export * from './ConversationVirtualAgentCapabilities';
226
226
  export * from './ConversationVirtualAgentCapabilitiesResponse';
227
+ export * from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
227
228
  export * from './ConversationWebchatContext';
228
229
  export * from './ConversationWebchatQueueStatus';
229
230
  export * from './ConversationWebchatQueueStatusAgent';
@@ -305,6 +306,7 @@ export * from './CouponsRequest';
305
306
  export * from './CouponsResponse';
306
307
  export * from './Currency';
307
308
  export * from './CustomDashboard';
309
+ export * from './CustomDashboardExecutionParameter';
308
310
  export * from './CustomDashboardPage';
309
311
  export * from './CustomDashboardPageReport';
310
312
  export * from './CustomDashboardResponse';