ultracart_rest_api_v2_typescript 4.1.10 → 4.1.12

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.
@@ -245,6 +245,10 @@ src/models/ConversationStartRequest.ts
245
245
  src/models/ConversationStartResponse.ts
246
246
  src/models/ConversationSummary.ts
247
247
  src/models/ConversationTwilioAccount.ts
248
+ src/models/ConversationVirtualAgentBudget.ts
249
+ src/models/ConversationVirtualAgentBudgetResponse.ts
250
+ src/models/ConversationVirtualAgentCapabilities.ts
251
+ src/models/ConversationVirtualAgentCapabilitiesResponse.ts
248
252
  src/models/ConversationWebchatContext.ts
249
253
  src/models/ConversationWebchatQueueStatus.ts
250
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.10
2
+ ## ultracart_rest_api_v2_typescript@4.1.12
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.10 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.12 --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.12 | 05/19/2025 | conversations - AI agent capabilities method |
87
+ | 4.1.11 | 05/19/2025 | conversations - virtual AI budgets |
86
88
  | 4.1.10 | 05/06/2025 | conversation - ConversationAgentProfile.user_id added for agent profiles call |
87
89
  | 4.1.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |
88
90
  | 4.1.8 | 04/22/2025 | order property fields for created_by and created_dts |
@@ -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, 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
  }
@@ -225,6 +225,12 @@ export interface UpdatePbxVoicemailMailboxRequest {
225
225
  conversationPbxVoicemailMailboxUuid: string;
226
226
  pbxVoicemailMailbox: ConversationPbxVoicemailMailbox;
227
227
  }
228
+ export interface UpdateVirtualAgentBudgetRequest {
229
+ virtualAgentBudget: ConversationVirtualAgentBudget;
230
+ }
231
+ export interface UpdateVirtualAgentCapabilitiesRequest {
232
+ virtualAgentCapabilities: ConversationVirtualAgentCapabilities;
233
+ }
228
234
  /**
229
235
  * ConversationApi - interface
230
236
  *
@@ -962,6 +968,32 @@ export interface ConversationApiInterface {
962
968
  * Get pbx voicemailMailboxes
963
969
  */
964
970
  getPbxVoicemailMailboxes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxesResponse>;
971
+ /**
972
+ * Retrieve virtual agent budget
973
+ * @summary Get virtual agent budget
974
+ * @param {*} [options] Override http request option.
975
+ * @throws {RequiredError}
976
+ * @memberof ConversationApiInterface
977
+ */
978
+ getVirtualAgentBudgetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
979
+ /**
980
+ * Retrieve virtual agent budget
981
+ * Get virtual agent budget
982
+ */
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>;
965
997
  /**
966
998
  * Insert a canned message
967
999
  * @summary Insert a canned message
@@ -1410,6 +1442,34 @@ export interface ConversationApiInterface {
1410
1442
  * Update pbx voicemailMailbox
1411
1443
  */
1412
1444
  updatePbxVoicemailMailbox(requestParameters: UpdatePbxVoicemailMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxResponse>;
1445
+ /**
1446
+ * Update virtual agent budget
1447
+ * @summary Update virtual agent budget
1448
+ * @param {ConversationVirtualAgentBudget} virtualAgentBudget Virtual Agent Budget
1449
+ * @param {*} [options] Override http request option.
1450
+ * @throws {RequiredError}
1451
+ * @memberof ConversationApiInterface
1452
+ */
1453
+ updateVirtualAgentBudgetRaw(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
1454
+ /**
1455
+ * Update virtual agent budget
1456
+ * Update virtual agent budget
1457
+ */
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>;
1413
1473
  }
1414
1474
  /**
1415
1475
  *
@@ -1945,6 +2005,26 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
1945
2005
  * Get pbx voicemailMailboxes
1946
2006
  */
1947
2007
  getPbxVoicemailMailboxes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxesResponse>;
2008
+ /**
2009
+ * Retrieve virtual agent budget
2010
+ * Get virtual agent budget
2011
+ */
2012
+ getVirtualAgentBudgetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
2013
+ /**
2014
+ * Retrieve virtual agent budget
2015
+ * Get virtual agent budget
2016
+ */
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>;
1948
2028
  /**
1949
2029
  * Insert a canned message
1950
2030
  * Insert a canned message
@@ -2255,4 +2335,24 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2255
2335
  * Update pbx voicemailMailbox
2256
2336
  */
2257
2337
  updatePbxVoicemailMailbox(requestParameters: UpdatePbxVoicemailMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxResponse>;
2338
+ /**
2339
+ * Update virtual agent budget
2340
+ * Update virtual agent budget
2341
+ */
2342
+ updateVirtualAgentBudgetRaw(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
2343
+ /**
2344
+ * Update virtual agent budget
2345
+ * Update virtual agent budget
2346
+ */
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>;
2258
2358
  }
@@ -3161,6 +3161,118 @@ var ConversationApi = /** @class */ (function (_super) {
3161
3161
  });
3162
3162
  });
