ultracart_rest_api_v2_typescript 4.1.11 → 4.1.13

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.
@@ -247,6 +247,8 @@ src/models/ConversationSummary.ts
247
247
  src/models/ConversationTwilioAccount.ts
248
248
  src/models/ConversationVirtualAgentBudget.ts
249
249
  src/models/ConversationVirtualAgentBudgetResponse.ts
250
+ src/models/ConversationVirtualAgentCapabilities.ts
251
+ src/models/ConversationVirtualAgentCapabilitiesResponse.ts
250
252
  src/models/ConversationWebchatContext.ts
251
253
  src/models/ConversationWebchatQueueStatus.ts
252
254
  src/models/ConversationWebchatQueueStatusAgent.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.11
2
+ ## ultracart_rest_api_v2_typescript@4.1.13
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.11 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.13 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -83,6 +83,8 @@ Not every change is committed to every SDK.
83
83
 
84
84
  | Version | Date | Comments |
85
85
  | --: | :-: | --- |
86
+ | 4.1.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |
87
+ | 4.1.12 | 05/19/2025 | conversations - AI agent capabilities method |
86
88
  | 4.1.11 | 05/19/2025 | conversations - virtual AI budgets |
87
89
  | 4.1.10 | 05/06/2025 | conversation - ConversationAgentProfile.user_id added for agent profiles call |
88
90
  | 4.1.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationJoinRequest, ConversationLocationsResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
13
+ import { ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationJoinRequest, ConversationLocationsResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
14
14
  export interface DeleteConversationCannedMessageRequest {
15
15
  conversationCannedMessageOid: number;
16
16
  }
@@ -228,6 +228,9 @@ export interface UpdatePbxVoicemailMailboxRequest {
228
228
  export interface UpdateVirtualAgentBudgetRequest {
229
229
  virtualAgentBudget: ConversationVirtualAgentBudget;
230
230
  }
231
+ export interface UpdateVirtualAgentCapabilitiesRequest {
232
+ virtualAgentCapabilities: ConversationVirtualAgentCapabilities;
233
+ }
231
234
  /**
232
235
  * ConversationApi - interface
233
236
  *
@@ -978,6 +981,19 @@ export interface ConversationApiInterface {
978
981
  * Get virtual agent budget
979
982
  */
980
983
  getVirtualAgentBudget(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
984
+ /**
985
+ * Retrieve virtual agent capabilities
986
+ * @summary Get virtual agent capabilities
987
+ * @param {*} [options] Override http request option.
988
+ * @throws {RequiredError}
989
+ * @memberof ConversationApiInterface
990
+ */
991
+ getVirtualAgentCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentCapabilitiesResponse>>;
992
+ /**
993
+ * Retrieve virtual agent capabilities
994
+ * Get virtual agent capabilities
995
+ */
996
+ getVirtualAgentCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse>;
981
997
  /**
982
998
  * Insert a canned message
983
999
  * @summary Insert a canned message
@@ -1440,6 +1456,20 @@ export interface ConversationApiInterface {
1440
1456
  * Update virtual agent budget
1441
1457
  */
1442
1458
  updateVirtualAgentBudget(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
1459
+ /**
1460
+ * Update virtual agent capabilities
1461
+ * @summary Update virtual agent capabilities
1462
+ * @param {ConversationVirtualAgentCapabilities} virtualAgentCapabilities Virtual Agent Capabilities
1463
+ * @param {*} [options] Override http request option.
1464
+ * @throws {RequiredError}
1465
+ * @memberof ConversationApiInterface
1466
+ */
1467
+ updateVirtualAgentCapabilitiesRaw(requestParameters: UpdateVirtualAgentCapabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentCapabilitiesResponse>>;
1468
+ /**
1469
+ * Update virtual agent capabilities
1470
+ * Update virtual agent capabilities
1471
+ */
1472
+ updateVirtualAgentCapabilities(requestParameters: UpdateVirtualAgentCapabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse>;
1443
1473
  }
1444
1474
  /**
1445
1475
  *
@@ -1985,6 +2015,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
1985
2015
  * Get virtual agent budget
1986
2016
  */
1987
2017
  getVirtualAgentBudget(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
2018
+ /**
2019
+ * Retrieve virtual agent capabilities
2020
+ * Get virtual agent capabilities
2021
+ */
2022
+ getVirtualAgentCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentCapabilitiesResponse>>;
2023
+ /**
2024
+ * Retrieve virtual agent capabilities
2025
+ * Get virtual agent capabilities
2026
+ */
2027
+ getVirtualAgentCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse>;
1988
2028
  /**
1989
2029
  * Insert a canned message
1990
2030
  * Insert a canned message
@@ -2305,4 +2345,14 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2305
2345
  * Update virtual agent budget
2306
2346
  */
2307
2347
  updateVirtualAgentBudget(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
2348
+ /**
2349
+ * Update virtual agent capabilities
2350
+ * Update virtual agent capabilities
2351
+ */
2352
+ updateVirtualAgentCapabilitiesRaw(requestParameters: UpdateVirtualAgentCapabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentCapabilitiesResponse>>;
2353
+ /**
2354
+ * Update virtual agent capabilities
2355
+ * Update virtual agent capabilities
2356
+ */
2357
+ updateVirtualAgentCapabilities(requestParameters: UpdateVirtualAgentCapabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse>;
2308
2358
  }
@@ -3217,6 +3217,62 @@ var ConversationApi = /** @class */ (function (_super) {
3217
3217
  });
3218
3218
  });
3219
3219
  };
3220
+ /**
3221
+ * Retrieve virtual agent capabilities
3222
+ * Get virtual agent capabilities
3223
+ */
3224
+ ConversationApi.prototype.getVirtualAgentCapabilitiesRaw = function (initOverrides) {
3225
+ return __awaiter(this, void 0, void 0, function () {
3226
+ var queryParameters, headerParameters, _a, _b, response;
3227
+ return __generator(this, function (_c) {
3228
+ switch (_c.label) {
3229
+ case 0:
3230
+ queryParameters = {};
3231
+ headerParameters = {};
3232
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
3233
+ // oauth required
3234
+ _a = headerParameters;
3235
+ _b = "Authorization";
3236
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_read"])];
3237
+ case 1:
3238
+ // oauth required
3239
+ _a[_b] = _c.sent();
3240
+ _c.label = 2;
3241
+ case 2:
3242
+ if (this.configuration && this.configuration.apiKey) {
3243
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
3244
+ }
3245
+ return [4 /*yield*/, this.request({
3246
+ path: "/conversation/virtualagent/capabilities",
3247
+ method: 'GET',
3248
+ headers: headerParameters,
3249
+ query: queryParameters,
3250
+ }, initOverrides)];
3251
+ case 3:
3252
+ response = _c.sent();
3253
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationVirtualAgentCapabilitiesResponseFromJSON)(jsonValue); })];
3254
+ }
3255
+ });
3256
+ });
3257
+ };
3258
+ /**
3259
+ * Retrieve virtual agent capabilities
3260
+ * Get virtual agent capabilities
3261
+ */
3262
+ ConversationApi.prototype.getVirtualAgentCapabilities = function (initOverrides) {
3263
+ return __awaiter(this, void 0, void 0, function () {
3264
+ var response;
3265
+ return __generator(this, function (_a) {
3266
+ switch (_a.label) {
3267
+ case 0: return [4 /*yield*/, this.getVirtualAgentCapabilitiesRaw(initOverrides)];
3268
+ case 1:
3269
+ response = _a.sent();
3270
+ return [4 /*yield*/, response.value()];
3271
+ case 2: return [2 /*return*/, _a.sent()];
3272
+ }
3273
+ });
3274
+ });
3275
+ };
3220
3276
  /**
3221
3277
  * Insert a canned message
3222
3278
  * Insert a canned message
@@ -5180,6 +5236,67 @@ var ConversationApi = /** @class */ (function (_super) {
5180
5236
  });
5181
5237
  });
