ultracart_api 3.10.17 → 3.10.20

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -4
  3. data/docs/Activity.md +2 -0
  4. data/docs/ChargebackApi.md +1 -1
  5. data/docs/Conversation.md +12 -0
  6. data/docs/ConversationAgentAuthResponse.md +10 -0
  7. data/docs/ConversationApi.md +310 -0
  8. data/docs/ConversationMessage.md +12 -0
  9. data/docs/ConversationParticipant.md +14 -0
  10. data/docs/ConversationStartRequest.md +9 -0
  11. data/docs/ConversationStartResponse.md +9 -0
  12. data/docs/ConversationSummary.md +16 -0
  13. data/docs/ConversationsResponse.md +12 -0
  14. data/docs/CustomerActivity.md +4 -0
  15. data/docs/CustomerApi.md +58 -1
  16. data/docs/CustomerMergeRequest.md +9 -0
  17. data/docs/OrderApi.md +1 -1
  18. data/docs/SsoApi.md +2 -2
  19. data/docs/UserApi.md +2 -2
  20. data/docs/WebhookApi.md +1 -1
  21. data/lib/ultracart_api/api/chargeback_api.rb +1 -1
  22. data/lib/ultracart_api/api/conversation_api.rb +358 -0
  23. data/lib/ultracart_api/api/customer_api.rb +64 -1
  24. data/lib/ultracart_api/api/order_api.rb +1 -1
  25. data/lib/ultracart_api/api/sso_api.rb +2 -2
  26. data/lib/ultracart_api/api/user_api.rb +2 -2
  27. data/lib/ultracart_api/api/webhook_api.rb +1 -1
  28. data/lib/ultracart_api/models/activity.rb +19 -1
  29. data/lib/ultracart_api/models/conversation.rb +224 -0
  30. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +202 -0
  31. data/lib/ultracart_api/models/conversation_message.rb +223 -0
  32. data/lib/ultracart_api/models/conversation_participant.rb +241 -0
  33. data/lib/ultracart_api/models/conversation_start_request.rb +195 -0
  34. data/lib/ultracart_api/models/conversation_start_response.rb +193 -0
  35. data/lib/ultracart_api/models/conversation_summary.rb +257 -0
  36. data/lib/ultracart_api/models/conversations_response.rb +223 -0
  37. data/lib/ultracart_api/models/customer_activity.rb +40 -4
  38. data/lib/ultracart_api/models/customer_merge_request.rb +195 -0
  39. data/lib/ultracart_api/version.rb +1 -1
  40. data/lib/ultracart_api.rb +10 -0
  41. metadata +22 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1c64f2d670e637cdfd11a1003ff38150dcf0a0d03001d111883a5c955c0f63f2
4
- data.tar.gz: f5458dedc6f6519d1e74ab9631eeb3039ccc3231239e8193b7c7e9e5a3993965
3
+ metadata.gz: e3407df30686b8bcf166c2239723bbfcfb8ba661caa2fa9e0d492cac27d67675
4
+ data.tar.gz: b792641f5a5e8e1fc67930c9bf0f1e4763735619ad026b858cb2dbcce92e10cb
5
5
  SHA512:
6
- metadata.gz: 5d5c32a4f588ccbd37e6bc8604fdec1f824ca1304e5edf14122aa5d4fa36bfce8dea93145ae0fe5cc0c078ad403fd16b6965ca000e065150ba8a5e4e85af3026
7
- data.tar.gz: 389b7845e97a30c9496ec137ae0d3467a5ad63abffc06c105c82b75bc0d840386ca736ef03707d5035e2411bbfc4355737bab341a1858c856b1167c834112e56
6
+ metadata.gz: 5cdb14ef3dd73b2bdf66aebe8b332b4a3b81035f8d366e7d01a9167de4ff000465dfc57c4c81275806fced8a2505880632759cc0da98f2bf181eafb4694b4f53
7
+ data.tar.gz: e2584db5ed5076bb60bab840eec6b8a578b90a011fef2f0d0d299f04f500758060671b10b2e43e1c50fe50fd0608076679077950cda7d44706fc9ed80f3cb2ac
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.17
10
+ - Package version: 3.10.20
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.17.gem
27
+ gem install ./ultracart_api-3.10.20.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.10.17.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.10.20.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.17'
35
+ gem 'ultracart_api', '~> 3.10.20'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -125,6 +125,12 @@ 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_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
131
+ *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
132
+ *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
133
+ *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
128
134
  *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