3163
3163
  };
3164
+ /**
3165
+ * Retrieve virtual agent budget
3166
+ * Get virtual agent budget
3167
+ */
3168
+ ConversationApi.prototype.getVirtualAgentBudgetRaw = function (initOverrides) {
3169
+ return __awaiter(this, void 0, void 0, function () {
3170
+ var queryParameters, headerParameters, _a, _b, response;
3171
+ return __generator(this, function (_c) {
3172
+ switch (_c.label) {
3173
+ case 0:
3174
+ queryParameters = {};
3175
+ headerParameters = {};
3176
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
3177
+ // oauth required
3178
+ _a = headerParameters;
3179
+ _b = "Authorization";
3180
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_read"])];
3181
+ case 1:
3182
+ // oauth required
3183
+ _a[_b] = _c.sent();
3184
+ _c.label = 2;
3185
+ case 2:
3186
+ if (this.configuration && this.configuration.apiKey) {
3187
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
3188
+ }
3189
+ return [4 /*yield*/, this.request({
3190
+ path: "/conversation/virtualagent/budget",
3191
+ method: 'GET',
3192
+ headers: headerParameters,
3193
+ query: queryParameters,
3194
+ }, initOverrides)];
3195
+ case 3:
3196
+ response = _c.sent();
3197
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationVirtualAgentBudgetResponseFromJSON)(jsonValue); })];
3198
+ }
3199
+ });
3200
+ });
3201
+ };
3202
+ /**
3203
+ * Retrieve virtual agent budget
3204
+ * Get virtual agent budget
3205
+ */
3206
+ ConversationApi.prototype.getVirtualAgentBudget = function (initOverrides) {
3207
+ return __awaiter(this, void 0, void 0, function () {
3208
+ var response;
3209
+ return __generator(this, function (_a) {
3210
+ switch (_a.label) {
3211
+ case 0: return [4 /*yield*/, this.getVirtualAgentBudgetRaw(initOverrides)];
3212
+ case 1:
3213
+ response = _a.sent();
3214
+ return [4 /*yield*/, response.value()];
3215
+ case 2: return [2 /*return*/, _a.sent()];
3216
+ }
3217
+ });
3218
+ });
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
+ };
3164
3276
  /**
3165
3277
  * Insert a canned message
3166
3278
  * Insert a canned message
@@ -5063,6 +5175,128 @@ var ConversationApi = /** @class */ (function (_super) {
5063
5175
  });
5064
5176
  });
5065
5177
  };
5178
+ /**
5179
+ * Update virtual agent budget
5180
+ * Update virtual agent budget
5181
+ */
5182
+ ConversationApi.prototype.updateVirtualAgentBudgetRaw = function (requestParameters, initOverrides) {
5183
+ return __awaiter(this, void 0, void 0, function () {
5184
+ var queryParameters, headerParameters, _a, _b, response;
5185
+ return __generator(this, function (_c) {
5186
+ switch (_c.label) {
5187
+ case 0:
5188
+ if (requestParameters.virtualAgentBudget === null || requestParameters.virtualAgentBudget === undefined) {
5189
+ throw new runtime.RequiredError('virtualAgentBudget', 'Required parameter requestParameters.virtualAgentBudget was null or undefined when calling updateVirtualAgentBudget.');
5190
+ }
5191
+ queryParameters = {};
5192
+ headerParameters = {};
5193
+ headerParameters['Content-Type'] = 'application/json';
5194
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
5195
+ // oauth required
5196
+ _a = headerParameters;
5197
+ _b = "Authorization";
5198
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
5199
+ case 1:
5200
+ // oauth required
5201
+ _a[_b] = _c.sent();
5202
+ _c.label = 2;
5203
+ case 2:
5204
+ if (this.configuration && this.configuration.apiKey) {
5205
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
5206
+ }
5207
+ return [4 /*yield*/, this.request({
5208
+ path: "/conversation/virtualagent/budget",
5209
+ method: 'PUT',
5210
+ headers: headerParameters,
5211
+ query: queryParameters,
5212
+ body: (0, models_1.ConversationVirtualAgentBudgetToJSON)(requestParameters.virtualAgentBudget),
5213
+ }, initOverrides)];
5214
+ case 3:
5215
+ response = _c.sent();
5216
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationVirtualAgentBudgetResponseFromJSON)(jsonValue); })];
5217
+ }
5218
+ });
5219
+ });
5220
+ };
5221
+ /**
5222
+ * Update virtual agent budget
5223
+ * Update virtual agent budget
5224
+ */
5225
+ ConversationApi.prototype.updateVirtualAgentBudget = function (requestParameters, initOverrides) {
5226
+ return __awaiter(this, void 0, void 0, function () {
5227
+ var response;
5228
+ return __generator(this, function (_a) {
5229
+ switch (_a.label) {
5230
+ case 0: return [4 /*yield*/, this.updateVirtualAgentBudgetRaw(requestParameters, initOverrides)];
5231
+ case 1:
5232
+ response = _a.sent();
5233
+ return [4 /*yield*/, response.value()];
5234
+ case 2: return [2 /*return*/, _a.sent()];
5235
+ }
5236
+ });
5237
+ });
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
+ };
5066
5300
  return ConversationApi;
