ultracart_api 4.0.96.rc → 4.0.98.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +25 -4
- data/docs/ConversationApi.md +583 -5
- data/docs/ConversationAutocompleteRequest.md +20 -0
- data/docs/ConversationAutocompleteResponse.md +30 -0
- data/docs/ConversationCannedMessage.md +1 -1
- data/docs/ConversationDepartment.md +26 -0
- data/docs/ConversationDepartmentResponse.md +26 -0
- data/docs/ConversationDepartmentsResponse.md +26 -0
- data/docs/ConversationEngagement.md +30 -0
- data/docs/ConversationEngagementResponse.md +26 -0
- data/docs/ConversationEngagementsResponse.md +26 -0
- data/docs/ConversationJoinRequest.md +18 -0
- data/docs/ConversationParticipant.md +4 -0
- data/docs/ConversationSearchRequest.md +36 -0
- data/docs/ConversationSearchResponse.md +22 -0
- data/docs/ConversationWebchatQueueStatusQueueEntry.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +550 -1
- data/lib/ultracart_api/models/conversation_autocomplete_request.rb +228 -0
- data/lib/ultracart_api/models/conversation_autocomplete_response.rb +276 -0
- data/lib/ultracart_api/models/conversation_canned_message.rb +1 -1
- data/lib/ultracart_api/models/conversation_department.rb +255 -0
- data/lib/ultracart_api/models/conversation_department_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_departments_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_engagement.rb +275 -0
- data/lib/ultracart_api/models/conversation_engagement_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_engagements_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_join_request.rb +219 -0
- data/lib/ultracart_api/models/conversation_participant.rb +19 -1
- data/lib/ultracart_api/models/conversation_search_request.rb +300 -0
- data/lib/ultracart_api/models/conversation_search_response.rb +237 -0
- data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +11 -0
- metadata +24 -2
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::ConversationAutocompleteResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
8
|
+
| **field** | **String** | | [optional] |
|
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
10
|
+
| **results** | **Array<String>** | | [optional] |
|
|
11
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
12
|
+
| **term** | **String** | | [optional] |
|
|
13
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::ConversationAutocompleteResponse.new(
|
|
21
|
+
error: null,
|
|
22
|
+
field: null,
|
|
23
|
+
metadata: null,
|
|
24
|
+
results: null,
|
|
25
|
+
success: null,
|
|
26
|
+
term: null,
|
|
27
|
+
warning: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **canned_message** | **String** | | [optional] |
|
|
8
8
|
| **conversation_canned_message_oid** | **Integer** | | [optional] |
|
|
9
|
-
| **conversation_department_oids** | **Array<
|
|
9
|
+
| **conversation_department_oids** | **Array<Integer>** | | [optional] |
|
|
10
10
|
| **short_code** | **String** | | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationDepartment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **conversation_department_oid** | **Integer** | | [optional] |
|
|
8
|
+
| **delete_me** | **Boolean** | | [optional] |
|
|
9
|
+
| **department_name** | **String** | | [optional] |
|
|
10
|
+
| **merchant_id** | **String** | | [optional] |
|
|
11
|
+
| **settings** | **Object** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::ConversationDepartment.new(
|
|
19
|
+
conversation_department_oid: null,
|
|
20
|
+
delete_me: null,
|
|
21
|
+
department_name: null,
|
|
22
|
+
merchant_id: null,
|
|
23
|
+
settings: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationDepartmentResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **conversation_department** | [**ConversationDepartment**](ConversationDepartment.md) | | [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::ConversationDepartmentResponse.new(
|
|
19
|
+
conversation_department: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationDepartmentsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **conversation_departments** | [**Array<ConversationDepartment>**](ConversationDepartment.md) | | [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::ConversationDepartmentsResponse.new(
|
|
19
|
+
conversation_departments: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::ConversationEngagement
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **conversation_engagement_oid** | **Integer** | | [optional] |
|
|
8
|
+
| **customer_greeting** | **String** | | [optional] |
|
|
9
|
+
| **department_oids** | **Array<Integer>** | | [optional] |
|
|
10
|
+
| **engagement_name** | **String** | | [optional] |
|
|
11
|
+
| **equation** | **Object** | | [optional] |
|
|
12
|
+
| **time_on_page** | **Integer** | | [optional] |
|
|
13
|
+
| **visitor_type** | **String** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::ConversationEngagement.new(
|
|
21
|
+
conversation_engagement_oid: null,
|
|
22
|
+
customer_greeting: null,
|
|
23
|
+
department_oids: null,
|
|
24
|
+
engagement_name: null,
|
|
25
|
+
equation: null,
|
|
26
|
+
time_on_page: null,
|
|
27
|
+
visitor_type: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationEngagementResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **conversation_engagement** | [**ConversationEngagement**](ConversationEngagement.md) | | [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::ConversationEngagementResponse.new(
|
|
19
|
+
conversation_engagement: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationEngagementsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **conversation_engagements** | [**Array<ConversationEngagement>**](ConversationEngagement.md) | | [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::ConversationEngagementsResponse.new(
|
|
19
|
+
conversation_engagements: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::ConversationJoinRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **participant_language_iso_code** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::ConversationJoinRequest.new(
|
|
15
|
+
participant_language_iso_code: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -7,11 +7,13 @@
|
|
|
7
7
|
| **conversation_participant_arn** | **String** | | [optional] |
|
|
8
8
|
| **conversation_participant_name** | **String** | | [optional] |
|
|
9
9
|
| **conversation_participant_uuid** | **String** | | [optional] |
|
|
10
|
+
| **email** | **String** | | [optional] |
|
|
10
11
|
| **joined_dts** | **String** | Joined conversation date/time | [optional] |
|
|
11
12
|
| **language_iso_code** | **String** | | [optional] |
|
|
12
13
|
| **last_message_dts** | **String** | Last message date/time | [optional] |
|
|
13
14
|
| **left_dts** | **String** | Left conversation date/time | [optional] |
|
|
14
15
|
| **profile_image_url** | **String** | | [optional] |
|
|
16
|
+
| **sms_phone_number** | **String** | | [optional] |
|
|
15
17
|
| **status** | **String** | | [optional] |
|
|
16
18
|
| **timezone** | **String** | | [optional] |
|
|
17
19
|
| **unread_messages** | **Integer** | | [optional] |
|
|
@@ -25,11 +27,13 @@ instance = UltracartClient::ConversationParticipant.new(
|
|
|
25
27
|
conversation_participant_arn: null,
|
|
26
28
|
conversation_participant_name: null,
|
|
27
29
|
conversation_participant_uuid: null,
|
|
30
|
+
email: null,
|
|
28
31
|
joined_dts: null,
|
|
29
32
|
language_iso_code: null,
|
|
30
33
|
last_message_dts: null,
|
|
31
34
|
left_dts: null,
|
|
32
35
|
profile_image_url: null,
|
|
36
|
+
sms_phone_number: null,
|
|
33
37
|
status: null,
|
|
34
38
|
timezone: null,
|
|
35
39
|
unread_messages: null
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# UltracartClient::ConversationSearchRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email_filter** | **String** | | [optional] |
|
|
8
|
+
| **language_filter** | **String** | | [optional] |
|
|
9
|
+
| **medium_filter** | **String** | | [optional] |
|
|
10
|
+
| **order_by_newest** | **Boolean** | | [optional] |
|
|
11
|
+
| **order_by_oldest** | **Boolean** | | [optional] |
|
|
12
|
+
| **range_begin** | **Integer** | | [optional] |
|
|
13
|
+
| **range_end** | **Integer** | | [optional] |
|
|
14
|
+
| **sms_phone_number_filter** | **String** | | [optional] |
|
|
15
|
+
| **text_search** | **String** | | [optional] |
|
|
16
|
+
| **visible_filter** | **Boolean** | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
|
|
23
|
+
instance = UltracartClient::ConversationSearchRequest.new(
|
|
24
|
+
email_filter: null,
|
|
25
|
+
language_filter: null,
|
|
26
|
+
medium_filter: null,
|
|
27
|
+
order_by_newest: null,
|
|
28
|
+
order_by_oldest: null,
|
|
29
|
+
range_begin: null,
|
|
30
|
+
range_end: null,
|
|
31
|
+
sms_phone_number_filter: null,
|
|
32
|
+
text_search: null,
|
|
33
|
+
visible_filter: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::ConversationSearchResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **range_begin** | **Integer** | | [optional] |
|
|
8
|
+
| **range_end** | **Integer** | | [optional] |
|
|
9
|
+
| **total** | **Integer** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::ConversationSearchResponse.new(
|
|
17
|
+
range_begin: null,
|
|
18
|
+
range_end: null,
|
|
19
|
+
total: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **conversation_webchat_queue_uuid** | **String** | | [optional] |
|
|
10
10
|
| **email** | **String** | | [optional] |
|
|
11
11
|
| **join_dts** | **String** | Date/time the customer joined the queue | [optional] |
|
|
12
|
+
| **participant_language_iso_code** | **String** | | [optional] |
|
|
12
13
|
| **question** | **String** | | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
@@ -22,6 +23,7 @@ instance = UltracartClient::ConversationWebchatQueueStatusQueueEntry.new(
|
|
|
22
23
|
conversation_webchat_queue_uuid: null,
|
|
23
24
|
email: null,
|
|
24
25
|
join_dts: null,
|
|
26
|
+
participant_language_iso_code: null,
|
|
25
27
|
question: null
|
|
26
28
|
)
|
|
27
29
|
```
|