ultracart_api 4.1.80 → 4.1.83

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcbf4f8fb16a84e47f15f773a39cec3d640f657bcc32776ee7e20db562ee3447
-  data.tar.gz: 2192e4d544a9ff31876cdc634976ec2a9b31543ccf49fd39652dd00f325ebbba
+  metadata.gz: 1177adf96617a66dfc650d8b776952341ecbb35bf8b47565f0599b9492d757c6
+  data.tar.gz: 61faba8f4763badcfcfec6426d61af2364af770e6e7ada5b1bc12b9864adb9e0
 SHA512:
-  metadata.gz: 3efbeb430638b88f25b3a68fd6fb49f2e253bbe95efe6c73c0a337eed36ffed72de3c450ac4070c5dc9380f583f301a5a4516d34b6f8bb264e78e07f9218c789
-  data.tar.gz: 4004a51b32cceb520d65e457c8ce3f1e18ebbbdfb1929956aaded697628c3d67a6eab94fc0240cfc24ac1d12d6f83c30d83af19fee8184507b8f1dcde8d4b97f
+  metadata.gz: 2ae50759ae7726bf29ab35e75bf4aa900237e044b7761043eadd89977f33dc154bdc0d8c01ab841c1f97765e376488b01901d72e10fef8fd572545ae63c46803
+  data.tar.gz: 0f165c9562b4c27849ac7511e63514deea937bcab786ca240fa4ac5b90b7d4e6302ba8887df4bf0846fd60ef8766b497d06f755ae9a07aec75118b5a2ac1fe20

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.80
+- Package version: 4.1.83
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.80'
+gem 'ultracart_api', '4.1.83'
 ```
 
 install:
@@ -135,6 +135,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
 *UltracartClient::ConversationApi* | [**delete_agent_profile_knowledge_base_document**](docs/ConversationApi.md#delete_agent_profile_knowledge_base_document) | **DELETE** /conversation/agent/profiles/{user_id}/knowledge_base/{document_uuid} | Delete a knowledge base document
 *UltracartClient::ConversationApi* | [**delete_agent_profile_mcp**](docs/ConversationApi.md#delete_agent_profile_mcp) | **DELETE** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Delete an agent MCP server
+*UltracartClient::ConversationApi* | [**delete_agent_status_config**](docs/ConversationApi.md#delete_agent_status_config) | **DELETE** /conversation/agent/status/config/{conversation_status_uuid} | Soft-deactivate a custom agent status
 *UltracartClient::ConversationApi* | [**delete_conversation_canned_message**](docs/ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
 *UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
 *UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
@@ -158,6 +159,10 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_agent_profile_mcp_tools**](docs/ConversationApi.md#get_agent_profile_mcp_tools) | **GET** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}/tools | Get the tools available from the MCP server
 *UltracartClient::ConversationApi* | [**get_agent_profile_mcps**](docs/ConversationApi.md#get_agent_profile_mcps) | **GET** /conversation/agent/profiles/{user_id}/mcps | Get the list of MCP servers associated with this agent
 *UltracartClient::ConversationApi* | [**get_agent_profiles**](docs/ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
+*UltracartClient::ConversationApi* | [**get_agent_status_configs**](docs/ConversationApi.md#get_agent_status_configs) | **GET** /conversation/agent/status/config | List custom agent statuses
+*UltracartClient::ConversationApi* | [**get_agent_status_heatmap**](docs/ConversationApi.md#get_agent_status_heatmap) | **POST** /conversation/agent/status/heatmap | Agent x hour-of-day heatmap
+*UltracartClient::ConversationApi* | [**get_agent_status_summary**](docs/ConversationApi.md#get_agent_status_summary) | **GET** /conversation/agent/status/rollup/summary | Dashboard summary for a date range
+*UltracartClient::ConversationApi* | [**get_agent_status_timeline**](docs/ConversationApi.md#get_agent_status_timeline) | **GET** /conversation/agent/status/history/{agent_user_id}/timeline | Day timeline for a single agent
 *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
 *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
 *UltracartClient::ConversationApi* | [**get_conversation_canned_messages**](docs/ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
@@ -191,6 +196,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_pbx_class_of_service**](docs/ConversationApi.md#get_pbx_class_of_service) | **GET** /conversation/pbx/class_of_service/{classOfServiceUuid} | Get pbx class of service
 *UltracartClient::ConversationApi* | [**get_pbx_classes_of_service**](docs/ConversationApi.md#get_pbx_classes_of_service) | **GET** /conversation/pbx/class_of_service | Get pbx classes of service
 *UltracartClient::ConversationApi* | [**get_pbx_cos_audit_logs**](docs/ConversationApi.md#get_pbx_cos_audit_logs) | **GET** /conversation/pbx/class_of_service/audit_log | Get pbx class of service audit logs
+*UltracartClient::ConversationApi* | [**get_pbx_default_timezone**](docs/ConversationApi.md#get_pbx_default_timezone) | **GET** /conversation/pbx/config/default-timezone | Get the merchant default timezone
 *UltracartClient::ConversationApi* | [**get_pbx_hardware_phone**](docs/ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone
 *UltracartClient::ConversationApi* | [**get_pbx_hardware_phone_manufacturers**](docs/ConversationApi.md#get_pbx_hardware_phone_manufacturers) | **GET** /conversation/pbx/hardware_phone/manufacturers | Get pbx hardware phone manufacturers
 *UltracartClient::ConversationApi* | [**get_pbx_hardware_phones**](docs/ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones
@@ -215,6 +221,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
 *UltracartClient::ConversationApi* | [**insert_agent_profile_knowledge_base_document**](docs/ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document
 *UltracartClient::ConversationApi* | [**insert_agent_profile_mcp**](docs/ConversationApi.md#insert_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps | Insert an agent MCP server
+*UltracartClient::ConversationApi* | [**insert_agent_status_config**](docs/ConversationApi.md#insert_agent_status_config) | **POST** /conversation/agent/status/config | Create a custom agent status
 *UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
 *UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
 *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
@@ -237,6 +244,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**purchase_pbx_phone_number**](docs/ConversationApi.md#purchase_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Purchase pbx phone number
 *UltracartClient::ConversationApi* | [**regenerate_password_for_pbx_hardware_phone**](docs/ConversationApi.md#regenerate_password_for_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid}/regenerate_password | Update pbx hardware phone
 *UltracartClient::ConversationApi* | [**reset_conversation_pbx_queue_statistics**](docs/ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue
+*UltracartClient::ConversationApi* | [**search_agent_status_history**](docs/ConversationApi.md#search_agent_status_history) | **POST** /conversation/agent/status/history/search | Search agent status history
+*UltracartClient::ConversationApi* | [**search_agent_status_rollups**](docs/ConversationApi.md#search_agent_status_rollups) | **POST** /conversation/agent/status/rollup/search | Search per-(agent, day) rollups
 *UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
 *UltracartClient::ConversationApi* | [**search_pbx_available_phone_numbers**](docs/ConversationApi.md#search_pbx_available_phone_numbers) | **GET** /conversation/pbx/phone_number/search | Search for available phone numbers
 *UltracartClient::ConversationApi* | [**search_pbx_calls**](docs/ConversationApi.md#search_pbx_calls) | **POST** /conversation/pbx/call/search | Search pbx call records
@@ -244,6 +253,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 *UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
 *UltracartClient::ConversationApi* | [**update_agent_profile_mcp**](docs/ConversationApi.md#update_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Update an agent MCP server
+*UltracartClient::ConversationApi* | [**update_agent_status_config**](docs/ConversationApi.md#update_agent_status_config) | **PUT** /conversation/agent/status/config/{conversation_status_uuid} | Update a custom agent status
 *UltracartClient::ConversationApi* | [**update_conversation_canned_message**](docs/ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
 *UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
 *UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
@@ -252,6 +262,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**update_pbx_agent**](docs/ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent
 *UltracartClient::ConversationApi* | [**update_pbx_audio**](docs/ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio
 *UltracartClient::ConversationApi* | [**update_pbx_class_of_service**](docs/ConversationApi.md#update_pbx_class_of_service) | **PUT** /conversation/pbx/class_of_service/{classOfServiceUuid} | Update pbx class of service
+*UltracartClient::ConversationApi* | [**update_pbx_default_timezone**](docs/ConversationApi.md#update_pbx_default_timezone) | **PUT** /conversation/pbx/config/default-timezone | Set the merchant default timezone
 *UltracartClient::ConversationApi* | [**update_pbx_hardware_phone**](docs/ConversationApi.md#update_pbx_hardware_phone) | **PUT** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Update pbx hardware phone
 *UltracartClient::ConversationApi* | [**update_pbx_menu**](docs/ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu
 *UltracartClient::ConversationApi* | [**update_pbx_phone_number**](docs/ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber
@@ -687,6 +698,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::AffiliateLedgerQuery](docs/AffiliateLedgerQuery.md)
  - [UltracartClient::AffiliateLedgersResponse](docs/AffiliateLedgersResponse.md)
  - [UltracartClient::AffiliateLink](docs/AffiliateLink.md)
+ - [UltracartClient::AgentSummary](docs/AgentSummary.md)
  - [UltracartClient::ApiUserApplicationProfile](docs/ApiUserApplicationProfile.md)
  - [UltracartClient::ApplyLibraryItemRequest](docs/ApplyLibraryItemRequest.md)
  - [UltracartClient::ApplyLibraryItemResponse](docs/ApplyLibraryItemResponse.md)
@@ -804,9 +816,24 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
  - [UltracartClient::ConversationAgentAuthMerchant](docs/ConversationAgentAuthMerchant.md)
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
+ - [UltracartClient::ConversationAgentCallEvent](docs/ConversationAgentCallEvent.md)
+ - [UltracartClient::ConversationAgentChatEvent](docs/ConversationAgentChatEvent.md)
  - [UltracartClient::ConversationAgentProfile](docs/ConversationAgentProfile.md)
  - [UltracartClient::ConversationAgentProfileResponse](docs/ConversationAgentProfileResponse.md)
  - [UltracartClient::ConversationAgentProfilesResponse](docs/ConversationAgentProfilesResponse.md)
+ - [UltracartClient::ConversationAgentStatusConfig](docs/ConversationAgentStatusConfig.md)
+ - [UltracartClient::ConversationAgentStatusConfigResponse](docs/ConversationAgentStatusConfigResponse.md)
+ - [UltracartClient::ConversationAgentStatusConfigsResponse](docs/ConversationAgentStatusConfigsResponse.md)
+ - [UltracartClient::ConversationAgentStatusEvent](docs/ConversationAgentStatusEvent.md)
+ - [UltracartClient::ConversationAgentStatusHeatmapRequest](docs/ConversationAgentStatusHeatmapRequest.md)
+ - [UltracartClient::ConversationAgentStatusHeatmapResponse](docs/ConversationAgentStatusHeatmapResponse.md)
+ - [UltracartClient::ConversationAgentStatusHistorySearchRequest](docs/ConversationAgentStatusHistorySearchRequest.md)
+ - [UltracartClient::ConversationAgentStatusHistorySearchResponse](docs/ConversationAgentStatusHistorySearchResponse.md)
+ - [UltracartClient::ConversationAgentStatusRollup](docs/ConversationAgentStatusRollup.md)
+ - [UltracartClient::ConversationAgentStatusRollupSearchRequest](docs/ConversationAgentStatusRollupSearchRequest.md)
+ - [UltracartClient::ConversationAgentStatusRollupSearchResponse](docs/ConversationAgentStatusRollupSearchResponse.md)
+ - [UltracartClient::ConversationAgentStatusSummaryResponse](docs/ConversationAgentStatusSummaryResponse.md)
+ - [UltracartClient::ConversationAgentStatusTimelineResponse](docs/ConversationAgentStatusTimelineResponse.md)
  - [UltracartClient::ConversationAutocompleteRequest](docs/ConversationAutocompleteRequest.md)
  - [UltracartClient::ConversationAutocompleteResponse](docs/ConversationAutocompleteResponse.md)
  - [UltracartClient::ConversationAutocompleteValue](docs/ConversationAutocompleteValue.md)
@@ -896,6 +923,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationPbxCosAuditLogsResponse](docs/ConversationPbxCosAuditLogsResponse.md)
  - [UltracartClient::ConversationPbxCustomerSnapshotRequest](docs/ConversationPbxCustomerSnapshotRequest.md)
  - [UltracartClient::ConversationPbxCustomerSnapshotResponse](docs/ConversationPbxCustomerSnapshotResponse.md)
+ - [UltracartClient::ConversationPbxDefaultTimezoneResponse](docs/ConversationPbxDefaultTimezoneResponse.md)
+ - [UltracartClient::ConversationPbxDefaultTimezoneUpdateRequest](docs/ConversationPbxDefaultTimezoneUpdateRequest.md)
  - [UltracartClient::ConversationPbxHardwarePhone](docs/ConversationPbxHardwarePhone.md)
  - [UltracartClient::ConversationPbxHardwarePhoneResponse](docs/ConversationPbxHardwarePhoneResponse.md)
  - [UltracartClient::ConversationPbxHardwarePhonesResponse](docs/ConversationPbxHardwarePhonesResponse.md)
@@ -1575,6 +1604,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::TempMultimediaResponse](docs/TempMultimediaResponse.md)
  - [UltracartClient::ThumbnailParametersRequest](docs/ThumbnailParametersRequest.md)
  - [UltracartClient::ThumbnailParametersResponse](docs/ThumbnailParametersResponse.md)
+ - [UltracartClient::TimelineSummary](docs/TimelineSummary.md)
  - [UltracartClient::TransactionEmail](docs/TransactionEmail.md)
  - [UltracartClient::TransactionEmailListResponse](docs/TransactionEmailListResponse.md)
  - [UltracartClient::TransactionEmailOption](docs/TransactionEmailOption.md)
@@ -1698,6 +1728,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.83 | 04/29/2026 | AO support for item appending on cancel request, order payment method test routing on hold release |
+| 4.1.82 | 04/27/2026 | converation - agent status and availability |
+| 4.1.81 | 04/27/2026 | conversations - agent status and availability |
 | 4.1.80 | 04/22/2026 | customer - e.164 read only fields on billing/shipping child objects |
 | 4.1.79 | 04/21/2026 | item - one line per unit flag support |
 | 4.1.78 | 04/20/2026 | conversation pbx - objects have context_merchant_id fields to linked account configs |

data/docs/AgentSummary.md

@@ -0,0 +1,30 @@
+# UltracartClient::AgentSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agent_name** | **String** | Agent display name | [optional] |
+| **agent_user_id** | **String** | Agent user id | [optional] |
+| **availability_pct** | **Object** |  | [optional] |
+| **available_seconds** | **Integer** | Total Available seconds in the range (incl. Busy) | [optional] |
+| **calls_taken** | **Integer** | Calls taken in the range (PBX) | [optional] |
+| **chats_handled** | **Integer** | Chats handled in the range (chat) | [optional] |
+| **total_tracked_seconds** | **Integer** | Total tracked seconds in the range | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AgentSummary.new(
+  agent_name: null,
+  agent_user_id: null,
+  availability_pct: null,
+  available_seconds: null,
+  calls_taken: null,
+  chats_handled: null,
+  total_tracked_seconds: null
+)
+```
+

