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
data/docs/ConversationAgentStatusSummaryResponse.md ADDED
@@ -0,0 +1,32 @@
1
+ # UltracartClient::ConversationAgentStatusSummaryResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **agents** | [**Array<AgentSummary>**](AgentSummary.md) | Per-agent enriched summary (status totals + activity metrics) | [optional] |
8
+ | **avg_available_pct** | **Object** | | [optional] |
9
+ | **error** | [**Error**](Error.md) | | [optional] |
10
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
11
+ | **status_breakdown** | **Object** | Total seconds-in-status across all agents, keyed by status name | [optional] |
12
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
13
+ | **total_agents** | **Integer** | Distinct agents with at least one transition in the range | [optional] |
14
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ultracart_api'
20
+
21
+ instance = UltracartClient::ConversationAgentStatusSummaryResponse.new(
22
+ agents: null,
23
+ avg_available_pct: null,
24
+ error: null,
25
+ metadata: null,
26
+ status_breakdown: null,
27
+ success: null,
28
+ total_agents: null,
29
+ warning: null
30
+ )
31
+ ```
32
+
data/docs/ConversationAgentStatusTimelineResponse.md ADDED
@@ -0,0 +1,32 @@
1
+ # UltracartClient::ConversationAgentStatusTimelineResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **call_events** | [**Array<ConversationAgentCallEvent>**](ConversationAgentCallEvent.md) | PBX call records for the agent on the requested day | [optional] |
8
+ | **chat_events** | [**Array<ConversationAgentChatEvent>**](ConversationAgentChatEvent.md) | Chat conversations for the agent on the requested day | [optional] |
9
+ | **error** | [**Error**](Error.md) | | [optional] |
10
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
11
+ | **status_events** | [**Array<ConversationAgentStatusEvent>**](ConversationAgentStatusEvent.md) | Status transitions for the agent on the requested day | [optional] |
12
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
13
+ | **summary** | [**TimelineSummary**](TimelineSummary.md) | | [optional] |
14
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ultracart_api'
20
+
21
+ instance = UltracartClient::ConversationAgentStatusTimelineResponse.new(
22
+ call_events: null,
23
+ chat_events: null,
24
+ error: null,
25
+ metadata: null,
26
+ status_events: null,
27
+ success: null,
28
+ summary: null,
29
+ warning: null
30
+ )
31
+ ```
32
+