ultracart_api 3.10.18 → 3.10.21
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 +26 -4
- data/docs/Activity.md +2 -0
- data/docs/Conversation.md +12 -0
- data/docs/ConversationAgentAuthResponse.md +12 -0
- data/docs/ConversationApi.md +360 -0
- data/docs/ConversationMessage.md +12 -0
- data/docs/ConversationParticipant.md +14 -0
- data/docs/ConversationStartRequest.md +9 -0
- data/docs/ConversationStartResponse.md +9 -0
- data/docs/ConversationSummary.md +16 -0
- data/docs/ConversationsResponse.md +12 -0
- data/docs/CustomerActivity.md +4 -0
- data/docs/CustomerApi.md +57 -0
- data/docs/CustomerMergeRequest.md +9 -0
- data/lib/ultracart_api/api/conversation_api.rb +412 -0
- data/lib/ultracart_api/api/customer_api.rb +63 -0
- data/lib/ultracart_api/models/activity.rb +19 -1
- data/lib/ultracart_api/models/conversation.rb +224 -0
- data/lib/ultracart_api/models/conversation_agent_auth_response.rb +222 -0
- data/lib/ultracart_api/models/conversation_message.rb +223 -0
- data/lib/ultracart_api/models/conversation_participant.rb +241 -0
- data/lib/ultracart_api/models/conversation_start_request.rb +195 -0
- data/lib/ultracart_api/models/conversation_start_response.rb +193 -0
- data/lib/ultracart_api/models/conversation_summary.rb +257 -0
- data/lib/ultracart_api/models/conversations_response.rb +223 -0
- data/lib/ultracart_api/models/customer_activity.rb +40 -4
- data/lib/ultracart_api/models/customer_merge_request.rb +195 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +10 -0
- metadata +22 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c38d42fb8aa1750dc4b564905fc831a34f209712e9836ce9c3a765627392ecf8
|
4
|
+
data.tar.gz: 13eeb92e656872f30b59cfc2a846fb53b545f92fbac712893dc2281bdfeb7171
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 912827d25b77988d39226206abbd359a03ff6afa693a6842d0506615e2101e2afb2f64cfda3edbbe1307c37d521f838a2558afe3dd47d2a1520b3b2685520faa
|
7
|
+
data.tar.gz: e2610697a9dde0ad25bb05ddab905009aa5d62170cf180093656c2004df206936d66bae218337946f2ffeac657aa675f49fe47f729c9d7aa97680744a71bc39c
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.21
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.21.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.21.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.21'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -125,6 +125,13 @@ Class | Method | HTTP request | Description
|
|
125
125
|
*UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
|
126
126
|
*UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
|
127
127
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
128
|
+
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
129
|
+
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
130
|
+
*UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
131
|
+
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
132
|
+
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
133
|
+
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
134
|
+
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
128
135
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
129
136
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
130
137
|
*UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
|
@@ -157,6 +164,7 @@ Class | Method | HTTP request | Description
|
|
157
164
|
*UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
158
165
|
*UltracartClient::CustomerApi* | [**get_email_verification_token**](docs/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
|
159
166
|
*UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
167
|
+
*UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
|
160
168
|
*UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
|
161
169
|
*UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
162
170
|
*UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
|
@@ -547,6 +555,14 @@ Class | Method | HTTP request | Description
|
|
547
555
|
- [UltracartClient::CheckoutSetupBrowserKeyResponse](docs/CheckoutSetupBrowserKeyResponse.md)
|
548
556
|
- [UltracartClient::CheckoutStateProvinceResponse](docs/CheckoutStateProvinceResponse.md)
|
549
557
|
- [UltracartClient::CityStateZip](docs/CityStateZip.md)
|
558
|
+
- [UltracartClient::Conversation](docs/Conversation.md)
|
559
|
+
- [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
|
560
|
+
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
561
|
+
- [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
|
562
|
+
- [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
|
563
|
+
- [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
|
564
|
+
- [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
|
565
|
+
- [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
|
550
566
|
- [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
|
551
567
|
- [UltracartClient::Country](docs/Country.md)
|
552
568
|
- [UltracartClient::Coupon](docs/Coupon.md)
|
@@ -625,6 +641,7 @@ Class | Method | HTTP request | Description
|
|
625
641
|
- [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
|
626
642
|
- [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
|
627
643
|
- [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
|
644
|
+
- [UltracartClient::CustomerMergeRequest](docs/CustomerMergeRequest.md)
|
628
645
|
- [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
|
629
646
|
- [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
|
630
647
|
- [UltracartClient::CustomerPrivacy](docs/CustomerPrivacy.md)
|
@@ -1093,6 +1110,8 @@ Class | Method | HTTP request | Description
|
|
1093
1110
|
- checkout_write: Allows you to write checkout information.
|
1094
1111
|
- configuration_read: Allows you to read configuration information.
|
1095
1112
|
- configuration_write: Allows you to write configuration information.
|
1113
|
+
- conversation_read: Allows you to read conversation information.
|
1114
|
+
- conversation_write: Allows you to write conversation information.
|
1096
1115
|
- coupon_read: Allows you to read coupon information.
|
1097
1116
|
- coupon_write: Allows you to write coupon information.
|
1098
1117
|
- customer_read: Allows you to read customer information.
|
@@ -1132,6 +1151,9 @@ Not every change is committed to every SDK.
|
|
1132
1151
|
|
1133
1152
|
| Version | Date | Comments |
|
1134
1153
|
| --: | :-: | --- |
|
1154
|
+
| 3.10.21 | 07/18/2022 | twilio dev |
|
1155
|
+
| 3.10.20 | 07/14/2022 | Add channel storefront_oid to the customer activity record |
|
1156
|
+
| 3.10.19 | 07/11/2022 | Customer API - mergeCustomer method |
|
1135
1157
|
| 3.10.18 | 06/23/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
|
1136
1158
|
| 3.10.17 | 06/23/2022 | automation test |
|
1137
1159
|
| 3.10.16 | 06/23/2022 | automation test |
|
data/docs/Activity.md
CHANGED
@@ -4,7 +4,9 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**action** | **String** | | [optional]
|
7
|
+
**channel** | **String** | | [optional]
|
7
8
|
**metric** | **String** | | [optional]
|
9
|
+
**storefront_oid** | **Integer** | | [optional]
|
8
10
|
**subject** | **String** | | [optional]
|
9
11
|
**ts** | **Integer** | | [optional]
|
10
12
|
**type** | **String** | | [optional]
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::Conversation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_arn** | **String** | | [optional]
|
7
|
+
**conversation_uuid** | **String** | | [optional]
|
8
|
+
**merchant_id** | **String** | | [optional]
|
9
|
+
**messages** | [**Array<ConversationMessage>**](ConversationMessage.md) | | [optional]
|
10
|
+
**participants** | [**Array<ConversationParticipant>**](ConversationParticipant.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationAgentAuthResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_participant_arn** | **String** | | [optional]
|
7
|
+
**jwt** | **String** | | [optional]
|
8
|
+
**merchant_id** | **String** | | [optional]
|
9
|
+
**twilio_phone_numbers** | **Array<String>** | | [optional]
|
10
|
+
**websocket_url** | **String** | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,360 @@
|
|
1
|
+
# UltracartClient::ConversationApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
8
|
+
[**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
9
|
+
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
10
|
+
[**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
11
|
+
[**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
12
|
+
[**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
13
|
+
[**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
14
|
+
|
15
|
+
|
16
|
+
# **get_agent_websocket_authorization**
|
17
|
+
> ConversationAgentAuthResponse get_agent_websocket_authorization
|
18
|
+
|
19
|
+
Get agent websocket authorization
|
20
|
+
|
21
|
+
Retrieve a JWT to authorize an agent to make a websocket connection.
|
22
|
+
|
23
|
+
### Example
|
24
|
+
```ruby
|
25
|
+
# load the gem
|
26
|
+
require 'ultracart_api'
|
27
|
+
|
28
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
29
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
30
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
31
|
+
|
32
|
+
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Get agent websocket authorization
|
36
|
+
result = api_instance.get_agent_websocket_authorization
|
37
|
+
p result
|
38
|
+
rescue UltracartClient::ApiError => e
|
39
|
+
puts "Exception when calling ConversationApi->get_agent_websocket_authorization: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
This endpoint does not need any parameter.
|
45
|
+
|
46
|
+
### Return type
|
47
|
+
|
48
|
+
[**ConversationAgentAuthResponse**](ConversationAgentAuthResponse.md)
|
49
|
+
|
50
|
+
### Authorization
|
51
|
+
|
52
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
53
|
+
|
54
|
+
### HTTP request headers
|
55
|
+
|
56
|
+
- **Content-Type**: application/json
|
57
|
+
- **Accept**: application/json
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
# **get_conversation**
|
62
|
+
> Conversation get_conversation(conversation_uuid)
|
63
|
+
|
64
|
+
Retrieve a conversation
|
65
|
+
|
66
|
+
Retrieve a conversation including the participants and messages
|
67
|
+
|
68
|
+
### Example
|
69
|
+
```ruby
|
70
|
+
# load the gem
|
71
|
+
require 'ultracart_api'
|
72
|
+
|
73
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
74
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
75
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
76
|
+
|
77
|
+
|
78
|
+
conversation_uuid = 'conversation_uuid_example' # String |
|
79
|
+
|
80
|
+
|
81
|
+
begin
|
82
|
+
#Retrieve a conversation
|
83
|
+
result = api_instance.get_conversation(conversation_uuid)
|
84
|
+
p result
|
85
|
+
rescue UltracartClient::ApiError => e
|
86
|
+
puts "Exception when calling ConversationApi->get_conversation: #{e}"
|
87
|
+
end
|
88
|
+
```
|
89
|
+
|
90
|
+
### Parameters
|
91
|
+
|
92
|
+
Name | Type | Description | Notes
|
93
|
+
------------- | ------------- | ------------- | -------------
|
94
|
+
**conversation_uuid** | **String**| |
|
95
|
+
|
96
|
+
### Return type
|
97
|
+
|
98
|
+
[**Conversation**](Conversation.md)
|
99
|
+
|
100
|
+
### Authorization
|
101
|
+
|
102
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
103
|
+
|
104
|
+
### HTTP request headers
|
105
|
+
|
106
|
+
- **Content-Type**: application/json
|
107
|
+
- **Accept**: application/json
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
# **get_conversation_multimedia_upload_url**
|
112
|
+
> get_conversation_multimedia_upload_url(extension)
|
113
|
+
|
114
|
+
Get a presigned conersation multimedia upload URL
|
115
|
+
|
116
|
+
Get a presigned conersation multimedia upload URL
|
117
|
+
|
118
|
+
### Example
|
119
|
+
```ruby
|
120
|
+
# load the gem
|
121
|
+
require 'ultracart_api'
|
122
|
+
|
123
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
124
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
125
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
126
|
+
|
127
|
+
|
128
|
+
extension = 'extension_example' # String |
|
129
|
+
|
130
|
+
|
131
|
+
begin
|
132
|
+
#Get a presigned conersation multimedia upload URL
|
133
|
+
api_instance.get_conversation_multimedia_upload_url(extension)
|
134
|
+
rescue UltracartClient::ApiError => e
|
135
|
+
puts "Exception when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
|
136
|
+
end
|
137
|
+
```
|
138
|
+
|
139
|
+
### Parameters
|
140
|
+
|
141
|
+
Name | Type | Description | Notes
|
142
|
+
------------- | ------------- | ------------- | -------------
|
143
|
+
**extension** | **String**| |
|
144
|
+
|
145
|
+
### Return type
|
146
|
+
|
147
|
+
nil (empty response body)
|
148
|
+
|
149
|
+
### Authorization
|
150
|
+
|
151
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
152
|
+
|
153
|
+
### HTTP request headers
|
154
|
+
|
155
|
+
- **Content-Type**: application/json
|
156
|
+
- **Accept**: application/json
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
# **get_conversations**
|
161
|
+
> ConversationsResponse get_conversations(opts)
|
162
|
+
|
163
|
+
Retrieve a list of conversation summaries newest to oldest
|
164
|
+
|
165
|
+
Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
|
166
|
+
|
167
|
+
### Example
|
168
|
+
```ruby
|
169
|
+
# load the gem
|
170
|
+
require 'ultracart_api'
|
171
|
+
|
172
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
173
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
174
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
175
|
+
|
176
|
+
|
177
|
+
opts = {
|
178
|
+
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
179
|
+
_offset: 0 # Integer | Pagination of the record set. Offset is a zero based index.
|
180
|
+
}
|
181
|
+
|
182
|
+
begin
|
183
|
+
#Retrieve a list of conversation summaries newest to oldest
|
184
|
+
result = api_instance.get_conversations(opts)
|
185
|
+
p result
|
186
|
+
rescue UltracartClient::ApiError => e
|
187
|
+
puts "Exception when calling ConversationApi->get_conversations: #{e}"
|
188
|
+
end
|
189
|
+
```
|
190
|
+
|
191
|
+
### Parameters
|
192
|
+
|
193
|
+
Name | Type | Description | Notes
|
194
|
+
------------- | ------------- | ------------- | -------------
|
195
|
+
**_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
|
196
|
+
**_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
|
197
|
+
|
198
|
+
### Return type
|
199
|
+
|
200
|
+
[**ConversationsResponse**](ConversationsResponse.md)
|
201
|
+
|
202
|
+
### Authorization
|
203
|
+
|
204
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
205
|
+
|
206
|
+
### HTTP request headers
|
207
|
+
|
208
|
+
- **Content-Type**: application/json
|
209
|
+
- **Accept**: application/json
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
# **join_conversation**
|
214
|
+
> join_conversation(conversation_uuid)
|
215
|
+
|
216
|
+
Join a conversation
|
217
|
+
|
218
|
+
Join a conversation
|
219
|
+
|
220
|
+
### Example
|
221
|
+
```ruby
|
222
|
+
# load the gem
|
223
|
+
require 'ultracart_api'
|
224
|
+
|
225
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
226
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
227
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
228
|
+
|
229
|
+
|
230
|
+
conversation_uuid = 'conversation_uuid_example' # String |
|
231
|
+
|
232
|
+
|
233
|
+
begin
|
234
|
+
#Join a conversation
|
235
|
+
api_instance.join_conversation(conversation_uuid)
|
236
|
+
rescue UltracartClient::ApiError => e
|
237
|
+
puts "Exception when calling ConversationApi->join_conversation: #{e}"
|
238
|
+
end
|
239
|
+
```
|
240
|
+
|
241
|
+
### Parameters
|
242
|
+
|
243
|
+
Name | Type | Description | Notes
|
244
|
+
------------- | ------------- | ------------- | -------------
|
245
|
+
**conversation_uuid** | **String**| |
|
246
|
+
|
247
|
+
### Return type
|
248
|
+
|
249
|
+
nil (empty response body)
|
250
|
+
|
251
|
+
### Authorization
|
252
|
+
|
253
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
254
|
+
|
255
|
+
### HTTP request headers
|
256
|
+
|
257
|
+
- **Content-Type**: application/json
|
258
|
+
- **Accept**: application/json
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
# **leave_conversation**
|
263
|
+
> leave_conversation(conversation_uuid)
|
264
|
+
|
265
|
+
Leave a conversation
|
266
|
+
|
267
|
+
Leave a conversation
|
268
|
+
|
269
|
+
### Example
|
270
|
+
```ruby
|
271
|
+
# load the gem
|
272
|
+
require 'ultracart_api'
|
273
|
+
|
274
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
275
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
276
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
277
|
+
|
278
|
+
|
279
|
+
conversation_uuid = 'conversation_uuid_example' # String |
|
280
|
+
|
281
|
+
|
282
|
+
begin
|
283
|
+
#Leave a conversation
|
284
|
+
api_instance.leave_conversation(conversation_uuid)
|
285
|
+
rescue UltracartClient::ApiError => e
|
286
|
+
puts "Exception when calling ConversationApi->leave_conversation: #{e}"
|
287
|
+
end
|
288
|
+
```
|
289
|
+
|
290
|
+
### Parameters
|
291
|
+
|
292
|
+
Name | Type | Description | Notes
|
293
|
+
------------- | ------------- | ------------- | -------------
|
294
|
+
**conversation_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**: application/json
|
307
|
+
- **Accept**: application/json
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
# **start_conversation**
|
312
|
+
> ConversationStartResponse start_conversation(start_request)
|
313
|
+
|
314
|
+
Start a conversation
|
315
|
+
|
316
|
+
Start a new conversation
|
317
|
+
|
318
|
+
### Example
|
319
|
+
```ruby
|
320
|
+
# load the gem
|
321
|
+
require 'ultracart_api'
|
322
|
+
|
323
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
324
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
325
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
326
|
+
|
327
|
+
|
328
|
+
start_request = UltracartClient::ConversationStartRequest.new # ConversationStartRequest | Start request
|
329
|
+
|
330
|
+
|
331
|
+
begin
|
332
|
+
#Start a conversation
|
333
|
+
result = api_instance.start_conversation(start_request)
|
334
|
+
p result
|
335
|
+
rescue UltracartClient::ApiError => e
|
336
|
+
puts "Exception when calling ConversationApi->start_conversation: #{e}"
|
337
|
+
end
|
338
|
+
```
|
339
|
+
|
340
|
+
### Parameters
|
341
|
+
|
342
|
+
Name | Type | Description | Notes
|
343
|
+
------------- | ------------- | ------------- | -------------
|
344
|
+
**start_request** | [**ConversationStartRequest**](ConversationStartRequest.md)| Start request |
|
345
|
+
|
346
|
+
### Return type
|
347
|
+
|
348
|
+
[**ConversationStartResponse**](ConversationStartResponse.md)
|
349
|
+
|
350
|
+
### Authorization
|
351
|
+
|
352
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
353
|
+
|
354
|
+
### HTTP request headers
|
355
|
+
|
356
|
+
- **Content-Type**: application/json
|
357
|
+
- **Accept**: application/json
|
358
|
+
|
359
|
+
|
360
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**author_conversation_participant_arn** | **String** | | [optional]
|
7
|
+
**author_conversation_participant_name** | **String** | | [optional]
|
8
|
+
**body** | **String** | | [optional]
|
9
|
+
**media_urls** | **Array<String>** | | [optional]
|
10
|
+
**message_dts** | **String** | Message date/time | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::ConversationParticipant
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_participant_arn** | **String** | | [optional]
|
7
|
+
**conversation_participant_name** | **String** | | [optional]
|
8
|
+
**conversation_participant_uuid** | **String** | | [optional]
|
9
|
+
**joined_dts** | **String** | Joined conversation date/time | [optional]
|
10
|
+
**last_message_dts** | **String** | Last message date/time | [optional]
|
11
|
+
**left_dts** | **String** | Left conversation date/time | [optional]
|
12
|
+
**status** | **String** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::ConversationStartRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**add_conversation_participant_arns** | **Array<String>** | | [optional]
|
7
|
+
**conversation_arn** | **String** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::ConversationStartResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_arn** | **String** | | [optional]
|
7
|
+
**conversation_uuid** | **String** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# UltracartClient::ConversationSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_arn** | **String** | | [optional]
|
7
|
+
**conversation_uuid** | **String** | | [optional]
|
8
|
+
**last_conversation_message_body** | **String** | | [optional]
|
9
|
+
**last_conversation_participant_arn** | **String** | | [optional]
|
10
|
+
**last_conversation_participant_name** | **String** | | [optional]
|
11
|
+
**last_message_dts** | **String** | Last message date/time | [optional]
|
12
|
+
**merchant_id** | **String** | | [optional]
|
13
|
+
**message_count** | **Integer** | | [optional]
|
14
|
+
**unread_messages** | **BOOLEAN** | | [optional]
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversations** | [**Array<ConversationSummary>**](ConversationSummary.md) | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/CustomerActivity.md
CHANGED
@@ -4,8 +4,12 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**activities** | [**Array<Activity>**](Activity.md) | | [optional]
|
7
|
+
**global_unsubscribed** | **BOOLEAN** | | [optional]
|
8
|
+
**global_unsubscribed_dts** | **String** | | [optional]
|
7
9
|
**memberships** | [**Array<ListSegmentMembership>**](ListSegmentMembership.md) | | [optional]
|
8
10
|
**metrics** | [**Array<Metric>**](Metric.md) | | [optional]
|
9
11
|
**properties_list** | [**Array<Property>**](Property.md) | | [optional]
|
12
|
+
**spam_complaint** | **BOOLEAN** | | [optional]
|
13
|
+
**spam_complaint_dts** | **String** | | [optional]
|
10
14
|
|
11
15
|
|
data/docs/CustomerApi.md
CHANGED
@@ -17,6 +17,7 @@ Method | HTTP request | Description
|
|
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
|
@@ -756,6 +757,62 @@ Name | Type | Description | Notes
|
|
756
757
|
|
757
758
|
|
758
759
|
|
760
|
+
# **merge_customer**
|
761
|
+
> merge_customer(customer, customer_profile_oid, opts)
|
762
|
+
|
763
|
+
Merge customer into this customer
|
764
|
+
|
765
|
+
Merge customer into this customer.
|
766
|
+
|
767
|
+
### Example
|
768
|
+
```ruby
|
769
|
+
# load the gem
|
770
|
+
require 'ultracart_api'
|
771
|
+
|
772
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
773
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
774
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
775
|
+
|
776
|
+
|
777
|
+
customer = UltracartClient::CustomerMergeRequest.new # CustomerMergeRequest | Customer to merge into this profile.
|
778
|
+
|
779
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
|
780
|
+
|
781
|
+
opts = {
|
782
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
783
|
+
}
|
784
|
+
|
785
|
+
begin
|
786
|
+
#Merge customer into this customer
|
787
|
+
api_instance.merge_customer(customer, customer_profile_oid, opts)
|
788
|
+
rescue UltracartClient::ApiError => e
|
789
|
+
puts "Exception when calling CustomerApi->merge_customer: #{e}"
|
790
|
+
end
|
791
|
+
```
|
792
|
+
|
793
|
+
### Parameters
|
794
|
+
|
795
|
+
Name | Type | Description | Notes
|
796
|
+
------------- | ------------- | ------------- | -------------
|
797
|
+
**customer** | [**CustomerMergeRequest**](CustomerMergeRequest.md)| Customer to merge into this profile. |
|
798
|
+
**customer_profile_oid** | **Integer**| The customer_profile_oid to update. |
|
799
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
800
|
+
|
801
|
+
### Return type
|
802
|
+
|
803
|
+
nil (empty response body)
|
804
|
+
|
805
|
+
### Authorization
|
806
|
+
|
807
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
808
|
+
|
809
|
+
### HTTP request headers
|
810
|
+
|
811
|
+
- **Content-Type**: application/json; charset=UTF-8
|
812
|
+
- **Accept**: application/json
|
813
|
+
|
814
|
+
|
815
|
+
|
759
816
|
# **search_customer_profile_values**
|
760
817
|
> LookupResponse search_customer_profile_values(lookup_request)
|
761
818
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::CustomerMergeRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**customer_profile_oid** | **Integer** | Customer profile oid to merge | [optional]
|
7
|
+
**email** | **String** | Email of the customer profile to merge | [optional]
|
8
|
+
|
9
|
+
|