data/docs/AutoOrderItemCancelRequest.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **auto_order_item_oid** | **Integer** | Optional tiebreaker when more than one item on the auto order shares the same original_item_id.  When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check).  Leave unset for the common case of a unique original_item_id. | [optional] |
+| **append_items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | Specifying these items allows for an easier immutable item contact.  Validation will occur before any operations take place.  After the end/remove operation is successful, append these additional item(s) to the auto order.  The changes will be available in the response if the expansion includes items. | [optional] |
+| **auto_order_item_oid** | **Integer** | Optional tiebreaker when more than one item on the auto order shares the same original_item_id.  When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check).  Leave unset for the common case of a unique original_item_id.  For reference the order_item.item_reference_oid is the same value as auto_order_item.auto_order_item_oid UNLESS the a manual edit took place AFTER the original order was placed. | [optional] |
 | **mode** | **String** | Cancellation mode.  'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting.  'remove' hard-deletes the item from the auto order.  Defaults to 'end' (the less destructive option) when omitted. | [optional] |
 
 ## Example
@@ -13,6 +14,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::AutoOrderItemCancelRequest.new(
+  append_items: null,
   auto_order_item_oid: null,
   mode: null
 )

data/docs/ConversationAgentCallEvent.md

@@ -0,0 +1,30 @@
+# UltracartClient::ConversationAgentCallEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **call_uuid** | **String** | Call UUID | [optional] |
+| **direction** | **String** | Direction | [optional] |
+| **disposition** | **String** | Call disposition (e.g. 'answered', 'missed') | [optional] |
+| **duration_seconds** | **Integer** | Total call duration in seconds | [optional] |
+| **end_dts** | **String** | Call ended | [optional] |
+| **phone_number** | **String** | Counterparty phone number | [optional] |
+| **start_dts** | **String** | Call started | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentCallEvent.new(
+  call_uuid: null,
+  direction: null,
+  disposition: null,
+  duration_seconds: null,
+  end_dts: null,
+  phone_number: null,
+  start_dts: null
+)
+```
+

data/docs/ConversationAgentChatEvent.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationAgentChatEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_uuid** | **String** | Conversation UUID | [optional] |
+| **customer_name** | **String** | Customer display name (when known) | [optional] |
+| **end_dts** | **String** | Chat ended | [optional] |
+| **message_count** | **Integer** | Total messages in the conversation | [optional] |
+| **start_dts** | **String** | Chat started | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentChatEvent.new(
+  conversation_uuid: null,
+  customer_name: null,
+  end_dts: null,
+  message_count: null,
+  start_dts: null
+)
+```
+

