ultracart_api 4.1.80 → 4.1.83

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +35 -2
  3. data/docs/AgentSummary.md +30 -0
  4. data/docs/AutoOrderItemCancelRequest.md +3 -1
  5. data/docs/ConversationAgentCallEvent.md +30 -0
  6. data/docs/ConversationAgentChatEvent.md +26 -0
  7. data/docs/ConversationAgentStatusConfig.md +42 -0
  8. data/docs/ConversationAgentStatusConfigResponse.md +26 -0
  9. data/docs/ConversationAgentStatusConfigsResponse.md +26 -0
  10. data/docs/ConversationAgentStatusEvent.md +50 -0
  11. data/docs/ConversationAgentStatusHeatmapRequest.md +24 -0
  12. data/docs/ConversationAgentStatusHeatmapResponse.md +30 -0
  13. data/docs/ConversationAgentStatusHistorySearchRequest.md +28 -0
  14. data/docs/ConversationAgentStatusHistorySearchResponse.md +28 -0
  15. data/docs/ConversationAgentStatusRollup.md +38 -0
  16. data/docs/ConversationAgentStatusRollupSearchRequest.md +24 -0
  17. data/docs/ConversationAgentStatusRollupSearchResponse.md +26 -0
  18. data/docs/ConversationAgentStatusSummaryResponse.md +32 -0
  19. data/docs/ConversationAgentStatusTimelineResponse.md +32 -0
  20. data/docs/ConversationApi.md +600 -0
  21. data/docs/ConversationPbxCallAgent.md +2 -0
  22. data/docs/ConversationPbxDefaultTimezoneResponse.md +26 -0
  23. data/docs/ConversationPbxDefaultTimezoneUpdateRequest.md +18 -0
  24. data/docs/ConversationWebchatQueueStatusAgent.md +6 -0
  25. data/docs/ConversationWebchatQueueStatusUpdateRequest.md +5 -1
  26. data/docs/TimelineSummary.md +26 -0
  27. data/lib/ultracart_api/api/conversation_api.rb +766 -2
  28. data/lib/ultracart_api/models/agent_summary.rb +279 -0
  29. data/lib/ultracart_api/models/auto_order_item_cancel_request.rb +14 -2
  30. data/lib/ultracart_api/models/conversation_agent_call_event.rb +314 -0
  31. data/lib/ultracart_api/models/conversation_agent_chat_event.rb +260 -0
  32. data/lib/ultracart_api/models/conversation_agent_status_config.rb +461 -0
  33. data/lib/ultracart_api/models/conversation_agent_status_config_response.rb +256 -0
  34. data/lib/ultracart_api/models/conversation_agent_status_configs_response.rb +259 -0
  35. data/lib/ultracart_api/models/conversation_agent_status_event.rb +522 -0
  36. data/lib/ultracart_api/models/conversation_agent_status_heatmap_request.rb +296 -0
  37. data/lib/ultracart_api/models/conversation_agent_status_heatmap_response.rb +283 -0
  38. data/lib/ultracart_api/models/conversation_agent_status_history_search_request.rb +316 -0
  39. data/lib/ultracart_api/models/conversation_agent_status_history_search_response.rb +269 -0
  40. data/lib/ultracart_api/models/conversation_agent_status_rollup.rb +353 -0
  41. data/lib/ultracart_api/models/conversation_agent_status_rollup_search_request.rb +284 -0
  42. data/lib/ultracart_api/models/conversation_agent_status_rollup_search_response.rb +259 -0
  43. data/lib/ultracart_api/models/conversation_agent_status_summary_response.rb +288 -0
  44. data/lib/ultracart_api/models/conversation_agent_status_timeline_response.rb +292 -0
  45. data/lib/ultracart_api/models/conversation_pbx_call_agent.rb +11 -1
  46. data/lib/ultracart_api/models/conversation_pbx_default_timezone_response.rb +272 -0
  47. data/lib/ultracart_api/models/conversation_pbx_default_timezone_update_request.rb +235 -0
  48. data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +31 -1
  49. data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +24 -4
  50. data/lib/ultracart_api/models/timeline_summary.rb +260 -0
  51. data/lib/ultracart_api/version.rb +1 -1
  52. data/lib/ultracart_api.rb +19 -0
  53. metadata +40 -2