129
135
  *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
130
136
  *UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
@@ -157,6 +163,7 @@ Class | Method | HTTP request | Description
157
163
  *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
164
  *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
165
  *UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
166
+ *UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
160
167
  *UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
161
168
  *UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
162
169
  *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 +554,14 @@ Class | Method | HTTP request | Description
547
554
  - [UltracartClient::CheckoutSetupBrowserKeyResponse](docs/CheckoutSetupBrowserKeyResponse.md)
548
555
  - [UltracartClient::CheckoutStateProvinceResponse](docs/CheckoutStateProvinceResponse.md)
549
556
  - [UltracartClient::CityStateZip](docs/CityStateZip.md)
557
+ - [UltracartClient::Conversation](docs/Conversation.md)
558
+ - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
559
+ - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
560
+ - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
561
+ - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
562
+ - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
563
+ - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
564
+ - [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
550
565
  - [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
551
566
  - [UltracartClient::Country](docs/Country.md)
552
567
  - [UltracartClient::Coupon](docs/Coupon.md)
@@ -625,6 +640,7 @@ Class | Method | HTTP request | Description
625
640
  - [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
626
641
  - [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
627
642
  - [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
643
+ - [UltracartClient::CustomerMergeRequest](docs/CustomerMergeRequest.md)
628
644
  - [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
629
645
  - [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
630
646
  - [UltracartClient::CustomerPrivacy](docs/CustomerPrivacy.md)
@@ -1093,6 +1109,8 @@ Class | Method | HTTP request | Description
1093
1109
  - checkout_write: Allows you to write checkout information.
1094
1110
  - configuration_read: Allows you to read configuration information.
1095
1111
  - configuration_write: Allows you to write configuration information.
1112
+ - conversation_read: Allows you to read conversation information.
1113
+ - conversation_write: Allows you to write conversation information.
1096
1114
  - coupon_read: Allows you to read coupon information.
1097
1115
  - coupon_write: Allows you to write coupon information.
1098
1116
  - customer_read: Allows you to read customer information.
@@ -1132,6 +1150,9 @@ Not every change is committed to every SDK.
1132
1150
 
1133
1151
  | Version | Date | Comments |
1134
1152
  | --: | :-: | --- |
1153
+ | 3.10.20 | 07/14/2022 | Add channel storefront_oid to the customer activity record |
1154
+ | 3.10.19 | 07/11/2022 | Customer API - mergeCustomer method |
1155
+ | 3.10.18 | 06/23/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
1135
1156
  | 3.10.17 | 06/23/2022 | automation test |
1136
1157
  | 3.10.16 | 06/23/2022 | automation test |
1137
1158
  | 3.10.15 | 06/21/2022 | ChannelPartnerApi.estimateShipping |
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]
@@ -56,7 +56,7 @@ Name | Type | Description | Notes
56
56
 
57
57
  ### HTTP request headers
58
58
 
59
- - **Content-Type**: application/json; charset=UTF-8
59
+ - **Content-Type**: application/json
60
60
  - **Accept**: application/json
61
61
 
62
62
 
@@ -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,10 @@
1
+ # UltracartClient::ConversationAgentAuthResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_participant_arn** | **String** | | [optional]
7
+ **jwt** | **String** | | [optional]
8
+ **websocket_url** | **String** | | [optional]
9
+
10
+
@@ -0,0 +1,310 @@
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_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
10
+ [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
11
+ [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
12
+ [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
13
+
14
+
15
+ # **get_agent_websocket_authorization**
16
+ > ConversationAgentAuthResponse get_agent_websocket_authorization
17
+
18
+ Get agent websocket authorization
19
+
20
+ Retrieve a JWT to authorize an agent to make a websocket connection.
21
+
22
+ ### Example
23
+ ```ruby
24
+ # load the gem
25
+ require 'ultracart_api'
26
+
27
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
28
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
29
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
30
+
31
+
32
+
33
+ begin
34
+ #Get agent websocket authorization
35
+ result = api_instance.get_agent_websocket_authorization
36
+ p result
37
+ rescue UltracartClient::ApiError => e
38
+ puts "Exception when calling ConversationApi->get_agent_websocket_authorization: #{e}"
39
+ end
40
+ ```
41
+
42
+ ### Parameters
43
+ This endpoint does not need any parameter.
44
+
45
+ ### Return type
46
+
47
+ [**ConversationAgentAuthResponse**](ConversationAgentAuthResponse.md)
48
+
49
+ ### Authorization
50
+
51
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
52
+
53
+ ### HTTP request headers
54
+
55
+ - **Content-Type**: application/json
56
+ - **Accept**: application/json
57
+
58
+
59
+
60
+ # **get_conversation**
61
+ > Conversation get_conversation(conversation_uuid)
62
+
63
+ Retrieve a conversation
64
+
65
+ Retrieve a conversation including the participants and messages
66
+
67
+ ### Example
68
+ ```ruby
69
+ # load the gem
70
+ require 'ultracart_api'
71
+
72
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
73
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
74
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
75
+
76
+
77
+ conversation_uuid = 'conversation_uuid_example' # String |
78
+
79
+
80
+ begin
81
+ #Retrieve a conversation
82
+ result = api_instance.get_conversation(conversation_uuid)
83
+ p result
84
+ rescue UltracartClient::ApiError => e
85
+ puts "Exception when calling ConversationApi->get_conversation: #{e}"
86
+ end
87
+ ```
88
+
89
+ ### Parameters
90
+
91
+ Name | Type | Description | Notes
92
+ ------------- | ------------- | ------------- | -------------
93
+ **conversation_uuid** | **String**| |
94
+
95
+ ### Return type
96
+
97
+ [**Conversation**](Conversation.md)
98
+
99
+ ### Authorization
100
+
101
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
102
+
103
+ ### HTTP request headers
104
+
105
+ - **Content-Type**: application/json
106
+ - **Accept**: application/json
107
+
108
+
109
+
110
+ # **get_conversations**
111
+ > ConversationsResponse get_conversations(opts)
112
+
113
+ Retrieve a list of conversation summaries newest to oldest
114
+
115
+ Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
116
+
117
+ ### Example
118
+ ```ruby
119
+ # load the gem
120
+ require 'ultracart_api'
121
+
122
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
123
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
124
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
125
+
126
+
127
+ opts = {
128
+ _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
129
+ _offset: 0 # Integer | Pagination of the record set. Offset is a zero based index.
130
+ }
131
+
132
+ begin
133
+ #Retrieve a list of conversation summaries newest to oldest
134
+ result = api_instance.get_conversations(opts)
135
+ p result
136
+ rescue UltracartClient::ApiError => e
137
+ puts "Exception when calling ConversationApi->get_conversations: #{e}"
138
+ end
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+ Name | Type | Description | Notes
144
+ ------------- | ------------- | ------------- | -------------
145
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
146
+ **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
147
+
148
+ ### Return type
149
+
150
+ [**ConversationsResponse**](ConversationsResponse.md)
151
+
152
+ ### Authorization
153
+
154
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
155
+
156
+ ### HTTP request headers
157
+
158
+ - **Content-Type**: application/json
159
+ - **Accept**: application/json
160
+
161
+
162
+
163
+ # **join_conversation**
164
+ > join_conversation(conversation_uuid)
165
+
166
+ Join a conversation
167
+
168
+ Join a conversation
169
+
170
+ ### Example
171
+ ```ruby
172
+ # load the gem
173
+ require 'ultracart_api'
174
+
175
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
176
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
177
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
178
+
179
+
180
+ conversation_uuid = 'conversation_uuid_example' # String |
181
+
182
+
183
+ begin
184
+ #Join a conversation
185
+ api_instance.join_conversation(conversation_uuid)
186
+ rescue UltracartClient::ApiError => e
187
+ puts "Exception when calling ConversationApi->join_conversation: #{e}"
188
+ end
189
+ ```
190
+
191
+ ### Parameters
192
+
193
+ Name | Type | Description | Notes
194
+ ------------- | ------------- | ------------- | -------------
195
+ **conversation_uuid** | **String**| |
196
+
197
+ ### Return type
198
+
199
+ nil (empty response body)
200
+
201
+ ### Authorization
202
+
203
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
204
+
205
+ ### HTTP request headers
206
+
207
+ - **Content-Type**: application/json
208
+ - **Accept**: application/json
209
+
210
+
211
+
212
+ # **leave_conversation**
213
+ > leave_conversation(conversation_uuid)
214
+
215
+ Leave a conversation
216
+
217
+ Leave a conversation
218
+
219
+ ### Example
220
+ ```ruby
221
+ # load the gem
222
+ require 'ultracart_api'
223
+
224
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
225
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
226
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
227
+
228
+
229
+ conversation_uuid = 'conversation_uuid_example' # String |
230
+
231
+
232
+ begin
233
+ #Leave a conversation
234
+ api_instance.leave_conversation(conversation_uuid)
235
+ rescue UltracartClient::ApiError => e
236
+ puts "Exception when calling ConversationApi->leave_conversation: #{e}"
237
+ end
238
+ ```
239
+
240
+ ### Parameters
241
+
242
+ Name | Type | Description | Notes
243
+ ------------- | ------------- | ------------- | -------------
244
+ **conversation_uuid** | **String**| |
245
+
246
+ ### Return type
247
+
248
+ nil (empty response body)
249
+
250
+ ### Authorization
251
+
252
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
253
+
254
+ ### HTTP request headers
255
+
256
+ - **Content-Type**: application/json
257
+ - **Accept**: application/json
258
+
259
+
260
+
261
+ # **start_conversation**
262
+ > ConversationStartResponse start_conversation(start_request)
263
+
264
+ Start a conversation
265
+
266
+ Start a new conversation
267
+
268
+ ### Example
269
+ ```ruby
270
+ # load the gem
271
+ require 'ultracart_api'
272
+
273
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
274
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
275
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
276
+
277
+
278
+ start_request = UltracartClient::ConversationStartRequest.new # ConversationStartRequest | Start request
279
+
280
+
281
+ begin
282
+ #Start a conversation
283
+ result = api_instance.start_conversation(start_request)
284
+ p result
285
+ rescue UltracartClient::ApiError => e
286
+ puts "Exception when calling ConversationApi->start_conversation: #{e}"
287
+ end
288
+ ```
289
+
290
+ ### Parameters
291
+
292
+ Name | Type | Description | Notes
293
+ ------------- | ------------- | ------------- | -------------
294
+ **start_request** | [**ConversationStartRequest**](ConversationStartRequest.md)| Start request |
295
+
296
+ ### Return type
297
+
298
+ [**ConversationStartResponse**](ConversationStartResponse.md)
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
+
@@ -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
+
@@ -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
@@ -173,7 +174,7 @@ nil (empty response body)
173
174
 
174
175
  ### HTTP request headers
175
176
 
176
- - **Content-Type**: application/json; charset=UTF-8
177
+ - **Content-Type**: application/json
177
178
  - **Accept**: application/json
178
179
 
179
180
 
@@ -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
+
data/docs/OrderApi.md CHANGED
@@ -230,7 +230,7 @@ Name | Type | Description | Notes
230
230
 
231
231
  ### HTTP request headers
232
232
 
233
- - **Content-Type**: application/json; charset=UTF-8
233
+ - **Content-Type**: application/json
234
234
  - **Accept**: application/json
235
235
 
236
236
 
data/docs/SsoApi.md CHANGED
@@ -50,7 +50,7 @@ This endpoint does not need any parameter.
50
50
 
51
51
  ### HTTP request headers
52
52
 
53
- - **Content-Type**: application/json; charset=UTF-8
53
+ - **Content-Type**: application/json
54
54
  - **Accept**: application/json
55
55
 
56
56
 
@@ -144,7 +144,7 @@ nil (empty response body)
144
144
 
145
145
  ### HTTP request headers
146
146
 
147
- - **Content-Type**: application/json; charset=UTF-8
147
+ - **Content-Type**: application/json
148
148
  - **Accept**: application/json
149
149
 
150
150