ultracart_rest_api_v2_typescript 4.1.9 → 4.1.11

package/.openapi-generator/FILES

@@ -245,6 +245,8 @@ src/models/ConversationStartRequest.ts
 src/models/ConversationStartResponse.ts
 src/models/ConversationSummary.ts
 src/models/ConversationTwilioAccount.ts
+src/models/ConversationVirtualAgentBudget.ts
+src/models/ConversationVirtualAgentBudgetResponse.ts
 src/models/ConversationWebchatContext.ts
 src/models/ConversationWebchatQueueStatus.ts
 src/models/ConversationWebchatQueueStatusAgent.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.9
+## ultracart_rest_api_v2_typescript@4.1.11
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.9 --save
+npm install ultracart_rest_api_v2_typescript@4.1.11 --save
 ```
 
 ```typescript
@@ -83,6 +83,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.11 | 05/19/2025 | conversations - virtual AI budgets |
+| 4.1.10 | 05/06/2025 | conversation - ConversationAgentProfile.user_id added for agent profiles call |
 | 4.1.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |
 | 4.1.8 | 04/22/2025 | order property fields for created_by and created_dts |
 | 4.1.7 | 04/21/2025 | conversation agent additional fields |

package/dist/apis/ConversationApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-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';
+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';
 export interface DeleteConversationCannedMessageRequest {
     conversationCannedMessageOid: number;
 }
@@ -225,6 +225,9 @@ export interface UpdatePbxVoicemailMailboxRequest {
     conversationPbxVoicemailMailboxUuid: string;
     pbxVoicemailMailbox: ConversationPbxVoicemailMailbox;
 }
+export interface UpdateVirtualAgentBudgetRequest {
+    virtualAgentBudget: ConversationVirtualAgentBudget;
+}
 /**
  * ConversationApi - interface
  *
@@ -962,6 +965,19 @@ export interface ConversationApiInterface {
      * Get pbx voicemailMailboxes
      */
     getPbxVoicemailMailboxes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxesResponse>;