5067
5301
  }(runtime.BaseAPI));
5068
5302
  exports.ConversationApi = ConversationApi;
@@ -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 ConversationVirtualAgentBudget
16
+ */
17
+ export interface ConversationVirtualAgentBudget {
18
+ /**
19
+ *
20
+ * @type {number}
21
+ * @memberof ConversationVirtualAgentBudget
22
+ */
23
+ budget_daily?: number;
24
+ /**
25
+ *
26
+ * @type {number}
27
+ * @memberof ConversationVirtualAgentBudget
28
+ */
29
+ budget_monthly?: number;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof ConversationVirtualAgentBudget
34
+ */
35
+ used_daily?: number;
36
+ /**
37
+ *
38
+ * @type {number}
39
+ * @memberof ConversationVirtualAgentBudget
40
+ */
41
+ used_monthly?: number;
42
+ }
43
+ /**
44
+ * Check if a given object implements the ConversationVirtualAgentBudget interface.
45
+ */
46
+ export declare function instanceOfConversationVirtualAgentBudget(value: object): boolean;
47
+ export declare function ConversationVirtualAgentBudgetFromJSON(json: any): ConversationVirtualAgentBudget;
48
+ export declare function ConversationVirtualAgentBudgetFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentBudget;
49
+ export declare function ConversationVirtualAgentBudgetToJSON(value?: ConversationVirtualAgentBudget | 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.ConversationVirtualAgentBudgetToJSON = exports.ConversationVirtualAgentBudgetFromJSONTyped = exports.ConversationVirtualAgentBudgetFromJSON = exports.instanceOfConversationVirtualAgentBudget = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ /**
19
+ * Check if a given object implements the ConversationVirtualAgentBudget interface.
20
+ */
21
+ function instanceOfConversationVirtualAgentBudget(value) {
22
+ var isInstance = true;
23
+ return isInstance;
24
+ }
25
+ exports.instanceOfConversationVirtualAgentBudget = instanceOfConversationVirtualAgentBudget;
26
+ function ConversationVirtualAgentBudgetFromJSON(json) {
27
+ return ConversationVirtualAgentBudgetFromJSONTyped(json, false);
28
+ }
29
+ exports.ConversationVirtualAgentBudgetFromJSON = ConversationVirtualAgentBudgetFromJSON;
30
+ function ConversationVirtualAgentBudgetFromJSONTyped(json, ignoreDiscriminator) {
31
+ if ((json === undefined) || (json === null)) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'budget_daily': !(0, runtime_1.exists)(json, 'budget_daily') ? undefined : json['budget_daily'],
36
+ 'budget_monthly': !(0, runtime_1.exists)(json, 'budget_monthly') ? undefined : json['budget_monthly'],
37
+ 'used_daily': !(0, runtime_1.exists)(json, 'used_daily') ? undefined : json['used_daily'],
38
+ 'used_monthly': !(0, runtime_1.exists)(json, 'used_monthly') ? undefined : json['used_monthly'],
39
+ };
40
+ }
41
+ exports.ConversationVirtualAgentBudgetFromJSONTyped = ConversationVirtualAgentBudgetFromJSONTyped;
42
+ function ConversationVirtualAgentBudgetToJSON(value) {
43
+ if (value === undefined) {
44
+ return undefined;
45
+ }
46
+ if (value === null) {
47
+ return null;
48
+ }
49
+ return {
50
+ 'budget_daily': value.budget_daily,
51
+ 'budget_monthly': value.budget_monthly,
52
+ 'used_daily': value.used_daily,
53
+ 'used_monthly': value.used_monthly,
54
+ };
55
+ }
56
+ exports.ConversationVirtualAgentBudgetToJSON = ConversationVirtualAgentBudgetToJSON;
@@ -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 { ConversationVirtualAgentBudget } from './ConversationVirtualAgentBudget';
13
+ import { ModelError } from './ModelError';
14
+ import { ResponseMetadata } from './ResponseMetadata';
15
+ import { Warning } from './Warning';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface ConversationVirtualAgentBudgetResponse
20
+ */
21
+ export interface ConversationVirtualAgentBudgetResponse {
22
+ /**
23
+ *
24
+ * @type {ConversationVirtualAgentBudget}
25
+ * @memberof ConversationVirtualAgentBudgetResponse
26
+ */
27
+ budget?: ConversationVirtualAgentBudget;
28
+ /**
29
+ *
30
+ * @type {ModelError}
31
+ * @memberof ConversationVirtualAgentBudgetResponse
32
+ */
33
+ error?: ModelError;
34
+ /**
35
+ *
36
+ * @type {ResponseMetadata}
37
+ * @memberof ConversationVirtualAgentBudgetResponse
38
+ */
39
+ metadata?: ResponseMetadata;
40
+ /**
41
+ * Indicates if API call was successful
42
+ * @type {boolean}
43
+ * @memberof ConversationVirtualAgentBudgetResponse
44
+ */
45
+ success?: boolean;
46
+ /**
47
+ *
48
+ * @type {Warning}
49
+ * @memberof ConversationVirtualAgentBudgetResponse
50
+ */
51
+ warning?: Warning;
52
+ }
53
+ /**
54
+ * Check if a given object implements the ConversationVirtualAgentBudgetResponse interface.
55
+ */
56
+ export declare function instanceOfConversationVirtualAgentBudgetResponse(value: object): boolean;
57
+ export declare function ConversationVirtualAgentBudgetResponseFromJSON(json: any): ConversationVirtualAgentBudgetResponse;
58
+ export declare function ConversationVirtualAgentBudgetResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentBudgetResponse;
59
+ export declare function ConversationVirtualAgentBudgetResponseToJSON(value?: ConversationVirtualAgentBudgetResponse | 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.ConversationVirtualAgentBudgetResponseToJSON = exports.ConversationVirtualAgentBudgetResponseFromJSONTyped = exports.ConversationVirtualAgentBudgetResponseFromJSON = exports.instanceOfConversationVirtualAgentBudgetResponse = void 0;
17
+ var runtime_1 = require("../runtime");
18
+ var ConversationVirtualAgentBudget_1 = require("./ConversationVirtualAgentBudget");
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 ConversationVirtualAgentBudgetResponse interface.
24
+ */
25
+ function instanceOfConversationVirtualAgentBudgetResponse(value) {
26
+ var isInstance = true;
27
+ return isInstance;
28
+ }
29
+ exports.instanceOfConversationVirtualAgentBudgetResponse = instanceOfConversationVirtualAgentBudgetResponse;
30
+ function ConversationVirtualAgentBudgetResponseFromJSON(json) {
31
+ return ConversationVirtualAgentBudgetResponseFromJSONTyped(json, false);
32
+ }
33
+ exports.ConversationVirtualAgentBudgetResponseFromJSON = ConversationVirtualAgentBudgetResponseFromJSON;
34
+ function ConversationVirtualAgentBudgetResponseFromJSONTyped(json, ignoreDiscriminator) {
35
+ if ((json === undefined) || (json === null)) {
36
+ return json;
37
+ }
38
+ return {
39
+ 'budget': !(0, runtime_1.exists)(json, 'budget') ? undefined : (0, ConversationVirtualAgentBudget_1.ConversationVirtualAgentBudgetFromJSON)(json['budget']),
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.ConversationVirtualAgentBudgetResponseFromJSONTyped = ConversationVirtualAgentBudgetResponseFromJSONTyped;
47
+ function ConversationVirtualAgentBudgetResponseToJSON(value) {
48
+ if (value === undefined) {
49
+ return undefined;
50
+ }
51
+ if (value === null) {
52
+ return null;
53
+ }
54
+ return {
55
+ 'budget': (0, ConversationVirtualAgentBudget_1.ConversationVirtualAgentBudgetToJSON)(value.budget),
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.ConversationVirtualAgentBudgetResponseToJSON = ConversationVirtualAgentBudgetResponseToJSON;