5182
5238
  };
5239
+ /**
5240
+ * Update virtual agent capabilities
5241
+ * Update virtual agent capabilities
5242
+ */
5243
+ ConversationApi.prototype.updateVirtualAgentCapabilitiesRaw = function (requestParameters, initOverrides) {
5244
+ return __awaiter(this, void 0, void 0, function () {
5245
+ var queryParameters, headerParameters, _a, _b, response;
5246
+ return __generator(this, function (_c) {
5247
+ switch (_c.label) {
5248
+ case 0:
5249
+ if (requestParameters.virtualAgentCapabilities === null || requestParameters.virtualAgentCapabilities === undefined) {
5250
+ throw new runtime.RequiredError('virtualAgentCapabilities', 'Required parameter requestParameters.virtualAgentCapabilities was null or undefined when calling updateVirtualAgentCapabilities.');
5251
+ }
5252
+ queryParameters = {};
5253
+ headerParameters = {};
5254
+ headerParameters['Content-Type'] = 'application/json';
5255
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
5256
+ // oauth required
5257
+ _a = headerParameters;
5258
+ _b = "Authorization";
5259
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
5260
+ case 1:
5261
+ // oauth required
5262
+ _a[_b] = _c.sent();
5263
+ _c.label = 2;
5264
+ case 2:
5265
+ if (this.configuration && this.configuration.apiKey) {
5266
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
5267
+ }
5268
+ return [4 /*yield*/, this.request({
5269
+ path: "/conversation/virtualagent/capabilities",
5270
+ method: 'PUT',
5271
+ headers: headerParameters,
5272
+ query: queryParameters,
5273
+ body: (0, models_1.ConversationVirtualAgentCapabilitiesToJSON)(requestParameters.virtualAgentCapabilities),
5274
+ }, initOverrides)];
5275
+ case 3:
5276
+ response = _c.sent();
5277
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationVirtualAgentCapabilitiesResponseFromJSON)(jsonValue); })];
5278
+ }
5279
+ });
5280
+ });
5281
+ };
5282
+ /**
5283
+ * Update virtual agent capabilities
5284
+ * Update virtual agent capabilities
5285
+ */
5286
+ ConversationApi.prototype.updateVirtualAgentCapabilities = function (requestParameters, initOverrides) {
5287
+ return __awaiter(this, void 0, void 0, function () {
5288
+ var response;
5289
+ return __generator(this, function (_a) {
5290
+ switch (_a.label) {
5291
+ case 0: return [4 /*yield*/, this.updateVirtualAgentCapabilitiesRaw(requestParameters, initOverrides)];
5292
+ case 1:
5293
+ response = _a.sent();
5294
+ return [4 /*yield*/, response.value()];
5295
+ case 2: return [2 /*return*/, _a.sent()];
5296
+ }
5297
+ });
5298
+ });
5299
+ };
5183
5300
  return ConversationApi;
5184
5301
  }(runtime.BaseAPI));
5185
5302
  exports.ConversationApi = ConversationApi;