+    /**
+     * Retrieve virtual agent budget
+     * @summary Get virtual agent budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getVirtualAgentBudgetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
+    /**
+     * Retrieve virtual agent budget
+     * Get virtual agent budget
+     */
+    getVirtualAgentBudget(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
     /**
      * Insert a canned message
      * @summary Insert a canned message
@@ -1410,6 +1426,20 @@ export interface ConversationApiInterface {
      * Update pbx voicemailMailbox
      */
     updatePbxVoicemailMailbox(requestParameters: UpdatePbxVoicemailMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxResponse>;
+    /**
+     * Update virtual agent budget
+     * @summary Update virtual agent budget
+     * @param {ConversationVirtualAgentBudget} virtualAgentBudget Virtual Agent Budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateVirtualAgentBudgetRaw(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
+    /**
+     * Update virtual agent budget
+     * Update virtual agent budget
+     */
+    updateVirtualAgentBudget(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
 }
 /**
  *
@@ -1945,6 +1975,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Get pbx voicemailMailboxes
      */
     getPbxVoicemailMailboxes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxesResponse>;
+    /**
+     * Retrieve virtual agent budget
+     * Get virtual agent budget
+     */
+    getVirtualAgentBudgetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
+    /**
+     * Retrieve virtual agent budget
+     * Get virtual agent budget
+     */
+    getVirtualAgentBudget(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
     /**
      * Insert a canned message
      * Insert a canned message
@@ -2255,4 +2295,14 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Update pbx voicemailMailbox
      */
     updatePbxVoicemailMailbox(requestParameters: UpdatePbxVoicemailMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxResponse>;
+    /**
+     * Update virtual agent budget
+     * Update virtual agent budget
+     */
+    updateVirtualAgentBudgetRaw(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
+    /**
+     * Update virtual agent budget
+     * Update virtual agent budget
+     */
+    updateVirtualAgentBudget(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
 }

package/dist/apis/ConversationApi.js

@@ -3161,6 +3161,62 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve virtual agent budget
+     * Get virtual agent budget
+     */
+    ConversationApi.prototype.getVirtualAgentBudgetRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_read"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/conversation/virtualagent/budget",
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationVirtualAgentBudgetResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve virtual agent budget
+     * Get virtual agent budget
+     */
+    ConversationApi.prototype.getVirtualAgentBudget = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getVirtualAgentBudgetRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Insert a canned message
      * Insert a canned message
@@ -5063,6 +5119,67 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Update virtual agent budget
+     * Update virtual agent budget
+     */
+    ConversationApi.prototype.updateVirtualAgentBudgetRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.virtualAgentBudget === null || requestParameters.virtualAgentBudget === undefined) {
+                            throw new runtime.RequiredError('virtualAgentBudget', 'Required parameter requestParameters.virtualAgentBudget was null or undefined when calling updateVirtualAgentBudget.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/conversation/virtualagent/budget",
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ConversationVirtualAgentBudgetToJSON)(requestParameters.virtualAgentBudget),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationVirtualAgentBudgetResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Update virtual agent budget
+     * Update virtual agent budget
+     */
+    ConversationApi.prototype.updateVirtualAgentBudget = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.updateVirtualAgentBudgetRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     return ConversationApi;
 }(runtime.BaseAPI));
 exports.ConversationApi = ConversationApi;

package/dist/models/ConversationAgentProfile.d.ts

@@ -81,6 +81,12 @@ export interface ConversationAgentProfile {
      * @memberof ConversationAgentProfile
      */
     profile_image_url?: string;
+    /**
+     * User ID associated with the agent.  Populated by getAgentProfiles call only.
+     * @type {number}
+     * @memberof ConversationAgentProfile
+     */
+    user_id?: number;
 }
 /**
  * @export

package/dist/models/ConversationAgentProfile.js

@@ -51,6 +51,7 @@ function ConversationAgentProfileFromJSONTyped(json, ignoreDiscriminator) {
         'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
         'profile_image_upload_key': !(0, runtime_1.exists)(json, 'profile_image_upload_key') ? undefined : json['profile_image_upload_key'],
         'profile_image_url': !(0, runtime_1.exists)(json, 'profile_image_url') ? undefined : json['profile_image_url'],
+        'user_id': !(0, runtime_1.exists)(json, 'user_id') ? undefined : json['user_id'],
     };
 }
 exports.ConversationAgentProfileFromJSONTyped = ConversationAgentProfileFromJSONTyped;
@@ -73,6 +74,7 @@ function ConversationAgentProfileToJSON(value) {
         'name': value.name,
         'profile_image_upload_key': value.profile_image_upload_key,
         'profile_image_url': value.profile_image_url,
+        'user_id': value.user_id,
     };
 }
 exports.ConversationAgentProfileToJSON = ConversationAgentProfileToJSON;

package/dist/models/ConversationVirtualAgentBudget.d.ts

@@ -0,0 +1,49 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ConversationVirtualAgentBudget
+ */
+export interface ConversationVirtualAgentBudget {
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationVirtualAgentBudget
+     */
+    budget_daily?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationVirtualAgentBudget
+     */
+    budget_monthly?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationVirtualAgentBudget
+     */
+    used_daily?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ConversationVirtualAgentBudget
+     */
+    used_monthly?: number;
+}
+/**
+ * Check if a given object implements the ConversationVirtualAgentBudget interface.
+ */
+export declare function instanceOfConversationVirtualAgentBudget(value: object): boolean;
+export declare function ConversationVirtualAgentBudgetFromJSON(json: any): ConversationVirtualAgentBudget;
+export declare function ConversationVirtualAgentBudgetFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentBudget;
+export declare function ConversationVirtualAgentBudgetToJSON(value?: ConversationVirtualAgentBudget | null): any;

package/dist/models/ConversationVirtualAgentBudget.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationVirtualAgentBudgetToJSON = exports.ConversationVirtualAgentBudgetFromJSONTyped = exports.ConversationVirtualAgentBudgetFromJSON = exports.instanceOfConversationVirtualAgentBudget = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the ConversationVirtualAgentBudget interface.
+ */
+function instanceOfConversationVirtualAgentBudget(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfConversationVirtualAgentBudget = instanceOfConversationVirtualAgentBudget;
+function ConversationVirtualAgentBudgetFromJSON(json) {
+    return ConversationVirtualAgentBudgetFromJSONTyped(json, false);
+}
+exports.ConversationVirtualAgentBudgetFromJSON = ConversationVirtualAgentBudgetFromJSON;
+function ConversationVirtualAgentBudgetFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'budget_daily': !(0, runtime_1.exists)(json, 'budget_daily') ? undefined : json['budget_daily'],
+        'budget_monthly': !(0, runtime_1.exists)(json, 'budget_monthly') ? undefined : json['budget_monthly'],
+        'used_daily': !(0, runtime_1.exists)(json, 'used_daily') ? undefined : json['used_daily'],
+        'used_monthly': !(0, runtime_1.exists)(json, 'used_monthly') ? undefined : json['used_monthly'],
+    };
+}
+exports.ConversationVirtualAgentBudgetFromJSONTyped = ConversationVirtualAgentBudgetFromJSONTyped;
+function ConversationVirtualAgentBudgetToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'budget_daily': value.budget_daily,
+        'budget_monthly': value.budget_monthly,
+        'used_daily': value.used_daily,
+        'used_monthly': value.used_monthly,
+    };
+}
+exports.ConversationVirtualAgentBudgetToJSON = ConversationVirtualAgentBudgetToJSON;