data/docs/ConversationAgentStatusConfig.md

@@ -0,0 +1,42 @@
+# UltracartClient::ConversationAgentStatusConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Whether the status is active and selectable. DELETE soft-deactivates by setting this to false. | [optional] |
+| **channel** | **String** | Channel this status applies to | [optional] |
+| **color** | **String** | Hex color for UI (e.g. '#FF5733') | [optional] |
+| **conversation_status_uuid** | **String** | Conversation agent status unique identifier | [optional] |
+| **created_at** | **String** | Created at | [optional] |
+| **icon** | **String** | Icon name | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **name** | **String** | Display name shown to agents | [optional] |
+| **parent_status** | **String** | Channel-native parent status | [optional] |
+| **routing_effect** | **String** | Canonical routing semantic. Derived server-side from (channel, parent_status). | [optional] |
+| **sort_order** | **Integer** | Sort order in lists; lower = first | [optional] |
+| **twilio_activity_sid** | **String** | Twilio TaskRouter Activity SID (PBX-only; null for chat-only statuses) | [optional] |
+| **updated_at** | **String** | Updated at | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusConfig.new(
+  active: null,
+  channel: null,
+  color: null,
+  conversation_status_uuid: null,
+  created_at: null,
+  icon: null,
+  merchant_id: null,
+  name: null,
+  parent_status: null,
+  routing_effect: null,
+  sort_order: null,
+  twilio_activity_sid: null,
+  updated_at: null
+)
+```
+

data/docs/ConversationAgentStatusConfigResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationAgentStatusConfigResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **status_config** | [**ConversationAgentStatusConfig**](ConversationAgentStatusConfig.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusConfigResponse.new(
+  error: null,
+  metadata: null,
+  status_config: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationAgentStatusConfigsResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationAgentStatusConfigsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **status_configs** | [**Array<ConversationAgentStatusConfig>**](ConversationAgentStatusConfig.md) | Agent status configurations | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusConfigsResponse.new(
+  error: null,
+  metadata: null,
+  status_configs: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationAgentStatusEvent.md

@@ -0,0 +1,50 @@
+# UltracartClient::ConversationAgentStatusEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agent_identifier** | **String** | Agent identifier — voice_identity for PBX (e.g. 'client:login'), participant_arn for chat, synthetic 'ai:<user_id>' for AI flag events. Stable across an agent's events; participates in DDB pk and GSI1 sk. | [optional] |
+| **agent_name** | **String** | Agent display name at the time of the event | [optional] |
+| **agent_type** | **String** | Agent type | [optional] |
+| **agent_user_id** | **String** | Agent user id (links across channels) | [optional] |
+| **channel** | **String** | Channel | [optional] |
+| **custom_status_name** | **String** | Custom status name (when applicable) | [optional] |
+| **custom_status_uuid** | **String** | Custom status uuid (when applicable) | [optional] |
+| **duration_in_previous_seconds** | **Integer** | Time spent in the previous status, in seconds | [optional] |
+| **event_dts** | **String** | Event timestamp (ISO 8601) | [optional] |
+| **event_uuid** | **String** | Event UUID (natural key for ES + BQ) | [optional] |
+| **merchant_id** | **String** | Merchant Id | [optional] |
+| **new_routing_effect** | **String** | Canonical new routing semantic | [optional] |
+| **new_status** | **String** | Channel-native new status name | [optional] |
+| **parent_merchant_id** | **String** | Parent merchant id (denormalized for ES routing parity) | [optional] |
+| **previous_routing_effect** | **String** | Canonical previous routing semantic | [optional] |
+| **previous_status** | **String** | Channel-native previous status name | [optional] |
+| **trigger** | **String** | What triggered the transition | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusEvent.new(
+  agent_identifier: null,
+  agent_name: null,
+  agent_type: null,
+  agent_user_id: null,
+  channel: null,
+  custom_status_name: null,
+  custom_status_uuid: null,
+  duration_in_previous_seconds: null,
+  event_dts: null,
+  event_uuid: null,
+  merchant_id: null,
+  new_routing_effect: null,
+  new_status: null,
+  parent_merchant_id: null,
+  previous_routing_effect: null,
+  previous_status: null,
+  trigger: null
+)
+```
+

data/docs/ConversationAgentStatusHeatmapRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::ConversationAgentStatusHeatmapRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **channel** | **String** | Optional channel filter | [optional] |
+| **date_end** | **String** | Range end (YYYY-MM-DD) | [optional] |
+| **date_start** | **String** | Range start (YYYY-MM-DD) | [optional] |
+| **metric** | **String** | Cell metric | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusHeatmapRequest.new(
+  channel: null,
+  date_end: null,
+  date_start: null,
+  metric: null
+)
+```
+

data/docs/ConversationAgentStatusHeatmapResponse.md

@@ -0,0 +1,30 @@
+# UltracartClient::ConversationAgentStatusHeatmapResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agents** | **Array<String>** | Y-axis labels (one per agent) | [optional] |
+| **data** | **Array<Object>** | Sparse cells. Each row is [agent_index, hour, value]; empty cells are omitted. | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **hours** | **Array<Integer>** | X-axis values (hours of day, 0-23) | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusHeatmapResponse.new(
+  agents: null,
+  data: null,
+  error: null,
+  hours: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationAgentStatusHistorySearchRequest.md

@@ -0,0 +1,28 @@
+# UltracartClient::ConversationAgentStatusHistorySearchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agent_user_id** | **String** | Optional agent_user_id filter | [optional] |
+| **channel** | **String** | Optional channel filter | [optional] |
+| **date_end** | **String** | Date range end (ISO 8601 or YYYY-MM-DD) | [optional] |
+| **date_start** | **String** | Date range start (ISO 8601 or YYYY-MM-DD) | [optional] |
+| **status** | **String** | Optional new_status filter | [optional] |
+| **trigger** | **String** | Optional trigger filter | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusHistorySearchRequest.new(
+  agent_user_id: null,
+  channel: null,
+  date_end: null,
+  date_start: null,
+  status: null,
+  trigger: null
+)
+```
+

