ultracart_rest_api_v2_typescript 4.1.71 → 4.1.72

package/.openapi-generator/FILES

@@ -275,6 +275,7 @@ src/models/ConversationPbxTimeRange.ts
 src/models/ConversationPbxTimeRangeConfig.ts
 src/models/ConversationPbxTimeRangeResponse.ts
 src/models/ConversationPbxTimeRangesResponse.ts
+src/models/ConversationPbxVoicemailCapabilitiesResponse.ts
 src/models/ConversationPbxVoicemailMailbox.ts
 src/models/ConversationPbxVoicemailMailboxResponse.ts
 src/models/ConversationPbxVoicemailMailboxesResponse.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.71
+## ultracart_rest_api_v2_typescript@4.1.72
 
 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.71 --save
+npm install ultracart_rest_api_v2_typescript@4.1.72 --save
 ```
 
 ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.72 | 04/11/2026 | conversation pbx - voicemail notification channels |
 | 4.1.71 | 04/06/2026 | coupons - new percent_off_items_with_minimum_item_amount |
 | 4.1.70 | 04/03/2026 | conversation pbx - queue callback settings |
 | 4.1.69 | 03/31/2026 | conversations - user specific audio methods |

package/dist/apis/ConversationApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { BaseResponse, ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCallResponse, ConversationPbxCallSearchRequest, ConversationPbxCallSearchResponse, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, 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, ItemResponse } from '../models';
+import { BaseResponse, ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCallResponse, ConversationPbxCallSearchRequest, ConversationPbxCallSearchResponse, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailCapabilitiesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse, ItemResponse } from '../models';
 export interface DeleteAgentProfileKnowledgeBaseDocumentRequest {
     userId: number;
     documentUuid: string;
@@ -1384,6 +1384,19 @@ export interface ConversationApiInterface {
      * Get pbx timeRanges
      */
     getPbxTimeRanges(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxTimeRangesResponse>;
+    /**
+     * Retrieve voicemail notification capabilities including available channels
+     * @summary Get pbx voicemail capabilities
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getPbxVoicemailCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxVoicemailCapabilitiesResponse>>;
+    /**
+     * Retrieve voicemail notification capabilities including available channels
+     * Get pbx voicemail capabilities
+     */
+    getPbxVoicemailCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailCapabilitiesResponse>;
     /**
      * Retrieve a pbx voicemailMailbox
      * @summary Get pbx voicemailMailbox
@@ -2917,6 +2930,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Get pbx timeRanges
      */
     getPbxTimeRanges(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxTimeRangesResponse>;
+    /**
+     * Retrieve voicemail notification capabilities including available channels
+     * Get pbx voicemail capabilities
+     */
+    getPbxVoicemailCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxVoicemailCapabilitiesResponse>>;
+    /**
+     * Retrieve voicemail notification capabilities including available channels
+     * Get pbx voicemail capabilities
+     */
+    getPbxVoicemailCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailCapabilitiesResponse>;
     /**
      * Retrieve a pbx voicemailMailbox
      * Get pbx voicemailMailbox

package/dist/apis/ConversationApi.js

@@ -4353,6 +4353,62 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Retrieve voicemail notification capabilities including available channels
+     * Get pbx voicemail capabilities
+     */
+    ConversationApi.prototype.getPbxVoicemailCapabilitiesRaw = 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/pbx/voicemail/capabilities",
+                                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.ConversationPbxVoicemailCapabilitiesResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Retrieve voicemail notification capabilities including available channels
+     * Get pbx voicemail capabilities
+     */
+    ConversationApi.prototype.getPbxVoicemailCapabilities = 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.getPbxVoicemailCapabilitiesRaw(initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Retrieve a pbx voicemailMailbox
      * Get pbx voicemailMailbox

package/dist/models/ConversationPbxVoicemailCapabilitiesResponse.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { ConversationVirtualAgentCapabilityZohoDeskDepartment } from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface ConversationPbxVoicemailCapabilitiesResponse
+ */
+export interface ConversationPbxVoicemailCapabilitiesResponse {
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    warning?: Warning;
+    /**
+     * True if Zoho Desk is connected to UltraCart
+     * @type {boolean}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    zoho_desk_available?: boolean;
+    /**
+     * Array of Zoho Desk Departments if Zoho Desk is connected to UltraCart
+     * @type {Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    zoho_desk_departments?: Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>;
+}
+/**
+ * Check if a given object implements the ConversationPbxVoicemailCapabilitiesResponse interface.
+ */
+export declare function instanceOfConversationPbxVoicemailCapabilitiesResponse(value: object): boolean;
+export declare function ConversationPbxVoicemailCapabilitiesResponseFromJSON(json: any): ConversationPbxVoicemailCapabilitiesResponse;
+export declare function ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationPbxVoicemailCapabilitiesResponse;
+export declare function ConversationPbxVoicemailCapabilitiesResponseToJSON(value?: ConversationPbxVoicemailCapabilitiesResponse | null): any;

package/dist/models/ConversationPbxVoicemailCapabilitiesResponse.js

@@ -0,0 +1,64 @@
+"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.ConversationPbxVoicemailCapabilitiesResponseToJSON = exports.ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped = exports.ConversationPbxVoicemailCapabilitiesResponseFromJSON = exports.instanceOfConversationPbxVoicemailCapabilitiesResponse = void 0;
+var runtime_1 = require("../runtime");
+var ConversationVirtualAgentCapabilityZohoDeskDepartment_1 = require("./ConversationVirtualAgentCapabilityZohoDeskDepartment");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+/**
+ * Check if a given object implements the ConversationPbxVoicemailCapabilitiesResponse interface.
+ */
+function instanceOfConversationPbxVoicemailCapabilitiesResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfConversationPbxVoicemailCapabilitiesResponse = instanceOfConversationPbxVoicemailCapabilitiesResponse;
+function ConversationPbxVoicemailCapabilitiesResponseFromJSON(json) {
+    return ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped(json, false);
+}
+exports.ConversationPbxVoicemailCapabilitiesResponseFromJSON = ConversationPbxVoicemailCapabilitiesResponseFromJSON;
+function ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        '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']),
+        'zoho_desk_available': !(0, runtime_1.exists)(json, 'zoho_desk_available') ? undefined : json['zoho_desk_available'],
+        'zoho_desk_departments': !(0, runtime_1.exists)(json, 'zoho_desk_departments') ? undefined : (json['zoho_desk_departments'].map(ConversationVirtualAgentCapabilityZohoDeskDepartment_1.ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON)),
+    };
+}
+exports.ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped = ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped;
+function ConversationPbxVoicemailCapabilitiesResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+        'zoho_desk_available': value.zoho_desk_available,
+        'zoho_desk_departments': value.zoho_desk_departments === undefined ? undefined : (value.zoho_desk_departments.map(ConversationVirtualAgentCapabilityZohoDeskDepartment_1.ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON)),
+    };
+}
+exports.ConversationPbxVoicemailCapabilitiesResponseToJSON = ConversationPbxVoicemailCapabilitiesResponseToJSON;

package/dist/models/ConversationPbxVoicemailMailbox.d.ts

@@ -27,12 +27,24 @@ export interface ConversationPbxVoicemailMailbox {
      * @memberof ConversationPbxVoicemailMailbox
      */
     merchant_id?: string;
+    /**
+     * Send notices to channel
+     * @type {string}
+     * @memberof ConversationPbxVoicemailMailbox
+     */
+    send_notices_to_channel?: ConversationPbxVoicemailMailboxSendNoticesToChannelEnum;
     /**
      * Send notices to email
      * @type {string}
      * @memberof ConversationPbxVoicemailMailbox
      */
     send_notices_to_email?: string;
+    /**
+     * Send notices to Zoho Desk department id
+     * @type {string}
+     * @memberof ConversationPbxVoicemailMailbox
+     */
+    send_notices_to_zoho_desk_department_id?: string;
     /**
      * User Id
      * @type {number}
@@ -88,6 +100,16 @@ export interface ConversationPbxVoicemailMailbox {
      */
     voicemail_prompt_say_voice?: ConversationPbxVoicemailMailboxVoicemailPromptSayVoiceEnum;
 }
+/**
+ * @export
+ */
+export declare const ConversationPbxVoicemailMailboxSendNoticesToChannelEnum: {
+    readonly None: "none";
+    readonly Email: "email";
+    readonly ZohoDeskTicket: "zoho_desk_ticket";
+    readonly UltracartTask: "ultracart_task";
+};
+export type ConversationPbxVoicemailMailboxSendNoticesToChannelEnum = typeof ConversationPbxVoicemailMailboxSendNoticesToChannelEnum[keyof typeof ConversationPbxVoicemailMailboxSendNoticesToChannelEnum];
 /**
  * @export
  */

package/dist/models/ConversationPbxVoicemailMailbox.js

@@ -13,8 +13,17 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationPbxVoicemailMailboxToJSON = exports.ConversationPbxVoicemailMailboxFromJSONTyped = exports.ConversationPbxVoicemailMailboxFromJSON = exports.instanceOfConversationPbxVoicemailMailbox = exports.ConversationPbxVoicemailMailboxVoicemailPromptSayVoiceEnum = exports.ConversationPbxVoicemailMailboxVoicemailMailboxTypeEnum = exports.ConversationPbxVoicemailMailboxVoicemailFollowupSayVoiceEnum = void 0;
+exports.ConversationPbxVoicemailMailboxToJSON = exports.ConversationPbxVoicemailMailboxFromJSONTyped = exports.ConversationPbxVoicemailMailboxFromJSON = exports.instanceOfConversationPbxVoicemailMailbox = exports.ConversationPbxVoicemailMailboxVoicemailPromptSayVoiceEnum = exports.ConversationPbxVoicemailMailboxVoicemailMailboxTypeEnum = exports.ConversationPbxVoicemailMailboxVoicemailFollowupSayVoiceEnum = exports.ConversationPbxVoicemailMailboxSendNoticesToChannelEnum = void 0;
 var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.ConversationPbxVoicemailMailboxSendNoticesToChannelEnum = {
+    None: 'none',
+    Email: 'email',
+    ZohoDeskTicket: 'zoho_desk_ticket',
+    UltracartTask: 'ultracart_task'
+};
 /**
  * @export
  */
@@ -55,7 +64,9 @@ function ConversationPbxVoicemailMailboxFromJSONTyped(json, ignoreDiscriminator)
     return {
         'conversation_pbx_voicemail_mailbox_uuid': !(0, runtime_1.exists)(json, 'conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['conversation_pbx_voicemail_mailbox_uuid'],
         'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'send_notices_to_channel': !(0, runtime_1.exists)(json, 'send_notices_to_channel') ? undefined : json['send_notices_to_channel'],
         'send_notices_to_email': !(0, runtime_1.exists)(json, 'send_notices_to_email') ? undefined : json['send_notices_to_email'],
+        'send_notices_to_zoho_desk_department_id': !(0, runtime_1.exists)(json, 'send_notices_to_zoho_desk_department_id') ? undefined : json['send_notices_to_zoho_desk_department_id'],
         'user_id': !(0, runtime_1.exists)(json, 'user_id') ? undefined : json['user_id'],
         'voicemail_followup_play_audio_uuid': !(0, runtime_1.exists)(json, 'voicemail_followup_play_audio_uuid') ? undefined : json['voicemail_followup_play_audio_uuid'],
         'voicemail_followup_say': !(0, runtime_1.exists)(json, 'voicemail_followup_say') ? undefined : json['voicemail_followup_say'],
@@ -78,7 +89,9 @@ function ConversationPbxVoicemailMailboxToJSON(value) {
     return {
         'conversation_pbx_voicemail_mailbox_uuid': value.conversation_pbx_voicemail_mailbox_uuid,
         'merchant_id': value.merchant_id,
+        'send_notices_to_channel': value.send_notices_to_channel,
         'send_notices_to_email': value.send_notices_to_email,
+        'send_notices_to_zoho_desk_department_id': value.send_notices_to_zoho_desk_department_id,
         'user_id': value.user_id,
         'voicemail_followup_play_audio_uuid': value.voicemail_followup_play_audio_uuid,
         'voicemail_followup_say': value.voicemail_followup_say,

package/dist/models/index.d.ts

@@ -249,6 +249,7 @@ export * from './ConversationPbxTimeRange';
 export * from './ConversationPbxTimeRangeConfig';
 export * from './ConversationPbxTimeRangeResponse';
 export * from './ConversationPbxTimeRangesResponse';
+export * from './ConversationPbxVoicemailCapabilitiesResponse';
 export * from './ConversationPbxVoicemailMailbox';
 export * from './ConversationPbxVoicemailMailboxResponse';
 export * from './ConversationPbxVoicemailMailboxesResponse';

package/dist/models/index.js

@@ -267,6 +267,7 @@ __exportStar(require("./ConversationPbxTimeRange"), exports);
 __exportStar(require("./ConversationPbxTimeRangeConfig"), exports);
 __exportStar(require("./ConversationPbxTimeRangeResponse"), exports);
 __exportStar(require("./ConversationPbxTimeRangesResponse"), exports);
+__exportStar(require("./ConversationPbxVoicemailCapabilitiesResponse"), exports);
 __exportStar(require("./ConversationPbxVoicemailMailbox"), exports);
 __exportStar(require("./ConversationPbxVoicemailMailboxResponse"), exports);
 __exportStar(require("./ConversationPbxVoicemailMailboxesResponse"), exports);

package/package.json

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

package/src/apis/ConversationApi.ts

@@ -231,6 +231,9 @@ import {
     ConversationPbxTimeRangesResponse,
     ConversationPbxTimeRangesResponseFromJSON,
     ConversationPbxTimeRangesResponseToJSON,
+    ConversationPbxVoicemailCapabilitiesResponse,
+    ConversationPbxVoicemailCapabilitiesResponseFromJSON,
+    ConversationPbxVoicemailCapabilitiesResponseToJSON,
     ConversationPbxVoicemailMailbox,
     ConversationPbxVoicemailMailboxFromJSON,
     ConversationPbxVoicemailMailboxToJSON,
@@ -1916,6 +1919,21 @@ export interface ConversationApiInterface {
      */
     getPbxTimeRanges(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxTimeRangesResponse>;
 
+    /**
+     * Retrieve voicemail notification capabilities including available channels 
+     * @summary Get pbx voicemail capabilities
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getPbxVoicemailCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxVoicemailCapabilitiesResponse>>;
+
+    /**
+     * Retrieve voicemail notification capabilities including available channels 
+     * Get pbx voicemail capabilities
+     */
+    getPbxVoicemailCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailCapabilitiesResponse>;
+
     /**
      * Retrieve a pbx voicemailMailbox 
      * @summary Get pbx voicemailMailbox
@@ -5797,6 +5815,43 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         return await response.value();
     }
 
+    /**
+     * Retrieve voicemail notification capabilities including available channels 
+     * Get pbx voicemail capabilities
+     */
+    async getPbxVoicemailCapabilitiesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxVoicemailCapabilitiesResponse>> {
+        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/pbx/voicemail/capabilities`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ConversationPbxVoicemailCapabilitiesResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Retrieve voicemail notification capabilities including available channels 
+     * Get pbx voicemail capabilities
+     */
+    async getPbxVoicemailCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxVoicemailCapabilitiesResponse> {
+        const response = await this.getPbxVoicemailCapabilitiesRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Retrieve a pbx voicemailMailbox 
      * Get pbx voicemailMailbox

package/src/models/ConversationPbxVoicemailCapabilitiesResponse.ts

@@ -0,0 +1,132 @@
+/* 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 {
+    ConversationVirtualAgentCapabilityZohoDeskDepartment,
+    ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON,
+    ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSONTyped,
+    ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON,
+} from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
+import {
+    ModelError,
+    ModelErrorFromJSON,
+    ModelErrorFromJSONTyped,
+    ModelErrorToJSON,
+} from './ModelError';
+import {
+    ResponseMetadata,
+    ResponseMetadataFromJSON,
+    ResponseMetadataFromJSONTyped,
+    ResponseMetadataToJSON,
+} from './ResponseMetadata';
+import {
+    Warning,
+    WarningFromJSON,
+    WarningFromJSONTyped,
+    WarningToJSON,
+} from './Warning';
+
+/**
+ * 
+ * @export
+ * @interface ConversationPbxVoicemailCapabilitiesResponse
+ */
+export interface ConversationPbxVoicemailCapabilitiesResponse {
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    warning?: Warning;
+    /**
+     * True if Zoho Desk is connected to UltraCart
+     * @type {boolean}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    zoho_desk_available?: boolean;
+    /**
+     * Array of Zoho Desk Departments if Zoho Desk is connected to UltraCart
+     * @type {Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>}
+     * @memberof ConversationPbxVoicemailCapabilitiesResponse
+     */
+    zoho_desk_departments?: Array<ConversationVirtualAgentCapabilityZohoDeskDepartment>;
+}
+
+
+
+/**
+ * Check if a given object implements the ConversationPbxVoicemailCapabilitiesResponse interface.
+ */
+export function instanceOfConversationPbxVoicemailCapabilitiesResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function ConversationPbxVoicemailCapabilitiesResponseFromJSON(json: any): ConversationPbxVoicemailCapabilitiesResponse {
+    return ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped(json, false);
+}
+
+export function ConversationPbxVoicemailCapabilitiesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationPbxVoicemailCapabilitiesResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        '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']),
+        'zoho_desk_available': !exists(json, 'zoho_desk_available') ? undefined : json['zoho_desk_available'],
+        'zoho_desk_departments': !exists(json, 'zoho_desk_departments') ? undefined : ((json['zoho_desk_departments'] as Array<any>).map(ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON)),
+    };
+}
+
+export function ConversationPbxVoicemailCapabilitiesResponseToJSON(value?: ConversationPbxVoicemailCapabilitiesResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'error': ModelErrorToJSON(value.error),
+        'metadata': ResponseMetadataToJSON(value.metadata),
+        'success': value.success,
+        'warning': WarningToJSON(value.warning),
+        'zoho_desk_available': value.zoho_desk_available,
+        'zoho_desk_departments': value.zoho_desk_departments === undefined ? undefined : ((value.zoho_desk_departments as Array<any>).map(ConversationVirtualAgentCapabilityZohoDeskDepartmentToJSON)),
+    };
+}
+