package/dist/models/ConversationVirtualAgentBudgetResponse.d.ts

@@ -0,0 +1,59 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ConversationVirtualAgentBudget } from './ConversationVirtualAgentBudget';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface ConversationVirtualAgentBudgetResponse
+ */
+export interface ConversationVirtualAgentBudgetResponse {
+    /**
+     *
+     * @type {ConversationVirtualAgentBudget}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    budget?: ConversationVirtualAgentBudget;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    warning?: Warning;
+}
+/**
+ * Check if a given object implements the ConversationVirtualAgentBudgetResponse interface.
+ */
+export declare function instanceOfConversationVirtualAgentBudgetResponse(value: object): boolean;
+export declare function ConversationVirtualAgentBudgetResponseFromJSON(json: any): ConversationVirtualAgentBudgetResponse;
+export declare function ConversationVirtualAgentBudgetResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentBudgetResponse;
+export declare function ConversationVirtualAgentBudgetResponseToJSON(value?: ConversationVirtualAgentBudgetResponse | null): any;

package/dist/models/ConversationVirtualAgentBudgetResponse.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationVirtualAgentBudgetResponseToJSON = exports.ConversationVirtualAgentBudgetResponseFromJSONTyped = exports.ConversationVirtualAgentBudgetResponseFromJSON = exports.instanceOfConversationVirtualAgentBudgetResponse = void 0;
+var runtime_1 = require("../runtime");
+var ConversationVirtualAgentBudget_1 = require("./ConversationVirtualAgentBudget");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+/**
+ * Check if a given object implements the ConversationVirtualAgentBudgetResponse interface.
+ */
+function instanceOfConversationVirtualAgentBudgetResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfConversationVirtualAgentBudgetResponse = instanceOfConversationVirtualAgentBudgetResponse;
+function ConversationVirtualAgentBudgetResponseFromJSON(json) {
+    return ConversationVirtualAgentBudgetResponseFromJSONTyped(json, false);
+}
+exports.ConversationVirtualAgentBudgetResponseFromJSON = ConversationVirtualAgentBudgetResponseFromJSON;
+function ConversationVirtualAgentBudgetResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'budget': !(0, runtime_1.exists)(json, 'budget') ? undefined : (0, ConversationVirtualAgentBudget_1.ConversationVirtualAgentBudgetFromJSON)(json['budget']),
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.ConversationVirtualAgentBudgetResponseFromJSONTyped = ConversationVirtualAgentBudgetResponseFromJSONTyped;
+function ConversationVirtualAgentBudgetResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'budget': (0, ConversationVirtualAgentBudget_1.ConversationVirtualAgentBudgetToJSON)(value.budget),
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.ConversationVirtualAgentBudgetResponseToJSON = ConversationVirtualAgentBudgetResponseToJSON;

package/dist/models/index.d.ts

@@ -218,6 +218,8 @@ export * from './ConversationStartRequest';
 export * from './ConversationStartResponse';
 export * from './ConversationSummary';
 export * from './ConversationTwilioAccount';
+export * from './ConversationVirtualAgentBudget';
+export * from './ConversationVirtualAgentBudgetResponse';
 export * from './ConversationWebchatContext';
 export * from './ConversationWebchatQueueStatus';
 export * from './ConversationWebchatQueueStatusAgent';

package/dist/models/index.js

@@ -236,6 +236,8 @@ __exportStar(require("./ConversationStartRequest"), exports);
 __exportStar(require("./ConversationStartResponse"), exports);
 __exportStar(require("./ConversationSummary"), exports);
 __exportStar(require("./ConversationTwilioAccount"), exports);
+__exportStar(require("./ConversationVirtualAgentBudget"), exports);
+__exportStar(require("./ConversationVirtualAgentBudgetResponse"), exports);
 __exportStar(require("./ConversationWebchatContext"), exports);
 __exportStar(require("./ConversationWebchatQueueStatus"), exports);
 __exportStar(require("./ConversationWebchatQueueStatusAgent"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.9",
+  "version": "4.1.11",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/ConversationApi.ts

@@ -186,6 +186,12 @@ import {
     ConversationStartResponse,
     ConversationStartResponseFromJSON,
     ConversationStartResponseToJSON,
+    ConversationVirtualAgentBudget,
+    ConversationVirtualAgentBudgetFromJSON,
+    ConversationVirtualAgentBudgetToJSON,
+    ConversationVirtualAgentBudgetResponse,
+    ConversationVirtualAgentBudgetResponseFromJSON,
+    ConversationVirtualAgentBudgetResponseToJSON,
     ConversationWebchatContext,
     ConversationWebchatContextFromJSON,
     ConversationWebchatContextToJSON,
@@ -481,6 +487,10 @@ export interface UpdatePbxVoicemailMailboxRequest {
     pbxVoicemailMailbox: ConversationPbxVoicemailMailbox;
 }
 
+export interface UpdateVirtualAgentBudgetRequest {
+    virtualAgentBudget: ConversationVirtualAgentBudget;
+}
+
 /**
  * ConversationApi - interface
  * 
@@ -1324,6 +1334,21 @@ export interface ConversationApiInterface {
      */
     getPbxVoicemailMailboxes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxesResponse>;
 
+    /**
+     * Retrieve virtual agent budget 
+     * @summary Get virtual agent budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getVirtualAgentBudgetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
+
+    /**
+     * Retrieve virtual agent budget 
+     * Get virtual agent budget
+     */
+    getVirtualAgentBudget(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
+
     /**
      * Insert a canned message 
      * @summary Insert a canned message
@@ -1834,6 +1859,22 @@ export interface ConversationApiInterface {
      */
     updatePbxVoicemailMailbox(requestParameters: UpdatePbxVoicemailMailboxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailMailboxResponse>;
 
+    /**
+     * Update virtual agent budget 
+     * @summary Update virtual agent budget
+     * @param {ConversationVirtualAgentBudget} virtualAgentBudget Virtual Agent Budget
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateVirtualAgentBudgetRaw(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>>;
+
+    /**
+     * Update virtual agent budget 
+     * Update virtual agent budget
+     */
+    updateVirtualAgentBudget(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse>;
+
 }
 
 /**
@@ -3969,6 +4010,43 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         return await response.value();
     }
 
+    /**
+     * Retrieve virtual agent budget 
+     * Get virtual agent budget
+     */
+    async getVirtualAgentBudgetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_read"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/conversation/virtualagent/budget`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ConversationVirtualAgentBudgetResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve virtual agent budget 
+     * Get virtual agent budget
+     */
+    async getVirtualAgentBudget(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse> {
+        const response = await this.getVirtualAgentBudgetRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Insert a canned message 
      * Insert a canned message
@@ -5359,4 +5437,48 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         return await response.value();
     }
 
+    /**
+     * Update virtual agent budget 
+     * Update virtual agent budget
+     */
+    async updateVirtualAgentBudgetRaw(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationVirtualAgentBudgetResponse>> {
+        if (requestParameters.virtualAgentBudget === null || requestParameters.virtualAgentBudget === undefined) {
+            throw new runtime.RequiredError('virtualAgentBudget','Required parameter requestParameters.virtualAgentBudget was null or undefined when calling updateVirtualAgentBudget.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/conversation/virtualagent/budget`,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ConversationVirtualAgentBudgetToJSON(requestParameters.virtualAgentBudget),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ConversationVirtualAgentBudgetResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update virtual agent budget 
+     * Update virtual agent budget
+     */
+    async updateVirtualAgentBudget(requestParameters: UpdateVirtualAgentBudgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentBudgetResponse> {
+        const response = await this.updateVirtualAgentBudgetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/models/ConversationAgentProfile.ts

@@ -85,6 +85,12 @@ export interface ConversationAgentProfile {
      * @memberof ConversationAgentProfile
      */
     profile_image_url?: string;
+    /**
+     * User ID associated with the agent.  Populated by getAgentProfiles call only.
+     * @type {number}
+     * @memberof ConversationAgentProfile
+     */
+    user_id?: number;
 }
 
 
@@ -130,6 +136,7 @@ export function ConversationAgentProfileFromJSONTyped(json: any, ignoreDiscrimin
         'name': !exists(json, 'name') ? undefined : json['name'],
         'profile_image_upload_key': !exists(json, 'profile_image_upload_key') ? undefined : json['profile_image_upload_key'],
         'profile_image_url': !exists(json, 'profile_image_url') ? undefined : json['profile_image_url'],
+        'user_id': !exists(json, 'user_id') ? undefined : json['user_id'],
     };
 }
 
@@ -153,6 +160,7 @@ export function ConversationAgentProfileToJSON(value?: ConversationAgentProfile
         'name': value.name,
         'profile_image_upload_key': value.profile_image_upload_key,
         'profile_image_url': value.profile_image_url,
+        'user_id': value.user_id,
     };
 }
 

package/src/models/ConversationVirtualAgentBudget.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ConversationVirtualAgentBudget
+ */
+export interface ConversationVirtualAgentBudget {
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationVirtualAgentBudget
+     */
+    budget_daily?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationVirtualAgentBudget
+     */
+    budget_monthly?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationVirtualAgentBudget
+     */
+    used_daily?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConversationVirtualAgentBudget
+     */
+    used_monthly?: number;
+}
+
+
+
+/**
+ * Check if a given object implements the ConversationVirtualAgentBudget interface.
+ */
+export function instanceOfConversationVirtualAgentBudget(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function ConversationVirtualAgentBudgetFromJSON(json: any): ConversationVirtualAgentBudget {
+    return ConversationVirtualAgentBudgetFromJSONTyped(json, false);
+}
+
+export function ConversationVirtualAgentBudgetFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentBudget {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'budget_daily': !exists(json, 'budget_daily') ? undefined : json['budget_daily'],
+        'budget_monthly': !exists(json, 'budget_monthly') ? undefined : json['budget_monthly'],
+        'used_daily': !exists(json, 'used_daily') ? undefined : json['used_daily'],
+        'used_monthly': !exists(json, 'used_monthly') ? undefined : json['used_monthly'],
+    };
+}
+
+export function ConversationVirtualAgentBudgetToJSON(value?: ConversationVirtualAgentBudget | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'budget_daily': value.budget_daily,
+        'budget_monthly': value.budget_monthly,
+        'used_daily': value.used_daily,
+        'used_monthly': value.used_monthly,
+    };
+}
+

package/src/models/ConversationVirtualAgentBudgetResponse.ts

@@ -0,0 +1,124 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    ConversationVirtualAgentBudget,
+    ConversationVirtualAgentBudgetFromJSON,
+    ConversationVirtualAgentBudgetFromJSONTyped,
+    ConversationVirtualAgentBudgetToJSON,
+} from './ConversationVirtualAgentBudget';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface ConversationVirtualAgentBudgetResponse
+ */
+export interface ConversationVirtualAgentBudgetResponse {
+    /**
+     * 
+     * @type {ConversationVirtualAgentBudget}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    budget?: ConversationVirtualAgentBudget;
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ConversationVirtualAgentBudgetResponse
+     */
+    warning?: Warning;
+}
+
+
+
+/**
+ * Check if a given object implements the ConversationVirtualAgentBudgetResponse interface.
+ */
+export function instanceOfConversationVirtualAgentBudgetResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function ConversationVirtualAgentBudgetResponseFromJSON(json: any): ConversationVirtualAgentBudgetResponse {
+    return ConversationVirtualAgentBudgetResponseFromJSONTyped(json, false);
+}
+
+export function ConversationVirtualAgentBudgetResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentBudgetResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'budget': !exists(json, 'budget') ? undefined : ConversationVirtualAgentBudgetFromJSON(json['budget']),
+        'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
+        'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
+        'success': !exists(json, 'success') ? undefined : json['success'],
+        'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
+    };
+}
+
+export function ConversationVirtualAgentBudgetResponseToJSON(value?: ConversationVirtualAgentBudgetResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'budget': ConversationVirtualAgentBudgetToJSON(value.budget),
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+    };
+}
+

package/src/models/index.ts

@@ -220,6 +220,8 @@ export * from './ConversationStartRequest';
 export * from './ConversationStartResponse';
 export * from './ConversationSummary';
 export * from './ConversationTwilioAccount';
+export * from './ConversationVirtualAgentBudget';
+export * from './ConversationVirtualAgentBudgetResponse';
 export * from './ConversationWebchatContext';
 export * from './ConversationWebchatQueueStatus';
 export * from './ConversationWebchatQueueStatusAgent';