@@ -6,6 +6,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**delete_agent_profile_knowledge_base_document**](ConversationApi.md#delete_agent_profile_knowledge_base_document) | **DELETE** /conversation/agent/profiles/{user_id}/knowledge_base/{document_uuid} | Delete a knowledge base document |
8
8
  | [**delete_agent_profile_mcp**](ConversationApi.md#delete_agent_profile_mcp) | **DELETE** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Delete an agent MCP server |
9
+ | [**delete_agent_status_config**](ConversationApi.md#delete_agent_status_config) | **DELETE** /conversation/agent/status/config/{conversation_status_uuid} | Soft-deactivate a custom agent status |
9
10
  | [**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message |
10
11
  | [**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department |
11
12
  | [**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement |
@@ -29,6 +30,10 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
29
30
  | [**get_agent_profile_mcp_tools**](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 |
30
31
  | [**get_agent_profile_mcps**](ConversationApi.md#get_agent_profile_mcps) | **GET** /conversation/agent/profiles/{user_id}/mcps | Get the list of MCP servers associated with this agent |
31
32
  | [**get_agent_profiles**](ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles |
33
+ | [**get_agent_status_configs**](ConversationApi.md#get_agent_status_configs) | **GET** /conversation/agent/status/config | List custom agent statuses |
34
+ | [**get_agent_status_heatmap**](ConversationApi.md#get_agent_status_heatmap) | **POST** /conversation/agent/status/heatmap | Agent x hour-of-day heatmap |
35
+ | [**get_agent_status_summary**](ConversationApi.md#get_agent_status_summary) | **GET** /conversation/agent/status/rollup/summary | Dashboard summary for a date range |
36
+ | [**get_agent_status_timeline**](ConversationApi.md#get_agent_status_timeline) | **GET** /conversation/agent/status/history/{agent_user_id}/timeline | Day timeline for a single agent |
32
37
  | [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization |
33
38
  | [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation |
34
39
  | [**get_conversation_canned_messages**](ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code |
@@ -62,6 +67,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
62
67
  | [**get_pbx_class_of_service**](ConversationApi.md#get_pbx_class_of_service) | **GET** /conversation/pbx/class_of_service/{classOfServiceUuid} | Get pbx class of service |
63
68
  | [**get_pbx_classes_of_service**](ConversationApi.md#get_pbx_classes_of_service) | **GET** /conversation/pbx/class_of_service | Get pbx classes of service |
64
69
  | [**get_pbx_cos_audit_logs**](ConversationApi.md#get_pbx_cos_audit_logs) | **GET** /conversation/pbx/class_of_service/audit_log | Get pbx class of service audit logs |
70
+ | [**get_pbx_default_timezone**](ConversationApi.md#get_pbx_default_timezone) | **GET** /conversation/pbx/config/default-timezone | Get the merchant default timezone |
65
71
  | [**get_pbx_hardware_phone**](ConversationApi.md#get_pbx_hardware_phone) | **GET** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Get pbx hardware phone |
66
72
  | [**get_pbx_hardware_phone_manufacturers**](ConversationApi.md#get_pbx_hardware_phone_manufacturers) | **GET** /conversation/pbx/hardware_phone/manufacturers | Get pbx hardware phone manufacturers |
67
73
  | [**get_pbx_hardware_phones**](ConversationApi.md#get_pbx_hardware_phones) | **GET** /conversation/pbx/hardware_phone | Get pbx hardware phones |
@@ -86,6 +92,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
86
92
  | [**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities |
87
93
  | [**insert_agent_profile_knowledge_base_document**](ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document |
88
94
  | [**insert_agent_profile_mcp**](ConversationApi.md#insert_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps | Insert an agent MCP server |
95
+ | [**insert_agent_status_config**](ConversationApi.md#insert_agent_status_config) | **POST** /conversation/agent/status/config | Create a custom agent status |
89
96
  | [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message |
90
97
  | [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department |
91
98
  | [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement |
@@ -108,6 +115,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
108
115
  | [**purchase_pbx_phone_number**](ConversationApi.md#purchase_pbx_phone_number) | **POST** /conversation/pbx/phone_number | Purchase pbx phone number |
109
116
  | [**regenerate_password_for_pbx_hardware_phone**](ConversationApi.md#regenerate_password_for_pbx_hardware_phone) | **POST** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid}/regenerate_password | Update pbx hardware phone |
110
117
  | [**reset_conversation_pbx_queue_statistics**](ConversationApi.md#reset_conversation_pbx_queue_statistics) | **POST** /conversation/pbx/queues/{queue_uuid}/reset_statistics | reset statistics within the queue |
118
+ | [**search_agent_status_history**](ConversationApi.md#search_agent_status_history) | **POST** /conversation/agent/status/history/search | Search agent status history |
119
+ | [**search_agent_status_rollups**](ConversationApi.md#search_agent_status_rollups) | **POST** /conversation/agent/status/rollup/search | Search per-(agent, day) rollups |
111
120
  | [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
112
121
  | [**search_pbx_available_phone_numbers**](ConversationApi.md#search_pbx_available_phone_numbers) | **GET** /conversation/pbx/phone_number/search | Search for available phone numbers |
113
122
  | [**search_pbx_calls**](ConversationApi.md#search_pbx_calls) | **POST** /conversation/pbx/call/search | Search pbx call records |
@@ -115,6 +124,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
115
124
  | [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
116
125
  | [**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile |
117
126
  | [**update_agent_profile_mcp**](ConversationApi.md#update_agent_profile_mcp) | **POST** /conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid} | Update an agent MCP server |
127
+ | [**update_agent_status_config**](ConversationApi.md#update_agent_status_config) | **PUT** /conversation/agent/status/config/{conversation_status_uuid} | Update a custom agent status |
118
128
  | [**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message |
119
129
  | [**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department |
120
130
  | [**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement |
@@ -123,6 +133,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
123
133
  | [**update_pbx_agent**](ConversationApi.md#update_pbx_agent) | **PUT** /conversation/pbx/agent/{conversationPbxAgentUuid} | Update pbx agent |
124
134
  | [**update_pbx_audio**](ConversationApi.md#update_pbx_audio) | **PUT** /conversation/pbx/audio/{conversationPbxAudioUuid} | Update pbx audio |
125
135
  | [**update_pbx_class_of_service**](ConversationApi.md#update_pbx_class_of_service) | **PUT** /conversation/pbx/class_of_service/{classOfServiceUuid} | Update pbx class of service |
136
+ | [**update_pbx_default_timezone**](ConversationApi.md#update_pbx_default_timezone) | **PUT** /conversation/pbx/config/default-timezone | Set the merchant default timezone |
126
137
  | [**update_pbx_hardware_phone**](ConversationApi.md#update_pbx_hardware_phone) | **PUT** /conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid} | Update pbx hardware phone |
127
138
  | [**update_pbx_menu**](ConversationApi.md#update_pbx_menu) | **PUT** /conversation/pbx/menu/{conversationPbxMenuUuid} | Update pbx menu |
128
139
  | [**update_pbx_phone_number**](ConversationApi.md#update_pbx_phone_number) | **PUT** /conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid} | Update pbx phoneNumber |
@@ -243,6 +254,59 @@ nil (empty response body)
243
254
  - **Accept**: application/json
244
255
 
245
256
 
257
+ ## delete_agent_status_config
258
+
259
+ > delete_agent_status_config(conversation_status_uuid)
260
+
261
+ Soft-deactivate a custom agent status
262
+
263
+ Sets active=false on the row and the DDB sync record. The Twilio Activity is preserved (Round 2 decision) so historic worker reporting still resolves the SID.
264
+
265
+
266
+ ### Examples
267
+
268
+
269
+ (No example for this operation).
270
+
271
+
272
+ #### Using the delete_agent_status_config_with_http_info variant
273
+
274
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
275
+
276
+ > <Array(nil, Integer, Hash)> delete_agent_status_config_with_http_info(conversation_status_uuid)
277
+
278
+ ```ruby
279
+ begin
280
+ # Soft-deactivate a custom agent status
281
+ data, status_code, headers = api_instance.delete_agent_status_config_with_http_info(conversation_status_uuid)
282
+ p status_code # => 2xx
283
+ p headers # => { ... }
284
+ p data # => nil
285
+ rescue UltracartClient::ApiError => e
286
+ puts "Error when calling ConversationApi->delete_agent_status_config_with_http_info: #{e}"
287
+ end
288
+ ```
289
+
290
+ ### Parameters
291
+
292
+ | Name | Type | Description | Notes |
293
+ | ---- | ---- | ----------- | ----- |
294
+ | **conversation_status_uuid** | **String** | | |
295
+
296
+ ### Return type
297
+
298
+ nil (empty response body)
299
+
300
+ ### Authorization
301
+
302
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
303
+
304
+ ### HTTP request headers
305
+
306
+ - **Content-Type**: Not defined
307
+ - **Accept**: application/json
308
+
309
+
246
310
  ## delete_conversation_canned_message
247
311
 
248
312
  > delete_conversation_canned_message(conversation_canned_message_oid)
@@ -1473,6 +1537,223 @@ This endpoint does not need any parameter.
1473
1537
  - **Accept**: application/json
1474
1538
 
1475
1539
 
1540
+ ## get_agent_status_configs
1541
+
1542
+ > <ConversationAgentStatusConfigsResponse> get_agent_status_configs
1543
+
1544
+ List custom agent statuses
1545
+
1546
+ Returns all custom statuses (active and soft-deactivated) for the merchant.
1547
+
1548
+
1549
+ ### Examples
1550
+
1551
+
1552
+ (No example for this operation).
1553
+
1554
+
1555
+ #### Using the get_agent_status_configs_with_http_info variant
1556
+
1557
+ This returns an Array which contains the response data, status code and headers.
1558
+
1559
+ > <Array(<ConversationAgentStatusConfigsResponse>, Integer, Hash)> get_agent_status_configs_with_http_info
1560
+
1561
+ ```ruby
1562
+ begin
1563
+ # List custom agent statuses
1564
+ data, status_code, headers = api_instance.get_agent_status_configs_with_http_info
1565
+ p status_code # => 2xx
1566
+ p headers # => { ... }
1567
+ p data # => <ConversationAgentStatusConfigsResponse>
1568
+ rescue UltracartClient::ApiError => e
1569
+ puts "Error when calling ConversationApi->get_agent_status_configs_with_http_info: #{e}"
1570
+ end
1571
+ ```
1572
+
1573
+ ### Parameters
1574
+
1575
+ This endpoint does not need any parameter.
1576
+
1577
+ ### Return type
1578
+
1579
+ [**ConversationAgentStatusConfigsResponse**](ConversationAgentStatusConfigsResponse.md)
1580
+
1581
+ ### Authorization
1582
+
1583
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1584
+
1585
+ ### HTTP request headers
1586
+
1587
+ - **Content-Type**: Not defined
1588
+ - **Accept**: application/json
1589
+
1590
+
1591
+ ## get_agent_status_heatmap
1592
+
1593
+ > <ConversationAgentStatusHeatmapResponse> get_agent_status_heatmap(heatmap_request)
1594
+
1595
+ Agent x hour-of-day heatmap
1596
+
1597
+ Returns ECharts-shaped agent x hour grid for the requested metric (availability, call_volume, chat_volume). Multi-day requests average the cell values across the date range.
1598
+
1599
+
1600
+ ### Examples
1601
+
1602
+
1603
+ (No example for this operation).
1604
+
1605
+
1606
+ #### Using the get_agent_status_heatmap_with_http_info variant
1607
+
1608
+ This returns an Array which contains the response data, status code and headers.
1609
+
1610
+ > <Array(<ConversationAgentStatusHeatmapResponse>, Integer, Hash)> get_agent_status_heatmap_with_http_info(heatmap_request)
1611
+
1612
+ ```ruby
1613
+ begin
1614
+ # Agent x hour-of-day heatmap
1615
+ data, status_code, headers = api_instance.get_agent_status_heatmap_with_http_info(heatmap_request)
1616
+ p status_code # => 2xx
1617
+ p headers # => { ... }
1618
+ p data # => <ConversationAgentStatusHeatmapResponse>
1619
+ rescue UltracartClient::ApiError => e
1620
+ puts "Error when calling ConversationApi->get_agent_status_heatmap_with_http_info: #{e}"
1621
+ end
1622
+ ```
1623
+
1624
+ ### Parameters
1625
+
1626
+ | Name | Type | Description | Notes |
1627
+ | ---- | ---- | ----------- | ----- |
1628
+ | **heatmap_request** | [**ConversationAgentStatusHeatmapRequest**](ConversationAgentStatusHeatmapRequest.md) | Heatmap request | |
1629
+
1630
+ ### Return type
1631
+
1632
+ [**ConversationAgentStatusHeatmapResponse**](ConversationAgentStatusHeatmapResponse.md)
1633
+
1634
+ ### Authorization
1635
+
1636
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1637
+
1638
+ ### HTTP request headers
1639
+
1640
+ - **Content-Type**: application/json
1641
+ - **Accept**: application/json
1642
+
1643
+
1644
+ ## get_agent_status_summary
1645
+
1646
+ > <ConversationAgentStatusSummaryResponse> get_agent_status_summary(date_start2, date_end2, opts)
1647
+
1648
+ Dashboard summary for a date range
1649
+
1650
+ Top-line summary: total_agents, avg_available_pct, status_breakdown, per-agent rollups.
1651
+
1652
+
1653
+ ### Examples
1654
+
1655
+
1656
+ (No example for this operation).
1657
+
1658
+
1659
+ #### Using the get_agent_status_summary_with_http_info variant
1660
+
1661
+ This returns an Array which contains the response data, status code and headers.
1662
+
1663
+ > <Array(<ConversationAgentStatusSummaryResponse>, Integer, Hash)> get_agent_status_summary_with_http_info(date_start2, date_end2, opts)
1664
+
1665
+ ```ruby
1666
+ begin
1667
+ # Dashboard summary for a date range
1668
+ data, status_code, headers = api_instance.get_agent_status_summary_with_http_info(date_start2, date_end2, opts)
1669
+ p status_code # => 2xx
1670
+ p headers # => { ... }
1671
+ p data # => <ConversationAgentStatusSummaryResponse>
1672
+ rescue UltracartClient::ApiError => e
1673
+ puts "Error when calling ConversationApi->get_agent_status_summary_with_http_info: #{e}"
1674
+ end
1675
+ ```
1676
+
1677
+ ### Parameters
1678
+
1679
+ | Name | Type | Description | Notes |
1680
+ | ---- | ---- | ----------- | ----- |
1681
+ | **date_start2** | **String** | Range start (YYYY-MM-DD) | |
1682
+ | **date_end2** | **String** | Range end (YYYY-MM-DD) | |
1683
+ | **date_start** | **String** | | [optional] |
1684
+ | **date_end** | **String** | | [optional] |
1685
+
1686
+ ### Return type
1687
+
1688
+ [**ConversationAgentStatusSummaryResponse**](ConversationAgentStatusSummaryResponse.md)
1689
+
1690
+ ### Authorization
1691
+
1692
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1693
+
1694
+ ### HTTP request headers
1695
+
1696
+ - **Content-Type**: Not defined
1697
+ - **Accept**: application/json
1698
+
1699
+
1700
+ ## get_agent_status_timeline
1701
+
1702
+ > <ConversationAgentStatusTimelineResponse> get_agent_status_timeline(agent_user_id, date2, opts)
1703
+
1704
+ Day timeline for a single agent
1705
+
1706
+ Returns merged status events + PBX calls + chat conversations for the agent on the given date. Omitting the channel parameter returns both channels merged.
1707
+
1708
+
1709
+ ### Examples
1710
+
1711
+
1712
+ (No example for this operation).
1713
+
1714
+
1715
+ #### Using the get_agent_status_timeline_with_http_info variant
1716
+
1717
+ This returns an Array which contains the response data, status code and headers.
1718
+
1719
+ > <Array(<ConversationAgentStatusTimelineResponse>, Integer, Hash)> get_agent_status_timeline_with_http_info(agent_user_id, date2, opts)
1720
+
1721
+ ```ruby
1722
+ begin
1723
+ # Day timeline for a single agent
1724
+ data, status_code, headers = api_instance.get_agent_status_timeline_with_http_info(agent_user_id, date2, opts)
1725
+ p status_code # => 2xx
1726
+ p headers # => { ... }
1727
+ p data # => <ConversationAgentStatusTimelineResponse>
1728
+ rescue UltracartClient::ApiError => e
1729
+ puts "Error when calling ConversationApi->get_agent_status_timeline_with_http_info: #{e}"
1730
+ end
1731
+ ```
1732
+
1733
+ ### Parameters
1734
+
1735
+ | Name | Type | Description | Notes |
1736
+ | ---- | ---- | ----------- | ----- |
1737
+ | **agent_user_id** | **String** | | |
1738
+ | **date2** | **String** | Day to retrieve (YYYY-MM-DD) | |
1739
+ | **date** | **String** | | [optional] |
1740
+ | **channel** | **String** | | [optional] |
1741
+ | **channel2** | **String** | Restrict to one channel (omit for both) | [optional] |
1742
+
1743
+ ### Return type
1744
+
1745
+ [**ConversationAgentStatusTimelineResponse**](ConversationAgentStatusTimelineResponse.md)
1746
+
1747
+ ### Authorization
1748
+
1749
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1750
+
1751
+ ### HTTP request headers
1752
+
1753
+ - **Content-Type**: Not defined
1754
+ - **Accept**: application/json
1755
+
1756
+
1476
1757
  ## get_agent_websocket_authorization
1477
1758
 
1478
1759
  > <ConversationAgentAuthResponse> get_agent_websocket_authorization
@@ -3231,6 +3512,57 @@ end
3231
3512
  - **Accept**: application/json
3232
3513
 
3233
3514
 
3515
+ ## get_pbx_default_timezone
3516
+
3517
+ > <ConversationPbxDefaultTimezoneResponse> get_pbx_default_timezone
3518
+
3519
+ Get the merchant default timezone
3520
+
3521
+ Returns the merchant's stored default timezone (IANA name). Falls back to America/New_York when unset.
3522
+
3523
+
3524
+ ### Examples
3525
+
3526
+
3527
+ (No example for this operation).
3528
+
3529
+
3530
+ #### Using the get_pbx_default_timezone_with_http_info variant
3531
+
3532
+ This returns an Array which contains the response data, status code and headers.
3533
+
3534
+ > <Array(<ConversationPbxDefaultTimezoneResponse>, Integer, Hash)> get_pbx_default_timezone_with_http_info
3535
+
3536
+ ```ruby
3537
+ begin
3538
+ # Get the merchant default timezone
3539
+ data, status_code, headers = api_instance.get_pbx_default_timezone_with_http_info
3540
+ p status_code # => 2xx
3541
+ p headers # => { ... }
3542
+ p data # => <ConversationPbxDefaultTimezoneResponse>
3543
+ rescue UltracartClient::ApiError => e
3544
+ puts "Error when calling ConversationApi->get_pbx_default_timezone_with_http_info: #{e}"
3545
+ end
3546
+ ```
3547
+
3548
+ ### Parameters
3549
+
3550
+ This endpoint does not need any parameter.
3551
+
3552
+ ### Return type
3553
+
3554
+ [**ConversationPbxDefaultTimezoneResponse**](ConversationPbxDefaultTimezoneResponse.md)
3555
+
3556
+ ### Authorization
3557
+
3558
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3559
+
3560
+ ### HTTP request headers
3561
+
3562
+ - **Content-Type**: Not defined
3563
+ - **Accept**: application/json
3564
+
3565
+
3234
3566
  ## get_pbx_hardware_phone
3235
3567
 
3236
3568
  > <ConversationPbxHardwarePhoneResponse> get_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid)
@@ -4496,6 +4828,59 @@ end
4496
4828
  - **Accept**: application/json
4497
4829
 
4498
4830
 
4831
+ ## insert_agent_status_config
4832
+
4833
+ > <ConversationAgentStatusConfigResponse> insert_agent_status_config(status_config)
4834
+
4835
+ Create a custom agent status
4836
+
4837
+ Create a custom status. Enforces a 20-active-status-per-merchant cap and the 50-Twilio-Activity-per-workspace cap.
4838
+
4839
+
4840
+ ### Examples
4841
+
4842
+
4843
+ (No example for this operation).
4844
+
4845
+
4846
+ #### Using the insert_agent_status_config_with_http_info variant
4847
+
4848
+ This returns an Array which contains the response data, status code and headers.
4849
+
4850
+ > <Array(<ConversationAgentStatusConfigResponse>, Integer, Hash)> insert_agent_status_config_with_http_info(status_config)
4851
+
4852
+ ```ruby
4853
+ begin
4854
+ # Create a custom agent status
4855
+ data, status_code, headers = api_instance.insert_agent_status_config_with_http_info(status_config)
4856
+ p status_code # => 2xx
4857
+ p headers # => { ... }
4858
+ p data # => <ConversationAgentStatusConfigResponse>
4859
+ rescue UltracartClient::ApiError => e
4860
+ puts "Error when calling ConversationApi->insert_agent_status_config_with_http_info: #{e}"
4861
+ end
4862
+ ```
4863
+
4864
+ ### Parameters
4865
+
4866
+ | Name | Type | Description | Notes |
4867
+ | ---- | ---- | ----------- | ----- |
4868
+ | **status_config** | [**ConversationAgentStatusConfig**](ConversationAgentStatusConfig.md) | Status config | |
4869
+
4870
+ ### Return type
4871
+
4872
+ [**ConversationAgentStatusConfigResponse**](ConversationAgentStatusConfigResponse.md)
4873
+
4874
+ ### Authorization
4875
+
4876
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
4877
+
4878
+ ### HTTP request headers
4879
+
4880
+ - **Content-Type**: application/json
4881
+ - **Accept**: application/json
4882
+
4883
+
4499
4884
  ## insert_conversation_canned_message
4500
4885
 
4501
4886
  > <ConversationCannedMessageResponse> insert_conversation_canned_message(canned_message)
@@ -5680,6 +6065,114 @@ nil (empty response body)
5680
6065
  - **Accept**: application/json
5681
6066
 
5682
6067
 
6068
+ ## search_agent_status_history
6069
+
6070
+ > <ConversationAgentStatusHistorySearchResponse> search_agent_status_history(search_request, opts)
6071
+
6072
+ Search agent status history
6073
+
6074
+ Paginated search over conversation_agent_status_events_all. Filters: agent_user_id, channel, status, trigger, date range.
6075
+
6076
+
6077
+ ### Examples
6078
+
6079
+
6080
+ (No example for this operation).
6081
+
6082
+
6083
+ #### Using the search_agent_status_history_with_http_info variant
6084
+
6085
+ This returns an Array which contains the response data, status code and headers.
6086
+
6087
+ > <Array(<ConversationAgentStatusHistorySearchResponse>, Integer, Hash)> search_agent_status_history_with_http_info(search_request, opts)
6088
+
6089
+ ```ruby
6090
+ begin
6091
+ # Search agent status history
6092
+ data, status_code, headers = api_instance.search_agent_status_history_with_http_info(search_request, opts)
6093
+ p status_code # => 2xx
6094
+ p headers # => { ... }
6095
+ p data # => <ConversationAgentStatusHistorySearchResponse>
6096
+ rescue UltracartClient::ApiError => e
6097
+ puts "Error when calling ConversationApi->search_agent_status_history_with_http_info: #{e}"
6098
+ end
6099
+ ```
6100
+
6101
+ ### Parameters
6102
+
6103
+ | Name | Type | Description | Notes |
6104
+ | ---- | ---- | ----------- | ----- |
6105
+ | **search_request** | [**ConversationAgentStatusHistorySearchRequest**](ConversationAgentStatusHistorySearchRequest.md) | Search request | |
6106
+ | **_limit** | **Integer** | Maximum records per call (max 200) | [optional][default to 100] |
6107
+ | **_offset** | **Integer** | Pagination offset (zero-based) | [optional][default to 0] |
6108
+
6109
+ ### Return type
6110
+
6111
+ [**ConversationAgentStatusHistorySearchResponse**](ConversationAgentStatusHistorySearchResponse.md)
6112
+
6113
+ ### Authorization
6114
+
6115
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6116
+
6117
+ ### HTTP request headers
6118
+
6119
+ - **Content-Type**: application/json
6120
+ - **Accept**: application/json
6121
+
6122
+
6123
+ ## search_agent_status_rollups
6124
+
6125
+ > <ConversationAgentStatusRollupSearchResponse> search_agent_status_rollups(search_request)
6126
+
6127
+ Search per-(agent, day) rollups
6128
+
6129
+ Aggregated over conversation_agent_status_events_all via date_histogram + terms. Returns one row per (agent, day, channel).
6130
+
6131
+
6132
+ ### Examples
6133
+
6134
+
6135
+ (No example for this operation).
6136
+
6137
+
6138
+ #### Using the search_agent_status_rollups_with_http_info variant
6139
+
6140
+ This returns an Array which contains the response data, status code and headers.
6141
+
6142
+ > <Array(<ConversationAgentStatusRollupSearchResponse>, Integer, Hash)> search_agent_status_rollups_with_http_info(search_request)
6143
+
6144
+ ```ruby
6145
+ begin
6146
+ # Search per-(agent, day) rollups
6147
+ data, status_code, headers = api_instance.search_agent_status_rollups_with_http_info(search_request)
6148
+ p status_code # => 2xx
6149
+ p headers # => { ... }
6150
+ p data # => <ConversationAgentStatusRollupSearchResponse>
6151
+ rescue UltracartClient::ApiError => e
6152
+ puts "Error when calling ConversationApi->search_agent_status_rollups_with_http_info: #{e}"
6153
+ end
6154
+ ```
6155
+
6156
+ ### Parameters
6157
+
6158
+ | Name | Type | Description | Notes |
6159
+ | ---- | ---- | ----------- | ----- |
6160
+ | **search_request** | [**ConversationAgentStatusRollupSearchRequest**](ConversationAgentStatusRollupSearchRequest.md) | Search request | |
6161
+
6162
+ ### Return type
6163
+
6164
+ [**ConversationAgentStatusRollupSearchResponse**](ConversationAgentStatusRollupSearchResponse.md)
6165
+
6166
+ ### Authorization
6167
+
6168
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6169
+
6170
+ ### HTTP request headers
6171
+
6172
+ - **Content-Type**: application/json
6173
+ - **Accept**: application/json
6174
+
6175
+
5683
6176
  ## search_conversation_canned_messages
5684
6177
 
5685
6178
  > <ConversationCannedMessagesResponse> search_conversation_canned_messages(search_request)
@@ -6066,6 +6559,60 @@ end
6066
6559
  - **Accept**: application/json
6067
6560
 
6068
6561
 
6562
+ ## update_agent_status_config
6563
+
6564
+ > <ConversationAgentStatusConfigResponse> update_agent_status_config(conversation_status_uuid, status_config)
6565
+
6566
+ Update a custom agent status
6567
+
6568
+ Update a custom status. Renaming flows through to the Twilio Activity.
6569
+
6570
+
6571
+ ### Examples
6572
+
6573
+
6574
+ (No example for this operation).
6575
+
6576
+
6577
+ #### Using the update_agent_status_config_with_http_info variant
6578
+
6579
+ This returns an Array which contains the response data, status code and headers.
6580
+
6581
+ > <Array(<ConversationAgentStatusConfigResponse>, Integer, Hash)> update_agent_status_config_with_http_info(conversation_status_uuid, status_config)
6582
+
6583
+ ```ruby
6584
+ begin
6585
+ # Update a custom agent status
6586
+ data, status_code, headers = api_instance.update_agent_status_config_with_http_info(conversation_status_uuid, status_config)
6587
+ p status_code # => 2xx
6588
+ p headers # => { ... }
6589
+ p data # => <ConversationAgentStatusConfigResponse>
6590
+ rescue UltracartClient::ApiError => e
6591
+ puts "Error when calling ConversationApi->update_agent_status_config_with_http_info: #{e}"
6592
+ end
6593
+ ```
6594
+
6595
+ ### Parameters
6596
+
6597
+ | Name | Type | Description | Notes |
6598
+ | ---- | ---- | ----------- | ----- |
6599
+ | **conversation_status_uuid** | **String** | | |
6600
+ | **status_config** | [**ConversationAgentStatusConfig**](ConversationAgentStatusConfig.md) | Status config | |
6601
+
6602
+ ### Return type
6603
+
6604
+ [**ConversationAgentStatusConfigResponse**](ConversationAgentStatusConfigResponse.md)
6605
+
6606
+ ### Authorization
6607
+
6608
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
6609
+
6610
+ ### HTTP request headers
6611
+
6612
+ - **Content-Type**: application/json
6613
+ - **Accept**: application/json
6614
+
6615
+
6069
6616
  ## update_conversation_canned_message
6070
6617
 
6071
6618
  > <ConversationCannedMessageResponse> update_conversation_canned_message(conversation_canned_message_oid, canned_message)
@@ -6504,6 +7051,59 @@ end
6504
7051
  - **Accept**: application/json
6505
7052
 
6506
7053
 
7054
+ ## update_pbx_default_timezone
7055
+
7056
+ > <ConversationPbxDefaultTimezoneResponse> update_pbx_default_timezone(timezone_update)
7057
+
7058
+ Set the merchant default timezone
7059
+
7060
+ Persists the IANA timezone on the Config#<merchant_id>/default DDB record (creates on first PUT).
7061
+
7062
+
7063
+ ### Examples
7064
+
7065
+
7066
+ (No example for this operation).
7067
+
7068
+
7069
+ #### Using the update_pbx_default_timezone_with_http_info variant
7070
+
7071
+ This returns an Array which contains the response data, status code and headers.
7072
+
7073
+ > <Array(<ConversationPbxDefaultTimezoneResponse>, Integer, Hash)> update_pbx_default_timezone_with_http_info(timezone_update)
7074
+
7075
+ ```ruby
7076
+ begin
7077
+ # Set the merchant default timezone
7078
+ data, status_code, headers = api_instance.update_pbx_default_timezone_with_http_info(timezone_update)
7079
+ p status_code # => 2xx
7080
+ p headers # => { ... }
7081
+ p data # => <ConversationPbxDefaultTimezoneResponse>
7082
+ rescue UltracartClient::ApiError => e
7083
+ puts "Error when calling ConversationApi->update_pbx_default_timezone_with_http_info: #{e}"
7084
+ end
7085
+ ```
7086
+
7087
+ ### Parameters
7088
+
7089
+ | Name | Type | Description | Notes |
7090
+ | ---- | ---- | ----------- | ----- |
7091
+ | **timezone_update** | [**ConversationPbxDefaultTimezoneUpdateRequest**](ConversationPbxDefaultTimezoneUpdateRequest.md) | Timezone update | |
7092
+
7093
+ ### Return type
7094
+
7095
+ [**ConversationPbxDefaultTimezoneResponse**](ConversationPbxDefaultTimezoneResponse.md)
7096
+
7097
+ ### Authorization
7098
+
7099
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
7100
+
7101
+ ### HTTP request headers
7102
+
7103
+ - **Content-Type**: application/json
7104
+ - **Accept**: application/json
7105
+
7106
+
6507
7107
  ## update_pbx_hardware_phone
6508
7108
 
6509
7109
  > <ConversationPbxHardwarePhoneResponse> update_pbx_hardware_phone(conversation_pbx_hardware_phone_uuid, pbx_hardware_phone)