data/docs/ConversationAgentStatusHistorySearchResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::ConversationAgentStatusHistorySearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **events** | [**Array<ConversationAgentStatusEvent>**](ConversationAgentStatusEvent.md) | Status transition events | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **total** | **Integer** | Total matching events (pre-pagination) | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusHistorySearchResponse.new(
+  error: null,
+  events: null,
+  metadata: null,
+  success: null,
+  total: null,
+  warning: null
+)
+```
+

data/docs/ConversationAgentStatusRollup.md

@@ -0,0 +1,38 @@
+# UltracartClient::ConversationAgentStatusRollup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agent_name** | **String** | Agent display name | [optional] |
+| **agent_user_id** | **String** | Agent user id | [optional] |
+| **availability_pct** | **Object** |  | [optional] |
+| **available_seconds** | **Integer** | Seconds spent Available (incl. Busy per OVERVIEW reporting convention) | [optional] |
+| **calls_taken** | **Integer** | Calls handled by the agent on this day (PBX channel only) | [optional] |
+| **channel** | **String** | Channel | [optional] |
+| **chats_handled** | **Integer** | Chats handled by the agent on this day (chat channel only) | [optional] |
+| **rollup_date** | **String** | Day this rollup covers (YYYY-MM-DD) | [optional] |
+| **status_breakdown** | **Object** | Per-status duration breakdown in seconds (status name -> seconds) | [optional] |
+| **total_tracked_seconds** | **Integer** | Total seconds tracked across all statuses for the day | [optional] |
+| **unavailable_seconds** | **Integer** | Seconds spent Unavailable | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusRollup.new(
+  agent_name: null,
+  agent_user_id: null,
+  availability_pct: null,
+  available_seconds: null,
+  calls_taken: null,
+  channel: null,
+  chats_handled: null,
+  rollup_date: null,
+  status_breakdown: null,
+  total_tracked_seconds: null,
+  unavailable_seconds: null
+)
+```
+

data/docs/ConversationAgentStatusRollupSearchRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::ConversationAgentStatusRollupSearchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **agent_user_id** | **String** | Optional agent_user_id filter | [optional] |
+| **channel** | **String** | Optional channel filter | [optional] |
+| **date_end** | **String** | Date range end (YYYY-MM-DD) | [optional] |
+| **date_start** | **String** | Date range start (YYYY-MM-DD) | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusRollupSearchRequest.new(
+  agent_user_id: null,
+  channel: null,
+  date_end: null,
+  date_start: null
+)
+```
+

data/docs/ConversationAgentStatusRollupSearchResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationAgentStatusRollupSearchResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **rollups** | [**Array<ConversationAgentStatusRollup>**](ConversationAgentStatusRollup.md) | Per-(agent, day, channel) rollups | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentStatusRollupSearchResponse.new(
+  error: null,
+  metadata: null,
+  rollups: null,
+  success: null,
+  warning: null
+)
+```
+