ultracart_api 4.0.33.rc → 4.0.36.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 +26 -4
- data/docs/Activity.md +4 -0
- data/docs/Conversation.md +26 -0
- data/docs/ConversationAgentAuthResponse.md +26 -0
- data/docs/ConversationApi.md +509 -0
- data/docs/ConversationMessage.md +26 -0
- data/docs/ConversationParticipant.md +30 -0
- data/docs/ConversationStartRequest.md +20 -0
- data/docs/ConversationStartResponse.md +20 -0
- data/docs/ConversationSummary.md +34 -0
- data/docs/ConversationsResponse.md +26 -0
- data/docs/CustomerActivity.md +9 -1
- data/docs/CustomerApi.md +77 -0
- data/docs/CustomerMergeRequest.md +20 -0
- data/lib/ultracart_api/api/conversation_api.rb +482 -0
- data/lib/ultracart_api/api/customer_api.rb +78 -0
- data/lib/ultracart_api/models/activity.rb +19 -1
- data/lib/ultracart_api/models/conversation.rb +259 -0
- data/lib/ultracart_api/models/conversation_agent_auth_response.rb +257 -0
- data/lib/ultracart_api/models/conversation_message.rb +258 -0
- data/lib/ultracart_api/models/conversation_participant.rb +276 -0
- data/lib/ultracart_api/models/conversation_start_request.rb +230 -0
- data/lib/ultracart_api/models/conversation_start_response.rb +228 -0
- data/lib/ultracart_api/models/conversation_summary.rb +292 -0
- data/lib/ultracart_api/models/conversations_response.rb +258 -0
- data/lib/ultracart_api/models/customer_activity.rb +40 -4
- data/lib/ultracart_api/models/customer_merge_request.rb +230 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +10 -0
- metadata +22 -2
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **author_conversation_participant_arn** | **String** | | [optional] |
|
8
|
+
| **author_conversation_participant_name** | **String** | | [optional] |
|
9
|
+
| **body** | **String** | | [optional] |
|
10
|
+
| **media_urls** | **Array<String>** | | [optional] |
|
11
|
+
| **message_dts** | **String** | Message date/time | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationMessage.new(
|
19
|
+
author_conversation_participant_arn: null,
|
20
|
+
author_conversation_participant_name: null,
|
21
|
+
body: null,
|
22
|
+
media_urls: null,
|
23
|
+
message_dts: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# UltracartClient::ConversationParticipant
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_participant_arn** | **String** | | [optional] |
|
8
|
+
| **conversation_participant_name** | **String** | | [optional] |
|
9
|
+
| **conversation_participant_uuid** | **String** | | [optional] |
|
10
|
+
| **joined_dts** | **String** | Joined conversation date/time | [optional] |
|
11
|
+
| **last_message_dts** | **String** | Last message date/time | [optional] |
|
12
|
+
| **left_dts** | **String** | Left conversation date/time | [optional] |
|
13
|
+
| **status** | **String** | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ultracart_api'
|
19
|
+
|
20
|
+
instance = UltracartClient::ConversationParticipant.new(
|
21
|
+
conversation_participant_arn: null,
|
22
|
+
conversation_participant_name: null,
|
23
|
+
conversation_participant_uuid: null,
|
24
|
+
joined_dts: null,
|
25
|
+
last_message_dts: null,
|
26
|
+
left_dts: null,
|
27
|
+
status: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ConversationStartRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **add_conversation_participant_arns** | **Array<String>** | | [optional] |
|
8
|
+
| **conversation_arn** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::ConversationStartRequest.new(
|
16
|
+
add_conversation_participant_arns: null,
|
17
|
+
conversation_arn: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ConversationStartResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_arn** | **String** | | [optional] |
|
8
|
+
| **conversation_uuid** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::ConversationStartResponse.new(
|
16
|
+
conversation_arn: null,
|
17
|
+
conversation_uuid: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# UltracartClient::ConversationSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_arn** | **String** | | [optional] |
|
8
|
+
| **conversation_uuid** | **String** | | [optional] |
|
9
|
+
| **last_conversation_message_body** | **String** | | [optional] |
|
10
|
+
| **last_conversation_participant_arn** | **String** | | [optional] |
|
11
|
+
| **last_conversation_participant_name** | **String** | | [optional] |
|
12
|
+
| **last_message_dts** | **String** | Last message date/time | [optional] |
|
13
|
+
| **merchant_id** | **String** | | [optional] |
|
14
|
+
| **message_count** | **Integer** | | [optional] |
|
15
|
+
| **unread_messages** | **Boolean** | | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'ultracart_api'
|
21
|
+
|
22
|
+
instance = UltracartClient::ConversationSummary.new(
|
23
|
+
conversation_arn: null,
|
24
|
+
conversation_uuid: null,
|
25
|
+
last_conversation_message_body: null,
|
26
|
+
last_conversation_participant_arn: null,
|
27
|
+
last_conversation_participant_name: null,
|
28
|
+
last_message_dts: null,
|
29
|
+
merchant_id: null,
|
30
|
+
message_count: null,
|
31
|
+
unread_messages: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversations** | [**Array<ConversationSummary>**](ConversationSummary.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::ConversationsResponse.new(
|
19
|
+
conversations: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/CustomerActivity.md
CHANGED
@@ -5,9 +5,13 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **activities** | [**Array<Activity>**](Activity.md) | | [optional] |
|
8
|
+
| **global_unsubscribed** | **Boolean** | | [optional] |
|
9
|
+
| **global_unsubscribed_dts** | **String** | | [optional] |
|
8
10
|
| **memberships** | [**Array<ListSegmentMembership>**](ListSegmentMembership.md) | | [optional] |
|
9
11
|
| **metrics** | [**Array<Metric>**](Metric.md) | | [optional] |
|
10
12
|
| **properties_list** | [**Array<Property>**](Property.md) | | [optional] |
|
13
|
+
| **spam_complaint** | **Boolean** | | [optional] |
|
14
|
+
| **spam_complaint_dts** | **String** | | [optional] |
|
11
15
|
|
12
16
|
## Example
|
13
17
|
|
@@ -16,9 +20,13 @@ require 'ultracart_api'
|
|
16
20
|
|
17
21
|
instance = UltracartClient::CustomerActivity.new(
|
18
22
|
activities: null,
|
23
|
+
global_unsubscribed: null,
|
24
|
+
global_unsubscribed_dts: null,
|
19
25
|
memberships: null,
|
20
26
|
metrics: null,
|
21
|
-
properties_list: null
|
27
|
+
properties_list: null,
|
28
|
+
spam_complaint: null,
|
29
|
+
spam_complaint_dts: null
|
22
30
|
)
|
23
31
|
```
|
24
32
|
|
data/docs/CustomerApi.md
CHANGED
@@ -17,6 +17,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
17
17
|
| [**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin |
|
18
18
|
| [**get_email_verification_token**](CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address |
|
19
19
|
| [**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer |
|
20
|
+
| [**merge_customer**](CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer |
|
20
21
|
| [**search_customer_profile_values**](CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST) |
|
21
22
|
| [**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer |
|
22
23
|
| [**update_customer_email_lists**](CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer |
|
@@ -1033,6 +1034,82 @@ end
|
|
1033
1034
|
- **Accept**: application/json
|
1034
1035
|
|
1035
1036
|
|
1037
|
+
## merge_customer
|
1038
|
+
|
1039
|
+
> merge_customer(customer_profile_oid, customer, opts)
|
1040
|
+
|
1041
|
+
Merge customer into this customer
|
1042
|
+
|
1043
|
+
Merge customer into this customer.
|
1044
|
+
|
1045
|
+
### Examples
|
1046
|
+
|
1047
|
+
```ruby
|
1048
|
+
require 'time'
|
1049
|
+
require 'ultracart_api'
|
1050
|
+
require 'json'
|
1051
|
+
require 'yaml'
|
1052
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1053
|
+
|
1054
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1055
|
+
# As such, this might not be the best way to use this object.
|
1056
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1057
|
+
|
1058
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1059
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
|
1060
|
+
customer = UltracartClient::CustomerMergeRequest.new # CustomerMergeRequest | Customer to merge into this profile.
|
1061
|
+
opts = {
|
1062
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
1063
|
+
}
|
1064
|
+
|
1065
|
+
begin
|
1066
|
+
# Merge customer into this customer
|
1067
|
+
api_instance.merge_customer(customer_profile_oid, customer, opts)
|
1068
|
+
rescue UltracartClient::ApiError => e
|
1069
|
+
puts "Error when calling CustomerApi->merge_customer: #{e}"
|
1070
|
+
end
|
1071
|
+
```
|
1072
|
+
|
1073
|
+
#### Using the merge_customer_with_http_info variant
|
1074
|
+
|
1075
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1076
|
+
|
1077
|
+
> <Array(nil, Integer, Hash)> merge_customer_with_http_info(customer_profile_oid, customer, opts)
|
1078
|
+
|
1079
|
+
```ruby
|
1080
|
+
begin
|
1081
|
+
# Merge customer into this customer
|
1082
|
+
data, status_code, headers = api_instance.merge_customer_with_http_info(customer_profile_oid, customer, opts)
|
1083
|
+
p status_code # => 2xx
|
1084
|
+
p headers # => { ... }
|
1085
|
+
p data # => nil
|
1086
|
+
rescue UltracartClient::ApiError => e
|
1087
|
+
puts "Error when calling CustomerApi->merge_customer_with_http_info: #{e}"
|
1088
|
+
end
|
1089
|
+
```
|
1090
|
+
|
1091
|
+
### Parameters
|
1092
|
+
|
1093
|
+
| Name | Type | Description | Notes |
|
1094
|
+
| ---- | ---- | ----------- | ----- |
|
1095
|
+
| **customer_profile_oid** | **Integer** | The customer_profile_oid to update. | |
|
1096
|
+
| **customer** | [**CustomerMergeRequest**](CustomerMergeRequest.md) | Customer to merge into this profile. | |
|
1097
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
1098
|
+
|
1099
|
+
### Return type
|
1100
|
+
|
1101
|
+
nil (empty response body)
|
1102
|
+
|
1103
|
+
### Authorization
|
1104
|
+
|
1105
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1106
|
+
|
1107
|
+
### HTTP request headers
|
1108
|
+
|
1109
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1110
|
+
- **Accept**: application/json
|
1111
|
+
|
1112
|
+
|
1036
1113
|
## search_customer_profile_values
|
1037
1114
|
|
1038
1115
|
> <LookupResponse> search_customer_profile_values(lookup_request)
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::CustomerMergeRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **customer_profile_oid** | **Integer** | Customer profile oid to merge | [optional] |
|
8
|
+
| **email** | **String** | Email of the customer profile to merge | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::CustomerMergeRequest.new(
|
16
|
+
customer_profile_oid: null,
|
17
|
+
email: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|