package/src/models/ConversationPbxVoicemailMailbox.ts

@@ -31,12 +31,24 @@ export interface ConversationPbxVoicemailMailbox {
      * @memberof ConversationPbxVoicemailMailbox
      */
     merchant_id?: string;
+    /**
+     * Send notices to channel
+     * @type {string}
+     * @memberof ConversationPbxVoicemailMailbox
+     */
+    send_notices_to_channel?: ConversationPbxVoicemailMailboxSendNoticesToChannelEnum;
     /**
      * Send notices to email
      * @type {string}
      * @memberof ConversationPbxVoicemailMailbox
      */
     send_notices_to_email?: string;
+    /**
+     * Send notices to Zoho Desk department id
+     * @type {string}
+     * @memberof ConversationPbxVoicemailMailbox
+     */
+    send_notices_to_zoho_desk_department_id?: string;
     /**
      * User Id
      * @type {number}
@@ -95,6 +107,17 @@ export interface ConversationPbxVoicemailMailbox {
 
 
 
+/**
+ * @export
+ */
+export const ConversationPbxVoicemailMailboxSendNoticesToChannelEnum = {
+    None: 'none',
+    Email: 'email',
+    ZohoDeskTicket: 'zoho_desk_ticket',
+    UltracartTask: 'ultracart_task'
+} as const;
+export type ConversationPbxVoicemailMailboxSendNoticesToChannelEnum = typeof ConversationPbxVoicemailMailboxSendNoticesToChannelEnum[keyof typeof ConversationPbxVoicemailMailboxSendNoticesToChannelEnum];
+
 /**
  * @export
  */
@@ -144,7 +167,9 @@ export function ConversationPbxVoicemailMailboxFromJSONTyped(json: any, ignoreDi
         
         'conversation_pbx_voicemail_mailbox_uuid': !exists(json, 'conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['conversation_pbx_voicemail_mailbox_uuid'],
         'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'send_notices_to_channel': !exists(json, 'send_notices_to_channel') ? undefined : json['send_notices_to_channel'],
         'send_notices_to_email': !exists(json, 'send_notices_to_email') ? undefined : json['send_notices_to_email'],
+        'send_notices_to_zoho_desk_department_id': !exists(json, 'send_notices_to_zoho_desk_department_id') ? undefined : json['send_notices_to_zoho_desk_department_id'],
         'user_id': !exists(json, 'user_id') ? undefined : json['user_id'],
         'voicemail_followup_play_audio_uuid': !exists(json, 'voicemail_followup_play_audio_uuid') ? undefined : json['voicemail_followup_play_audio_uuid'],
         'voicemail_followup_say': !exists(json, 'voicemail_followup_say') ? undefined : json['voicemail_followup_say'],
@@ -168,7 +193,9 @@ export function ConversationPbxVoicemailMailboxToJSON(value?: ConversationPbxVoi
         
         'conversation_pbx_voicemail_mailbox_uuid': value.conversation_pbx_voicemail_mailbox_uuid,
         'merchant_id': value.merchant_id,
+        'send_notices_to_channel': value.send_notices_to_channel,
         'send_notices_to_email': value.send_notices_to_email,
+        'send_notices_to_zoho_desk_department_id': value.send_notices_to_zoho_desk_department_id,
         'user_id': value.user_id,
         'voicemail_followup_play_audio_uuid': value.voicemail_followup_play_audio_uuid,
         'voicemail_followup_say': value.voicemail_followup_say,

package/src/models/index.ts

@@ -251,6 +251,7 @@ export * from './ConversationPbxTimeRange';
 export * from './ConversationPbxTimeRangeConfig';
 export * from './ConversationPbxTimeRangeResponse';
 export * from './ConversationPbxTimeRangesResponse';
+export * from './ConversationPbxVoicemailCapabilitiesResponse';
 export * from './ConversationPbxVoicemailMailbox';
 export * from './ConversationPbxVoicemailMailboxResponse';
 export * from './ConversationPbxVoicemailMailboxesResponse';