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.
- checksums.yaml +4 -4
- data/README.md +35 -2
- data/docs/AgentSummary.md +30 -0
- data/docs/AutoOrderItemCancelRequest.md +3 -1
- data/docs/ConversationAgentCallEvent.md +30 -0
- data/docs/ConversationAgentChatEvent.md +26 -0
- data/docs/ConversationAgentStatusConfig.md +42 -0
- data/docs/ConversationAgentStatusConfigResponse.md +26 -0
- data/docs/ConversationAgentStatusConfigsResponse.md +26 -0
- data/docs/ConversationAgentStatusEvent.md +50 -0
- data/docs/ConversationAgentStatusHeatmapRequest.md +24 -0
- data/docs/ConversationAgentStatusHeatmapResponse.md +30 -0
- data/docs/ConversationAgentStatusHistorySearchRequest.md +28 -0
- data/docs/ConversationAgentStatusHistorySearchResponse.md +28 -0
- data/docs/ConversationAgentStatusRollup.md +38 -0
- data/docs/ConversationAgentStatusRollupSearchRequest.md +24 -0
- data/docs/ConversationAgentStatusRollupSearchResponse.md +26 -0
- data/docs/ConversationAgentStatusSummaryResponse.md +32 -0
- data/docs/ConversationAgentStatusTimelineResponse.md +32 -0
- data/docs/ConversationApi.md +600 -0
- data/docs/ConversationPbxCallAgent.md +2 -0
- data/docs/ConversationPbxDefaultTimezoneResponse.md +26 -0
- data/docs/ConversationPbxDefaultTimezoneUpdateRequest.md +18 -0
- data/docs/ConversationWebchatQueueStatusAgent.md +6 -0
- data/docs/ConversationWebchatQueueStatusUpdateRequest.md +5 -1
- data/docs/TimelineSummary.md +26 -0
- data/lib/ultracart_api/api/conversation_api.rb +766 -2
- data/lib/ultracart_api/models/agent_summary.rb +279 -0
- data/lib/ultracart_api/models/auto_order_item_cancel_request.rb +14 -2
- data/lib/ultracart_api/models/conversation_agent_call_event.rb +314 -0
- data/lib/ultracart_api/models/conversation_agent_chat_event.rb +260 -0
- data/lib/ultracart_api/models/conversation_agent_status_config.rb +461 -0
- data/lib/ultracart_api/models/conversation_agent_status_config_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_agent_status_configs_response.rb +259 -0
- data/lib/ultracart_api/models/conversation_agent_status_event.rb +522 -0
- data/lib/ultracart_api/models/conversation_agent_status_heatmap_request.rb +296 -0
- data/lib/ultracart_api/models/conversation_agent_status_heatmap_response.rb +283 -0
- data/lib/ultracart_api/models/conversation_agent_status_history_search_request.rb +316 -0
- data/lib/ultracart_api/models/conversation_agent_status_history_search_response.rb +269 -0
- data/lib/ultracart_api/models/conversation_agent_status_rollup.rb +353 -0
- data/lib/ultracart_api/models/conversation_agent_status_rollup_search_request.rb +284 -0
- data/lib/ultracart_api/models/conversation_agent_status_rollup_search_response.rb +259 -0
- data/lib/ultracart_api/models/conversation_agent_status_summary_response.rb +288 -0
- data/lib/ultracart_api/models/conversation_agent_status_timeline_response.rb +292 -0
- data/lib/ultracart_api/models/conversation_pbx_call_agent.rb +11 -1
- data/lib/ultracart_api/models/conversation_pbx_default_timezone_response.rb +272 -0
- data/lib/ultracart_api/models/conversation_pbx_default_timezone_update_request.rb +235 -0
- data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb +31 -1
- data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb +24 -4
- data/lib/ultracart_api/models/timeline_summary.rb +260 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +19 -0
- metadata +40 -2
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **agent_extension** | **String** | Agent's phone extension | [optional] |
|
|
8
8
|
| **agent_id** | **String** | Unique identifier for the agent | [optional] |
|
|
9
9
|
| **agent_name** | **String** | Display name of the agent | [optional] |
|
|
10
|
+
| **agent_user_id** | **String** | UltraCart user id for the agent (denormalized at index time so reporting endpoints can join on agent_user_id without translating from the agent_id login). | [optional] |
|
|
10
11
|
| **answered** | **Boolean** | Whether the agent answered the call | [optional] |
|
|
11
12
|
| **call_sid** | **String** | Twilio call SID for the agent's call leg | [optional] |
|
|
12
13
|
| **joined_at_dts** | **String** | Timestamp when the agent joined the call | [optional] |
|
|
@@ -23,6 +24,7 @@ instance = UltracartClient::ConversationPbxCallAgent.new(
|
|
|
23
24
|
agent_extension: null,
|
|
24
25
|
agent_id: null,
|
|
25
26
|
agent_name: null,
|
|
27
|
+
agent_user_id: null,
|
|
26
28
|
answered: null,
|
|
27
29
|
call_sid: null,
|
|
28
30
|
joined_at_dts: null,
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxDefaultTimezoneResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **default_timezone** | **String** | Merchant default timezone (IANA name). Falls back to America/New_York when unset. | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::ConversationPbxDefaultTimezoneResponse.new(
|
|
19
|
+
default_timezone: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::ConversationPbxDefaultTimezoneUpdateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **default_timezone** | **String** | Merchant default timezone (IANA name, e.g. 'America/New_York') | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::ConversationPbxDefaultTimezoneUpdateRequest.new(
|
|
15
|
+
default_timezone: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -5,8 +5,11 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **agent_status** | **String** | Status of the agent | [optional] |
|
|
8
|
+
| **agent_user_id** | **String** | Agent user id (populated by Java so the dispatch-scheduler Lambda can read it directly without parsing conversation_participant_arn) | [optional] |
|
|
8
9
|
| **conversation_participant_arn** | **String** | | [optional] |
|
|
9
10
|
| **conversation_participant_name** | **String** | | [optional] |
|
|
11
|
+
| **custom_status_name** | **String** | Active custom status display name for this agent (denormalized) | [optional] |
|
|
12
|
+
| **custom_status_uuid** | **String** | Active custom status uuid for this agent (null when on a system status) | [optional] |
|
|
10
13
|
| **last_chat_dts** | **String** | Date/time that this agent took their last chat | [optional] |
|
|
11
14
|
| **next_round_robin** | **Boolean** | | [optional] |
|
|
12
15
|
| **profile_image_url** | **String** | Profile image URL | [optional] |
|
|
@@ -18,8 +21,11 @@ require 'ultracart_api'
|
|
|
18
21
|
|
|
19
22
|
instance = UltracartClient::ConversationWebchatQueueStatusAgent.new(
|
|
20
23
|
agent_status: null,
|
|
24
|
+
agent_user_id: null,
|
|
21
25
|
conversation_participant_arn: null,
|
|
22
26
|
conversation_participant_name: null,
|
|
27
|
+
custom_status_name: null,
|
|
28
|
+
custom_status_uuid: null,
|
|
23
29
|
last_chat_dts: null,
|
|
24
30
|
next_round_robin: null,
|
|
25
31
|
profile_image_url: null
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **agent_status** | **String** | Status of the agent | [optional] |
|
|
8
|
+
| **custom_status_name** | **String** | Custom status display name (denormalized so the queue panel can render without a config lookup) | [optional] |
|
|
9
|
+
| **custom_status_uuid** | **String** | Custom status uuid (when picking a custom status). Pair with custom_status_name. | [optional] |
|
|
8
10
|
|
|
9
11
|
## Example
|
|
10
12
|
|
|
@@ -12,7 +14,9 @@
|
|
|
12
14
|
require 'ultracart_api'
|
|
13
15
|
|
|
14
16
|
instance = UltracartClient::ConversationWebchatQueueStatusUpdateRequest.new(
|
|
15
|
-
agent_status: null
|
|
17
|
+
agent_status: null,
|
|
18
|
+
custom_status_name: null,
|
|
19
|
+
custom_status_uuid: null
|
|
16
20
|
)
|
|
17
21
|
```
|
|
18
22
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::TimelineSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **available_seconds** | **Integer** | Seconds the agent was Available (incl. Busy) | [optional] |
|
|
8
|
+
| **avg_handle_time_seconds** | **Integer** | Average handle time across calls and chats, in seconds | [optional] |
|
|
9
|
+
| **calls_missed** | **Integer** | Calls the agent missed (inbound, disposition=missed) | [optional] |
|
|
10
|
+
| **calls_taken** | **Integer** | Calls the agent took | [optional] |
|
|
11
|
+
| **chats_handled** | **Integer** | Chats the agent handled | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::TimelineSummary.new(
|
|
19
|
+
available_seconds: null,
|
|
20
|
+
avg_handle_time_seconds: null,
|
|
21
|
+
calls_missed: null,
|
|
22
|
+
calls_taken: null,
|
|
23
|
+
chats_handled: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|