ultracart_rest_api_v2_typescript 4.1.56 → 4.1.57

package/.openapi-generator/FILES

@@ -238,6 +238,11 @@ src/models/ConversationPbxCallTimeline.ts
 src/models/ConversationPbxCallTranscript.ts
 src/models/ConversationPbxCallTranscriptSegment.ts
 src/models/ConversationPbxCallTransfer.ts
+src/models/ConversationPbxClassOfService.ts
+src/models/ConversationPbxClassOfServiceResponse.ts
+src/models/ConversationPbxClassOfServicesResponse.ts
+src/models/ConversationPbxCosAuditLog.ts
+src/models/ConversationPbxCosAuditLogsResponse.ts
 src/models/ConversationPbxCustomerSnapshotRequest.ts
 src/models/ConversationPbxCustomerSnapshotResponse.ts
 src/models/ConversationPbxHardwarePhone.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.56
+## ultracart_rest_api_v2_typescript@4.1.57
 
 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.56 --save
+npm install ultracart_rest_api_v2_typescript@4.1.57 --save
 ```
 
 ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.57 | 02/03/2026 | conversations - pbx class of service objects and endpoints |
 | 4.1.56 | 02/02/2026 | conversations - add default phone number to the agent auth |
 | 4.1.55 | 02/02/2026 | conversations - add enumerated values for say voice on queue and agent |
 | 4.1.54 | 02/02/2026 | build error fix |

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, 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, 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 } 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, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
 export interface DeleteAgentProfileKnowledgeBaseDocumentRequest {
     userId: number;
     documentUuid: string;
@@ -37,6 +37,9 @@ export interface DeletePbxAgentVoicemailRequest {
 export interface DeletePbxAudioRequest {
     conversationPbxAudioUuid: string;
 }
+export interface DeletePbxClassOfServiceRequest {
+    classOfServiceUuid: string;
+}
 export interface DeletePbxHardwarePhoneRequest {
     conversationPbxHardwarePhoneUuid: string;
 }
@@ -134,6 +137,14 @@ export interface GetPbxAudioUsageRequest {
 export interface GetPbxCallRequest {
     callUuid: string;
 }
+export interface GetPbxClassOfServiceRequest {
+    classOfServiceUuid: string;
+}
+export interface GetPbxCosAuditLogsRequest {
+    since?: string;
+    agentLogin?: string;
+    limit?: number;
+}
 export interface GetPbxHardwarePhoneRequest {
     conversationPbxHardwarePhoneUuid: string;
 }
@@ -185,6 +196,9 @@ export interface InsertPbxAddressRequest {
 export interface InsertPbxAudioRequest {
     pbxAudio: ConversationPbxAudio;
 }
+export interface InsertPbxClassOfServiceRequest {
+    classOfService: ConversationPbxClassOfService;
+}
 export interface InsertPbxHardwarePhoneRequest {
     pbxHardwarePhone: ConversationPbxHardwarePhone;
 }
@@ -293,6 +307,10 @@ export interface UpdatePbxAudioRequest {
     conversationPbxAudioUuid: string;
     pbxAudio: ConversationPbxAudio;
 }
+export interface UpdatePbxClassOfServiceRequest {
+    classOfServiceUuid: string;
+    classOfService: ConversationPbxClassOfService;
+}
 export interface UpdatePbxHardwarePhoneRequest {
     conversationPbxHardwarePhoneUuid: string;
     pbxHardwarePhone: ConversationPbxHardwarePhone;
@@ -448,6 +466,20 @@ export interface ConversationApiInterface {
      * Delete pbx audio
      */
     deletePbxAudio(requestParameters: DeletePbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Delete a class of service
+     * @summary Delete pbx class of service
+     * @param {string} classOfServiceUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    deletePbxClassOfServiceRaw(requestParameters: DeletePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BaseResponse>>;
+    /**
+     * Delete a class of service
+     * Delete pbx class of service
+     */
+    deletePbxClassOfService(requestParameters: DeletePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
     /**
      * Delete a pbx hardware phone
      * @summary Delete pbx hardware phone
@@ -1059,6 +1091,49 @@ export interface ConversationApiInterface {
      * Get pbx call record
      */
     getPbxCall(requestParameters: GetPbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallResponse>;
+    /**
+     * Retrieve a single class of service
+     * @summary Get pbx class of service
+     * @param {string} classOfServiceUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getPbxClassOfServiceRaw(requestParameters: GetPbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxClassOfServiceResponse>>;
+    /**
+     * Retrieve a single class of service
+     * Get pbx class of service
+     */
+    getPbxClassOfService(requestParameters: GetPbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServiceResponse>;
+    /**
+     * Retrieve all classes of service for the merchant
+     * @summary Get pbx classes of service
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getPbxClassesOfServiceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxClassOfServicesResponse>>;
+    /**
+     * Retrieve all classes of service for the merchant
+     * Get pbx classes of service
+     */
+    getPbxClassesOfService(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServicesResponse>;
+    /**
+     * Retrieve audit log entries for class of service enforcement
+     * @summary Get pbx class of service audit logs
+     * @param {string} [since] ISO timestamp to filter entries since
+     * @param {string} [agentLogin] Filter by agent login
+     * @param {number} [limit] Maximum number of entries to return (default 100)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    getPbxCosAuditLogsRaw(requestParameters: GetPbxCosAuditLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCosAuditLogsResponse>>;
+    /**
+     * Retrieve audit log entries for class of service enforcement
+     * Get pbx class of service audit logs
+     */
+    getPbxCosAuditLogs(requestParameters: GetPbxCosAuditLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCosAuditLogsResponse>;
     /**
      * Retrieve a pbx hardware phone
      * @summary Get pbx hardware phone
@@ -1416,6 +1491,20 @@ export interface ConversationApiInterface {
      * Insert pbx audio
      */
     insertPbxAudio(requestParameters: InsertPbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Create a new class of service
+     * @summary Insert pbx class of service
+     * @param {ConversationPbxClassOfService} classOfService Class of service
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    insertPbxClassOfServiceRaw(requestParameters: InsertPbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxClassOfServiceResponse>>;
+    /**
+     * Create a new class of service
+     * Insert pbx class of service
+     */
+    insertPbxClassOfService(requestParameters: InsertPbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServiceResponse>;
     /**
      * Insert a pbx hardware phone
      * @summary Insert pbx hardware phone
@@ -1843,6 +1932,21 @@ export interface ConversationApiInterface {
      * Update pbx audio
      */
     updatePbxAudio(requestParameters: UpdatePbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Update an existing class of service
+     * @summary Update pbx class of service
+     * @param {string} classOfServiceUuid
+     * @param {ConversationPbxClassOfService} classOfService Class of service
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updatePbxClassOfServiceRaw(requestParameters: UpdatePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxClassOfServiceResponse>>;
+    /**
+     * Update an existing class of service
+     * Update pbx class of service
+     */
+    updatePbxClassOfService(requestParameters: UpdatePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServiceResponse>;
     /**
      * Update a pbx hardware phone
      * @summary Update pbx hardware phone
@@ -2061,6 +2165,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Delete pbx audio
      */
     deletePbxAudio(requestParameters: DeletePbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Delete a class of service
+     * Delete pbx class of service
+     */
+    deletePbxClassOfServiceRaw(requestParameters: DeletePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BaseResponse>>;
+    /**
+     * Delete a class of service
+     * Delete pbx class of service
+     */
+    deletePbxClassOfService(requestParameters: DeletePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BaseResponse>;
     /**
      * Delete a pbx hardware phone
      * Delete pbx hardware phone
@@ -2501,6 +2615,36 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Get pbx call record
      */
     getPbxCall(requestParameters: GetPbxCallRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCallResponse>;
+    /**
+     * Retrieve a single class of service
+     * Get pbx class of service
+     */
+    getPbxClassOfServiceRaw(requestParameters: GetPbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxClassOfServiceResponse>>;
+    /**
+     * Retrieve a single class of service
+     * Get pbx class of service
+     */
+    getPbxClassOfService(requestParameters: GetPbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServiceResponse>;
+    /**
+     * Retrieve all classes of service for the merchant
+     * Get pbx classes of service
+     */
+    getPbxClassesOfServiceRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxClassOfServicesResponse>>;
+    /**
+     * Retrieve all classes of service for the merchant
+     * Get pbx classes of service
+     */
+    getPbxClassesOfService(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServicesResponse>;
+    /**
+     * Retrieve audit log entries for class of service enforcement
+     * Get pbx class of service audit logs
+     */
+    getPbxCosAuditLogsRaw(requestParameters: GetPbxCosAuditLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxCosAuditLogsResponse>>;
+    /**
+     * Retrieve audit log entries for class of service enforcement
+     * Get pbx class of service audit logs
+     */
+    getPbxCosAuditLogs(requestParameters?: GetPbxCosAuditLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCosAuditLogsResponse>;
     /**
      * Retrieve a pbx hardware phone
      * Get pbx hardware phone
@@ -2761,6 +2905,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Insert pbx audio
      */
     insertPbxAudio(requestParameters: InsertPbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Create a new class of service
+     * Insert pbx class of service
+     */
+    insertPbxClassOfServiceRaw(requestParameters: InsertPbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxClassOfServiceResponse>>;
+    /**
+     * Create a new class of service
+     * Insert pbx class of service
+     */
+    insertPbxClassOfService(requestParameters: InsertPbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServiceResponse>;
     /**
      * Insert a pbx hardware phone
      * Insert pbx hardware phone
@@ -3051,6 +3205,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Update pbx audio
      */
     updatePbxAudio(requestParameters: UpdatePbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Update an existing class of service
+     * Update pbx class of service
+     */
+    updatePbxClassOfServiceRaw(requestParameters: UpdatePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxClassOfServiceResponse>>;
+    /**
+     * Update an existing class of service
+     * Update pbx class of service
+     */
+    updatePbxClassOfService(requestParameters: UpdatePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServiceResponse>;
     /**
      * Update a pbx hardware phone
      * Update pbx hardware phone