@@ -126,6 +126,18 @@ export interface Conversation {
126
126
  * @memberof Conversation
127
127
  */
128
128
  unread_messages?: boolean;
129
+ /**
130
+ * True if a virtual agent answered the conversation
131
+ * @type {boolean}
132
+ * @memberof Conversation
133
+ */
134
+ virtual_agent?: boolean;
135
+ /**
136
+ * The cost of this conversation performed by the virtual agent
137
+ * @type {number}
138
+ * @memberof Conversation
139
+ */
140
+ virtual_agent_cost?: number;
129
141
  /**
130
142
  *
131
143
  * @type {boolean}
@@ -60,6 +60,8 @@ function ConversationFromJSONTyped(json, ignoreDiscriminator) {
60
60
  'sentiment': !(0, runtime_1.exists)(json, 'sentiment') ? undefined : (0, ConversationSentiment_1.ConversationSentimentFromJSON)(json['sentiment']),
61
61
  'start_dts': !(0, runtime_1.exists)(json, 'start_dts') ? undefined : json['start_dts'],
62
62
  'unread_messages': !(0, runtime_1.exists)(json, 'unread_messages') ? undefined : json['unread_messages'],
63
+ 'virtual_agent': !(0, runtime_1.exists)(json, 'virtual_agent') ? undefined : json['virtual_agent'],
64
+ 'virtual_agent_cost': !(0, runtime_1.exists)(json, 'virtual_agent_cost') ? undefined : json['virtual_agent_cost'],
63
65
  'visible': !(0, runtime_1.exists)(json, 'visible') ? undefined : json['visible'],
64
66
  };
65
67
  }
@@ -90,6 +92,8 @@ function ConversationToJSON(value) {
90
92
  'sentiment': (0, ConversationSentiment_1.ConversationSentimentToJSON)(value.sentiment),
91
93
  'start_dts': value.start_dts,
92
94
  'unread_messages': value.unread_messages,
95
+ 'virtual_agent': value.virtual_agent,
96
+ 'virtual_agent_cost': value.virtual_agent_cost,
93
97
  'visible': value.visible,
94
98
  };
95
99
  }
@@ -0,0 +1,79 @@
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 ConversationVirtualAgentCapabilities
16
+ */
17
+ export interface ConversationVirtualAgentCapabilities {
18
+ /**
19
+ *
20
+ * @type {boolean}
21
+ * @memberof ConversationVirtualAgentCapabilities
22
+ */
23
+ cancel_subscription?: boolean;
24
+ /**
25
+ *
26
+ * @type {boolean}
27
+ * @memberof ConversationVirtualAgentCapabilities
28
+ */
29
+ delay_subscription?: boolean;
30
+ /**
31
+ *
32
+ * @type {boolean}
33
+ * @memberof ConversationVirtualAgentCapabilities
34
+ */
35
+ lookup_order_information?: boolean;
36
+ /**
37
+ *
38
+ * @type {boolean}
39
+ * @memberof ConversationVirtualAgentCapabilities
40
+ */
41
+ lookup_subscription_information?: boolean;
42
+ /**
43
+ *
44
+ * @type {boolean}
45
+ * @memberof ConversationVirtualAgentCapabilities
46
+ */
47
+ open_support_ticket?: boolean;
48
+ /**
49
+ *
50
+ * @type {boolean}
51
+ * @memberof ConversationVirtualAgentCapabilities
52
+ */
53
+ pause_subscription?: boolean;
54
+ /**
55
+ *
56
+ * @type {boolean}
57
+ * @memberof ConversationVirtualAgentCapabilities
58
+ */
59
+ resume_subscription?: boolean;
60
+ /**
61
+ *
62
+ * @type {boolean}
63
+ * @memberof ConversationVirtualAgentCapabilities
64
+ */
65
+ transfer_chat_to_live_agent?: boolean;
66
+ /**
67
+ *
68
+ * @type {boolean}
69
+ * @memberof ConversationVirtualAgentCapabilities
70
+ */
71
+ update_subscription_credit_card?: boolean;
72
+ }
73
+ /**
74
+ * Check if a given object implements the ConversationVirtualAgentCapabilities interface.
75
+ */
76
+ export declare function instanceOfConversationVirtualAgentCapabilities(value: object): boolean;
77
+ export declare function ConversationVirtualAgentCapabilitiesFromJSON(json: any): ConversationVirtualAgentCapabilities;
78
+ export declare function ConversationVirtualAgentCapabilitiesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentCapabilities;
79
+ export declare function ConversationVirtualAgentCapabilitiesToJSON(value?: ConversationVirtualAgentCapabilities | null): any;
@@ -0,0 +1,66 @@
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.ConversationVirtualAgentCapabilitiesToJSON = exports.ConversationVirtualAgentCapabilitiesFromJSONTyped = exports.ConversationVirtualAgentCapabilitiesFromJSON = exports.instanceOfConversationVirtualAgentCapabilities = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the ConversationVirtualAgentCapabilities interface.
20
+ */
21
+ function instanceOfConversationVirtualAgentCapabilities(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfConversationVirtualAgentCapabilities = instanceOfConversationVirtualAgentCapabilities;
26
+ function ConversationVirtualAgentCapabilitiesFromJSON(json) {
27
+ return ConversationVirtualAgentCapabilitiesFromJSONTyped(json, false);
28
+ }
29
+ exports.ConversationVirtualAgentCapabilitiesFromJSON = ConversationVirtualAgentCapabilitiesFromJSON;
30
+ function ConversationVirtualAgentCapabilitiesFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'cancel_subscription': !(0, runtime_1.exists)(json, 'cancel_subscription') ? undefined : json['cancel_subscription'],
36
+ 'delay_subscription': !(0, runtime_1.exists)(json, 'delay_subscription') ? undefined : json['delay_subscription'],
37
+ 'lookup_order_information': !(0, runtime_1.exists)(json, 'lookup_order_information') ? undefined : json['lookup_order_information'],
38
+ 'lookup_subscription_information': !(0, runtime_1.exists)(json, 'lookup_subscription_information') ? undefined : json['lookup_subscription_information'],
39
+ 'open_support_ticket': !(0, runtime_1.exists)(json, 'open_support_ticket') ? undefined : json['open_support_ticket'],
40
+ 'pause_subscription': !(0, runtime_1.exists)(json, 'pause_subscription') ? undefined : json['pause_subscription'],
41
+ 'resume_subscription': !(0, runtime_1.exists)(json, 'resume_subscription') ? undefined : json['resume_subscription'],
42
+ 'transfer_chat_to_live_agent': !(0, runtime_1.exists)(json, 'transfer_chat_to_live_agent') ? undefined : json['transfer_chat_to_live_agent'],
43
+ 'update_subscription_credit_card': !(0, runtime_1.exists)(json, 'update_subscription_credit_card') ? undefined : json['update_subscription_credit_card'],
44
+ };
45
+ }
46
+ exports.ConversationVirtualAgentCapabilitiesFromJSONTyped = ConversationVirtualAgentCapabilitiesFromJSONTyped;
47
+ function ConversationVirtualAgentCapabilitiesToJSON(value) {
48
+ if (value === undefined) {
49
+ return undefined;
50
+ }
51
+ if (value === null) {
52
+ return null;
53
+ }
54
+ return {
55
+ 'cancel_subscription': value.cancel_subscription,
56
+ 'delay_subscription': value.delay_subscription,
57
+ 'lookup_order_information': value.lookup_order_information,
58
+ 'lookup_subscription_information': value.lookup_subscription_information,
59
+ 'open_support_ticket': value.open_support_ticket,
60
+ 'pause_subscription': value.pause_subscription,
61
+ 'resume_subscription': value.resume_subscription,
62
+ 'transfer_chat_to_live_agent': value.transfer_chat_to_live_agent,
63
+ 'update_subscription_credit_card': value.update_subscription_credit_card,
64
+ };
65
+ }
66
+ exports.ConversationVirtualAgentCapabilitiesToJSON = ConversationVirtualAgentCapabilitiesToJSON;
@@ -0,0 +1,59 @@
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
+ import { ConversationVirtualAgentCapabilities } from './ConversationVirtualAgentCapabilities';
13
+ import { ModelError } from './ModelError';
14
+ import { ResponseMetadata } from './ResponseMetadata';
15
+ import { Warning } from './Warning';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ConversationVirtualAgentCapabilitiesResponse
20
+ */
21
+ export interface ConversationVirtualAgentCapabilitiesResponse {
22
+ /**
23
+ *
24
+ * @type {ConversationVirtualAgentCapabilities}
25
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
26
+ */
27
+ capabilities?: ConversationVirtualAgentCapabilities;
28
+ /**
29
+ *
30
+ * @type {ModelError}
31
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
32
+ */
33
+ error?: ModelError;
34
+ /**
35
+ *
36
+ * @type {ResponseMetadata}
37
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
38
+ */
39
+ metadata?: ResponseMetadata;
40
+ /**
41
+ * Indicates if API call was successful
42
+ * @type {boolean}
43
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
44
+ */
45
+ success?: boolean;
46
+ /**
47
+ *
48
+ * @type {Warning}
49
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
50
+ */
51
+ warning?: Warning;
52
+ }
53
+ /**
54
+ * Check if a given object implements the ConversationVirtualAgentCapabilitiesResponse interface.
55
+ */
56
+ export declare function instanceOfConversationVirtualAgentCapabilitiesResponse(value: object): boolean;
57
+ export declare function ConversationVirtualAgentCapabilitiesResponseFromJSON(json: any): ConversationVirtualAgentCapabilitiesResponse;
58
+ export declare function ConversationVirtualAgentCapabilitiesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentCapabilitiesResponse;
59
+ export declare function ConversationVirtualAgentCapabilitiesResponseToJSON(value?: ConversationVirtualAgentCapabilitiesResponse | null): any;
@@ -0,0 +1,62 @@
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.ConversationVirtualAgentCapabilitiesResponseToJSON = exports.ConversationVirtualAgentCapabilitiesResponseFromJSONTyped = exports.ConversationVirtualAgentCapabilitiesResponseFromJSON = exports.instanceOfConversationVirtualAgentCapabilitiesResponse = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var ConversationVirtualAgentCapabilities_1 = require("./ConversationVirtualAgentCapabilities");
19
+ var ModelError_1 = require("./ModelError");
20
+ var ResponseMetadata_1 = require("./ResponseMetadata");
21
+ var Warning_1 = require("./Warning");
22
+ /**
23
+ * Check if a given object implements the ConversationVirtualAgentCapabilitiesResponse interface.
24
+ */
25
+ function instanceOfConversationVirtualAgentCapabilitiesResponse(value) {
26
+ var isInstance = true;
27
+ return isInstance;
28
+ }
29
+ exports.instanceOfConversationVirtualAgentCapabilitiesResponse = instanceOfConversationVirtualAgentCapabilitiesResponse;
30
+ function ConversationVirtualAgentCapabilitiesResponseFromJSON(json) {
31
+ return ConversationVirtualAgentCapabilitiesResponseFromJSONTyped(json, false);
32
+ }
33
+ exports.ConversationVirtualAgentCapabilitiesResponseFromJSON = ConversationVirtualAgentCapabilitiesResponseFromJSON;
34
+ function ConversationVirtualAgentCapabilitiesResponseFromJSONTyped(json, ignoreDiscriminator) {
35
+ if ((json === undefined) || (json === null)) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'capabilities': !(0, runtime_1.exists)(json, 'capabilities') ? undefined : (0, ConversationVirtualAgentCapabilities_1.ConversationVirtualAgentCapabilitiesFromJSON)(json['capabilities']),
40
+ 'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
41
+ 'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
42
+ 'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
43
+ 'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
44
+ };
45
+ }
46
+ exports.ConversationVirtualAgentCapabilitiesResponseFromJSONTyped = ConversationVirtualAgentCapabilitiesResponseFromJSONTyped;
47
+ function ConversationVirtualAgentCapabilitiesResponseToJSON(value) {
48
+ if (value === undefined) {
49
+ return undefined;
50
+ }
51
+ if (value === null) {
52
+ return null;
53
+ }
54
+ return {
55
+ 'capabilities': (0, ConversationVirtualAgentCapabilities_1.ConversationVirtualAgentCapabilitiesToJSON)(value.capabilities),
56
+ 'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
57
+ 'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
58
+ 'success': value.success,
59
+ 'warning': (0, Warning_1.WarningToJSON)(value.warning),
60
+ };
61
+ }
62
+ exports.ConversationVirtualAgentCapabilitiesResponseToJSON = ConversationVirtualAgentCapabilitiesResponseToJSON;
@@ -28,6 +28,12 @@ export interface ItemRestriction {
28
28
  * @memberof ItemRestriction
29
29
  */
30
30
  exclude_from_free_promotion?: boolean;
31
+ /**
32
+ * Exclude from loyalty. Must be set to true or false to save. Null is ignored for backwards SDK compatibility
33
+ * @type {boolean}
34
+ * @memberof ItemRestriction
35
+ */
36
+ exclude_from_loyalty?: boolean;
31
37
  /**
32
38
  * Items
33
39
  * @type {Array<ItemRestrictionItem>}
@@ -35,6 +35,7 @@ function ItemRestrictionFromJSONTyped(json, ignoreDiscriminator) {
35
35
  return {
36
36
  'exclude_coupon': !(0, runtime_1.exists)(json, 'exclude_coupon') ? undefined : json['exclude_coupon'],
37
37
  'exclude_from_free_promotion': !(0, runtime_1.exists)(json, 'exclude_from_free_promotion') ? undefined : json['exclude_from_free_promotion'],
38
+ 'exclude_from_loyalty': !(0, runtime_1.exists)(json, 'exclude_from_loyalty') ? undefined : json['exclude_from_loyalty'],
38
39
  'items': !(0, runtime_1.exists)(json, 'items') ? undefined : (json['items'].map(ItemRestrictionItem_1.ItemRestrictionItemFromJSON)),
39
40
  'maximum_quantity': !(0, runtime_1.exists)(json, 'maximum_quantity') ? undefined : json['maximum_quantity'],
40
41
  'minimum_quantity': !(0, runtime_1.exists)(json, 'minimum_quantity') ? undefined : json['minimum_quantity'],
@@ -54,6 +55,7 @@ function ItemRestrictionToJSON(value) {
54
55
  return {
55
56
  'exclude_coupon': value.exclude_coupon,
56
57
  'exclude_from_free_promotion': value.exclude_from_free_promotion,
58
+ 'exclude_from_loyalty': value.exclude_from_loyalty,
57
59
  'items': value.items === undefined ? undefined : (value.items.map(ItemRestrictionItem_1.ItemRestrictionItemToJSON)),
58
60
  'maximum_quantity': value.maximum_quantity,
59
61
  'minimum_quantity': value.minimum_quantity,
@@ -220,6 +220,8 @@ export * from './ConversationSummary';
220
220
  export * from './ConversationTwilioAccount';
221
221
  export * from './ConversationVirtualAgentBudget';
222
222
  export * from './ConversationVirtualAgentBudgetResponse';
223
+ export * from './ConversationVirtualAgentCapabilities';
224
+ export * from './ConversationVirtualAgentCapabilitiesResponse';
223
225
  export * from './ConversationWebchatContext';
224
226
  export * from './ConversationWebchatQueueStatus';
225
227
  export * from './ConversationWebchatQueueStatusAgent';
@@ -238,6 +238,8 @@ __exportStar(require("./ConversationSummary"), exports);
238
238
  __exportStar(require("./ConversationTwilioAccount"), exports);
239
239
  __exportStar(require("./ConversationVirtualAgentBudget"), exports);
240
240
  __exportStar(require("./ConversationVirtualAgentBudgetResponse"), exports);
241
+ __exportStar(require("./ConversationVirtualAgentCapabilities"), exports);
242
+ __exportStar(require("./ConversationVirtualAgentCapabilitiesResponse"), exports);
241
243
  __exportStar(require("./ConversationWebchatContext"), exports);
242
244
  __exportStar(require("./ConversationWebchatQueueStatus"), exports);
243
245
  __exportStar(require("./ConversationWebchatQueueStatusAgent"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ultracart_rest_api_v2_typescript",
3
- "version": "4.1.11",
3
+ "version": "4.1.13",
4
4
  "description": "UltraCart Rest TypeScript SDK",
5
5
  "author": "UltraCart",
6
6
  "repository": {
@@ -192,6 +192,12 @@ import {
192
192
  ConversationVirtualAgentBudgetResponse,
193
193
  ConversationVirtualAgentBudgetResponseFromJSON,
194
194
  ConversationVirtualAgentBudgetResponseToJSON,
195
+ ConversationVirtualAgentCapabilities,
196
+ ConversationVirtualAgentCapabilitiesFromJSON,
197
+ ConversationVirtualAgentCapabilitiesToJSON,
198
+ ConversationVirtualAgentCapabilitiesResponse,
199
+ ConversationVirtualAgentCapabilitiesResponseFromJSON,
200
+ ConversationVirtualAgentCapabilitiesResponseToJSON,
195
201
  ConversationWebchatContext,
196
202
  ConversationWebchatContextFromJSON,
197
203
  ConversationWebchatContextToJSON,
@@ -491,6 +497,10 @@ export interface UpdateVirtualAgentBudgetRequest {
491
497
  virtualAgentBudget: ConversationVirtualAgentBudget;
492
498
  }
493
499
 
500
+ export interface UpdateVirtualAgentCapabilitiesRequest {
501
+ virtualAgentCapabilities: ConversationVirtualAgentCapabilities;
502
+ }
503
+
494
504
  /**
495
505
  * ConversationApi - interface
496
506
  *
@@ -1349,6 +1359,21 @@ export interface ConversationApiInterface {
1349
1359
  */
1350
1360
  getVirtualAgentBudget(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
1351
1361
 
1362
+ /**
1363
+ * Retrieve virtual agent capabilities
1364
+ * @summary Get virtual agent capabilities
1365
+ * @param {*} [options] Override http request option.
1366
+ * @throws {RequiredError}
1367
+ * @memberof ConversationApiInterface
1368
+ */
1369
+ getVirtualAgentCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentCapabilitiesResponse>>;
1370
+
1371
+ /**
1372
+ * Retrieve virtual agent capabilities
1373
+ * Get virtual agent capabilities
1374
+ */
1375
+ getVirtualAgentCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse>;
1376
+
1352
1377
  /**
1353
1378
  * Insert a canned message
1354
1379
  * @summary Insert a canned message
@@ -1875,6 +1900,22 @@ export interface ConversationApiInterface {
1875
1900
  */
1876
1901
  updateVirtualAgentBudget(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
1877
1902
 
1903
+ /**
1904
+ * Update virtual agent capabilities
1905
+ * @summary Update virtual agent capabilities
1906
+ * @param {ConversationVirtualAgentCapabilities} virtualAgentCapabilities Virtual Agent Capabilities
1907
+ * @param {*} [options] Override http request option.
1908
+ * @throws {RequiredError}
1909
+ * @memberof ConversationApiInterface
1910
+ */
1911
+ updateVirtualAgentCapabilitiesRaw(requestParameters: UpdateVirtualAgentCapabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentCapabilitiesResponse>>;
1912
+
1913
+ /**
1914
+ * Update virtual agent capabilities
1915
+ * Update virtual agent capabilities
1916
+ */
1917
+ updateVirtualAgentCapabilities(requestParameters: UpdateVirtualAgentCapabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse>;
1918
+
1878
1919
  }
1879
1920
 
1880
1921
  /**
@@ -4047,6 +4088,43 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
4047
4088
  return await response.value();
4048
4089
  }
4049
4090
 
4091
+ /**
4092
+ * Retrieve virtual agent capabilities
4093
+ * Get virtual agent capabilities
4094
+ */
4095
+ async getVirtualAgentCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentCapabilitiesResponse>> {
4096
+ const queryParameters: any = {};
4097
+
4098
+ const headerParameters: runtime.HTTPHeaders = {};
4099
+
4100
+ if (this.configuration && this.configuration.accessToken) {
4101
+ // oauth required
4102
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_read"]);
4103
+ }
4104
+
4105
+ if (this.configuration && this.configuration.apiKey) {
4106
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
4107
+ }
4108
+
4109
+ const response = await this.request({
4110
+ path: `/conversation/virtualagent/capabilities`,
4111
+ method: 'GET',
4112
+ headers: headerParameters,
4113
+ query: queryParameters,
4114
+ }, initOverrides);
4115
+
4116
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConversationVirtualAgentCapabilitiesResponseFromJSON(jsonValue));
4117
+ }
4118
+
4119
+ /**
4120
+ * Retrieve virtual agent capabilities
4121
+ * Get virtual agent capabilities
4122
+ */
4123
+ async getVirtualAgentCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse> {
4124
+ const response = await this.getVirtualAgentCapabilitiesRaw(initOverrides);
4125
+ return await response.value();
4126
+ }
4127
+
4050
4128
  /**
4051
4129
  * Insert a canned message
4052
4130
  * Insert a canned message
@@ -5481,4 +5559,48 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
5481
5559
  return await response.value();
5482
5560
  }
5483
5561
 
5562
+ /**
5563
+ * Update virtual agent capabilities
5564
+ * Update virtual agent capabilities
5565
+ */
5566
+ async updateVirtualAgentCapabilitiesRaw(requestParameters: UpdateVirtualAgentCapabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentCapabilitiesResponse>> {
5567
+ if (requestParameters.virtualAgentCapabilities === null || requestParameters.virtualAgentCapabilities === undefined) {
5568
+ throw new runtime.RequiredError('virtualAgentCapabilities','Required parameter requestParameters.virtualAgentCapabilities was null or undefined when calling updateVirtualAgentCapabilities.');
5569
+ }
5570
+
5571
+ const queryParameters: any = {};
5572
+
5573
+ const headerParameters: runtime.HTTPHeaders = {};
5574
+
5575
+ headerParameters['Content-Type'] = 'application/json';
5576
+
5577
+ if (this.configuration && this.configuration.accessToken) {
5578
+ // oauth required
5579
+ headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
5580
+ }
5581
+
5582
+ if (this.configuration && this.configuration.apiKey) {
5583
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
5584
+ }
5585
+
5586
+ const response = await this.request({
5587
+ path: `/conversation/virtualagent/capabilities`,
5588
+ method: 'PUT',
5589
+ headers: headerParameters,
5590
+ query: queryParameters,
5591
+ body: ConversationVirtualAgentCapabilitiesToJSON(requestParameters.virtualAgentCapabilities),
5592
+ }, initOverrides);
5593
+
5594
+ return new runtime.JSONApiResponse(response, (jsonValue) => ConversationVirtualAgentCapabilitiesResponseFromJSON(jsonValue));
5595
+ }
5596
+
5597
+ /**
5598
+ * Update virtual agent capabilities
5599
+ * Update virtual agent capabilities
5600
+ */
5601
+ async updateVirtualAgentCapabilities(requestParameters: UpdateVirtualAgentCapabilitiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse> {
5602
+ const response = await this.updateVirtualAgentCapabilitiesRaw(requestParameters, initOverrides);
5603
+ return await response.value();
5604
+ }
5605
+
5484
5606
  }
@@ -146,6 +146,18 @@ export interface Conversation {
146
146
  * @memberof Conversation
147
147
  */
148
148
  unread_messages?: boolean;
149
+ /**
150
+ * True if a virtual agent answered the conversation
151
+ * @type {boolean}
152
+ * @memberof Conversation
153
+ */
154
+ virtual_agent?: boolean;
155
+ /**
156
+ * The cost of this conversation performed by the virtual agent
157
+ * @type {number}
158
+ * @memberof Conversation
159
+ */
160
+ virtual_agent_cost?: number;
149
161
  /**
150
162
  *
151
163
  * @type {boolean}
@@ -203,6 +215,8 @@ export function ConversationFromJSONTyped(json: any, ignoreDiscriminator: boolea
203
215
  'sentiment': !exists(json, 'sentiment') ? undefined : ConversationSentimentFromJSON(json['sentiment']),
204
216
  'start_dts': !exists(json, 'start_dts') ? undefined : json['start_dts'],
205
217
  'unread_messages': !exists(json, 'unread_messages') ? undefined : json['unread_messages'],
218
+ 'virtual_agent': !exists(json, 'virtual_agent') ? undefined : json['virtual_agent'],
219
+ 'virtual_agent_cost': !exists(json, 'virtual_agent_cost') ? undefined : json['virtual_agent_cost'],
206
220
  'visible': !exists(json, 'visible') ? undefined : json['visible'],
207
221
  };
208
222
  }
@@ -234,6 +248,8 @@ export function ConversationToJSON(value?: Conversation | null): any {
234
248
  'sentiment': ConversationSentimentToJSON(value.sentiment),
235
249
  'start_dts': value.start_dts,
236
250
  'unread_messages': value.unread_messages,
251
+ 'virtual_agent': value.virtual_agent,
252
+ 'virtual_agent_cost': value.virtual_agent_cost,
237
253
  'visible': value.visible,
238
254
  };
239
255
  }
@@ -0,0 +1,131 @@
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 ConversationVirtualAgentCapabilities
20
+ */
21
+ export interface ConversationVirtualAgentCapabilities {
22
+ /**
23
+ *
24
+ * @type {boolean}
25
+ * @memberof ConversationVirtualAgentCapabilities
26
+ */
27
+ cancel_subscription?: boolean;
28
+ /**
29
+ *
30
+ * @type {boolean}
31
+ * @memberof ConversationVirtualAgentCapabilities
32
+ */
33
+ delay_subscription?: boolean;
34
+ /**
35
+ *
36
+ * @type {boolean}
37
+ * @memberof ConversationVirtualAgentCapabilities
38
+ */
39
+ lookup_order_information?: boolean;
40
+ /**
41
+ *
42
+ * @type {boolean}
43
+ * @memberof ConversationVirtualAgentCapabilities
44
+ */
45
+ lookup_subscription_information?: boolean;
46
+ /**
47
+ *
48
+ * @type {boolean}
49
+ * @memberof ConversationVirtualAgentCapabilities
50
+ */
51
+ open_support_ticket?: boolean;
52
+ /**
53
+ *
54
+ * @type {boolean}
55
+ * @memberof ConversationVirtualAgentCapabilities
56
+ */
57
+ pause_subscription?: boolean;
58
+ /**
59
+ *
60
+ * @type {boolean}
61
+ * @memberof ConversationVirtualAgentCapabilities
62
+ */
63
+ resume_subscription?: boolean;
64
+ /**
65
+ *
66
+ * @type {boolean}
67
+ * @memberof ConversationVirtualAgentCapabilities
68
+ */
69
+ transfer_chat_to_live_agent?: boolean;
70
+ /**
71
+ *
72
+ * @type {boolean}
73
+ * @memberof ConversationVirtualAgentCapabilities
74
+ */
75
+ update_subscription_credit_card?: boolean;
76
+ }
77
+
78
+
79
+
80
+ /**
81
+ * Check if a given object implements the ConversationVirtualAgentCapabilities interface.
82
+ */
83
+ export function instanceOfConversationVirtualAgentCapabilities(value: object): boolean {
84
+ let isInstance = true;
85
+
86
+ return isInstance;
87
+ }
88
+
89
+ export function ConversationVirtualAgentCapabilitiesFromJSON(json: any): ConversationVirtualAgentCapabilities {
90
+ return ConversationVirtualAgentCapabilitiesFromJSONTyped(json, false);
91
+ }
92
+
93
+ export function ConversationVirtualAgentCapabilitiesFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentCapabilities {
94
+ if ((json === undefined) || (json === null)) {
95
+ return json;
96
+ }
97
+ return {
98
+
99
+ 'cancel_subscription': !exists(json, 'cancel_subscription') ? undefined : json['cancel_subscription'],
100
+ 'delay_subscription': !exists(json, 'delay_subscription') ? undefined : json['delay_subscription'],
101
+ 'lookup_order_information': !exists(json, 'lookup_order_information') ? undefined : json['lookup_order_information'],
102
+ 'lookup_subscription_information': !exists(json, 'lookup_subscription_information') ? undefined : json['lookup_subscription_information'],
103
+ 'open_support_ticket': !exists(json, 'open_support_ticket') ? undefined : json['open_support_ticket'],
104
+ 'pause_subscription': !exists(json, 'pause_subscription') ? undefined : json['pause_subscription'],
105
+ 'resume_subscription': !exists(json, 'resume_subscription') ? undefined : json['resume_subscription'],
106
+ 'transfer_chat_to_live_agent': !exists(json, 'transfer_chat_to_live_agent') ? undefined : json['transfer_chat_to_live_agent'],
107
+ 'update_subscription_credit_card': !exists(json, 'update_subscription_credit_card') ? undefined : json['update_subscription_credit_card'],
108
+ };
109
+ }
110
+
111
+ export function ConversationVirtualAgentCapabilitiesToJSON(value?: ConversationVirtualAgentCapabilities | null): any {
112
+ if (value === undefined) {
113
+ return undefined;
114
+ }
115
+ if (value === null) {
116
+ return null;
117
+ }
118
+ return {
119
+
120
+ 'cancel_subscription': value.cancel_subscription,
121
+ 'delay_subscription': value.delay_subscription,
122
+ 'lookup_order_information': value.lookup_order_information,
123
+ 'lookup_subscription_information': value.lookup_subscription_information,
124
+ 'open_support_ticket': value.open_support_ticket,
125
+ 'pause_subscription': value.pause_subscription,
126
+ 'resume_subscription': value.resume_subscription,
127
+ 'transfer_chat_to_live_agent': value.transfer_chat_to_live_agent,
128
+ 'update_subscription_credit_card': value.update_subscription_credit_card,
129
+ };
130
+ }
131
+
@@ -0,0 +1,124 @@
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
+ import {
17
+ ConversationVirtualAgentCapabilities,
18
+ ConversationVirtualAgentCapabilitiesFromJSON,
19
+ ConversationVirtualAgentCapabilitiesFromJSONTyped,
20
+ ConversationVirtualAgentCapabilitiesToJSON,
21
+ } from './ConversationVirtualAgentCapabilities';
22
+ import {
23
+ ModelError,
24
+ ModelErrorFromJSON,
25
+ ModelErrorFromJSONTyped,
26
+ ModelErrorToJSON,
27
+ } from './ModelError';
28
+ import {
29
+ ResponseMetadata,
30
+ ResponseMetadataFromJSON,
31
+ ResponseMetadataFromJSONTyped,
32
+ ResponseMetadataToJSON,
33
+ } from './ResponseMetadata';
34
+ import {
35
+ Warning,
36
+ WarningFromJSON,
37
+ WarningFromJSONTyped,
38
+ WarningToJSON,
39
+ } from './Warning';
40
+
41
+ /**
42
+ *
43
+ * @export
44
+ * @interface ConversationVirtualAgentCapabilitiesResponse
45
+ */
46
+ export interface ConversationVirtualAgentCapabilitiesResponse {
47
+ /**
48
+ *
49
+ * @type {ConversationVirtualAgentCapabilities}
50
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
51
+ */
52
+ capabilities?: ConversationVirtualAgentCapabilities;
53
+ /**
54
+ *
55
+ * @type {ModelError}
56
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
57
+ */
58
+ error?: ModelError;
59
+ /**
60
+ *
61
+ * @type {ResponseMetadata}
62
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
63
+ */
64
+ metadata?: ResponseMetadata;
65
+ /**
66
+ * Indicates if API call was successful
67
+ * @type {boolean}
68
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
69
+ */
70
+ success?: boolean;
71
+ /**
72
+ *
73
+ * @type {Warning}
74
+ * @memberof ConversationVirtualAgentCapabilitiesResponse
75
+ */
76
+ warning?: Warning;
77
+ }
78
+
79
+
80
+
81
+ /**
82
+ * Check if a given object implements the ConversationVirtualAgentCapabilitiesResponse interface.
83
+ */
84
+ export function instanceOfConversationVirtualAgentCapabilitiesResponse(value: object): boolean {
85
+ let isInstance = true;
86
+
87
+ return isInstance;
88
+ }
89
+
90
+ export function ConversationVirtualAgentCapabilitiesResponseFromJSON(json: any): ConversationVirtualAgentCapabilitiesResponse {
91
+ return ConversationVirtualAgentCapabilitiesResponseFromJSONTyped(json, false);
92
+ }
93
+
94
+ export function ConversationVirtualAgentCapabilitiesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentCapabilitiesResponse {
95
+ if ((json === undefined) || (json === null)) {
96
+ return json;
97
+ }
98
+ return {
99
+
100
+ 'capabilities': !exists(json, 'capabilities') ? undefined : ConversationVirtualAgentCapabilitiesFromJSON(json['capabilities']),
101
+ 'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
102
+ 'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
103
+ 'success': !exists(json, 'success') ? undefined : json['success'],
104
+ 'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
105
+ };
106
+ }
107
+
108
+ export function ConversationVirtualAgentCapabilitiesResponseToJSON(value?: ConversationVirtualAgentCapabilitiesResponse | null): any {
109
+ if (value === undefined) {
110
+ return undefined;
111
+ }
112
+ if (value === null) {
113
+ return null;
114
+ }
115
+ return {
116
+
117
+ 'capabilities': ConversationVirtualAgentCapabilitiesToJSON(value.capabilities),
118
+ 'error': ModelErrorToJSON(value.error),
119
+ 'metadata': ResponseMetadataToJSON(value.metadata),
120
+ 'success': value.success,
121
+ 'warning': WarningToJSON(value.warning),
122
+ };
123
+ }
124
+
@@ -38,6 +38,12 @@ export interface ItemRestriction {
38
38
  * @memberof ItemRestriction
39
39
  */
40
40
  exclude_from_free_promotion?: boolean;
41
+ /**
42
+ * Exclude from loyalty. Must be set to true or false to save. Null is ignored for backwards SDK compatibility
43
+ * @type {boolean}
44
+ * @memberof ItemRestriction
45
+ */
46
+ exclude_from_loyalty?: boolean;
41
47
  /**
42
48
  * Items
43
49
  * @type {Array<ItemRestrictionItem>}
@@ -99,6 +105,7 @@ export function ItemRestrictionFromJSONTyped(json: any, ignoreDiscriminator: boo
99
105
 
100
106
  'exclude_coupon': !exists(json, 'exclude_coupon') ? undefined : json['exclude_coupon'],
101
107
  'exclude_from_free_promotion': !exists(json, 'exclude_from_free_promotion') ? undefined : json['exclude_from_free_promotion'],
108
+ 'exclude_from_loyalty': !exists(json, 'exclude_from_loyalty') ? undefined : json['exclude_from_loyalty'],
102
109
  'items': !exists(json, 'items') ? undefined : ((json['items'] as Array<any>).map(ItemRestrictionItemFromJSON)),
103
110
  'maximum_quantity': !exists(json, 'maximum_quantity') ? undefined : json['maximum_quantity'],
104
111
  'minimum_quantity': !exists(json, 'minimum_quantity') ? undefined : json['minimum_quantity'],
@@ -119,6 +126,7 @@ export function ItemRestrictionToJSON(value?: ItemRestriction | null): any {
119
126
 
120
127
  'exclude_coupon': value.exclude_coupon,
121
128
  'exclude_from_free_promotion': value.exclude_from_free_promotion,
129
+ 'exclude_from_loyalty': value.exclude_from_loyalty,
122
130
  'items': value.items === undefined ? undefined : ((value.items as Array<any>).map(ItemRestrictionItemToJSON)),
123
131
  'maximum_quantity': value.maximum_quantity,
124
132
  'minimum_quantity': value.minimum_quantity,
@@ -222,6 +222,8 @@ export * from './ConversationSummary';
222
222
  export * from './ConversationTwilioAccount';
223
223
  export * from './ConversationVirtualAgentBudget';
224
224
  export * from './ConversationVirtualAgentBudgetResponse';
225
+ export * from './ConversationVirtualAgentCapabilities';
226
+ export * from './ConversationVirtualAgentCapabilitiesResponse';
225
227
  export * from './ConversationWebchatContext';
226
228
  export * from './ConversationWebchatQueueStatus';
227
229
  export * from './ConversationWebchatQueueStatusAgent';