ultracart_api 4.0.34.rc → 4.0.35.rc

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bbe44d03ad11dc64657aa8f18822639cebf0c01d6db7f964a139878a58ebf2cf
4
- data.tar.gz: c905a454f5b9e395920e921c9c2bcc5b268609e0201dad657d8ca583bc64e42f
3
+ metadata.gz: ec0b15ab8f5732d2610da8f17630a375777626f69578ccaba758538d2bdaefab
4
+ data.tar.gz: 59036a582ba2f6b3de969236a82a036da124931e5847fd4435cb84c3ed1ebb1d
5
5
  SHA512:
6
- metadata.gz: 3f0087f2ec57a2c12e808c923dde41d84f8573fb27a538aa6f458ccc68d1dac3eda48b330cd1c5dfe84f9dc02f71f612d724b52ec93e92d2db5d1871fd1f9284
7
- data.tar.gz: 0c81fd7bea7afcbaf3fa4a1de2b811cc127f59064bc5115bd984d183506cf1582ddbb26465cb2ff6f8c4786b183e560aa5b5c656e513c0a31948daa4732ad3fc
6
+ metadata.gz: c4dbbce61f74ff85c83a3c30b8ca3a6ff25fdd382375b39470685f1633520ad2a19c05e4430cadab55a624beea3cf0ceec89f32fbc2eeda22cd08ef08b0f26bd
7
+ data.tar.gz: 99771aa3cdd92f851f5556e5f1fd78194ad01562ba7b91b3a5ac99a3b6488d0ed6aab3cf8986c0152e6a19fff6819f1cb24e0f2daebf102a8885eef98530d191
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.0.34.rc
10
+ - Package version: 4.0.35.rc
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-4.0.34.rc.gem
27
+ gem install ./ultracart_api-4.0.35.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.34.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.35.rc.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'ultracart_api', '~> 4.0.34.rc'
36
+ gem 'ultracart_api', '~> 4.0.35.rc'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -131,6 +131,12 @@ Class | Method | HTTP request | Description
131
131
  *UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
132
132
  *UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
133
133
  *UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
134
+ *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
135
+ *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
136
+ *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
137
+ *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
138
+ *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
139
+ *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
134
140
  *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
135
141
  *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
136
142
  *UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
@@ -554,6 +560,14 @@ Class | Method | HTTP request | Description
554
560
  - [UltracartClient::CheckoutSetupBrowserKeyResponse](docs/CheckoutSetupBrowserKeyResponse.md)
555
561
  - [UltracartClient::CheckoutStateProvinceResponse](docs/CheckoutStateProvinceResponse.md)
556
562
  - [UltracartClient::CityStateZip](docs/CityStateZip.md)
563
+ - [UltracartClient::Conversation](docs/Conversation.md)
564
+ - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
565
+ - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
566
+ - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
567
+ - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
568
+ - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
569
+ - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
570
+ - [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
557
571
  - [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
558
572
  - [UltracartClient::Country](docs/Country.md)
559
573
  - [UltracartClient::Coupon](docs/Coupon.md)
@@ -1102,6 +1116,8 @@ Class | Method | HTTP request | Description
1102
1116
  - checkout_write: Allows you to write checkout information.
1103
1117
  - configuration_read: Allows you to read configuration information.
1104
1118
  - configuration_write: Allows you to write configuration information.
1119
+ - conversation_read: Allows you to read conversation information.
1120
+ - conversation_write: Allows you to write conversation information.
1105
1121
  - coupon_read: Allows you to read coupon information.
1106
1122
  - coupon_write: Allows you to write coupon information.
1107
1123
  - customer_read: Allows you to read customer information.
@@ -1142,6 +1158,7 @@ Not every change is committed to every SDK.
1142
1158
 
1143
1159
  | Version | Date | Comments |
1144
1160
  | --: | :-: | --- |
1161
+ | 4.0.35-RC | 07/14/2022 | Add channel storefront_oid to the customer activity record |
1145
1162
  | 4.0.34-RC | 07/11/2022 | Customer API - mergeCustomer method |
1146
1163
  | 4.0.33-RC | 07/05/2022 | docs update |
1147
1164
  | 4.0.32-RC | 06/24/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
data/docs/Activity.md CHANGED
@@ -5,7 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **action** | **String** | | [optional] |
8
+ | **channel** | **String** | | [optional] |
8
9
  | **metric** | **String** | | [optional] |
10
+ | **storefront_oid** | **Integer** | | [optional] |
9
11
  | **subject** | **String** | | [optional] |
10
12
  | **ts** | **Integer** | | [optional] |
11
13
  | **type** | **String** | | [optional] |
@@ -18,7 +20,9 @@ require 'ultracart_api'
18
20
 
19
21
  instance = UltracartClient::Activity.new(
20
22
  action: null,
23
+ channel: null,
21
24
  metric: null,
25
+ storefront_oid: null,
22
26
  subject: null,
23
27
  ts: null,
24
28
  type: null,
@@ -0,0 +1,26 @@
1
+ # UltracartClient::Conversation
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conversation_arn** | **String** | | [optional] |
8
+ | **conversation_uuid** | **String** | | [optional] |
9
+ | **merchant_id** | **String** | | [optional] |
10
+ | **messages** | [**Array<ConversationMessage>**](ConversationMessage.md) | | [optional] |
11
+ | **participants** | [**Array<ConversationParticipant>**](ConversationParticipant.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::Conversation.new(
19
+ conversation_arn: null,
20
+ conversation_uuid: null,
21
+ merchant_id: null,
22
+ messages: null,
23
+ participants: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::ConversationAgentAuthResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conversation_participant_arn** | **String** | | [optional] |
8
+ | **jwt** | **String** | | [optional] |
9
+ | **websocket_url** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::ConversationAgentAuthResponse.new(
17
+ conversation_participant_arn: null,
18
+ jwt: null,
19
+ websocket_url: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,438 @@
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
+
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
+ ### Examples
24
+
25
+ ```ruby
26
+ require 'time'
27
+ require 'ultracart_api'
28
+ require 'json'
29
+ require 'yaml'
30
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
31
+
32
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
33
+ # As such, this might not be the best way to use this object.
34
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
35
+
36
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
37
+
38
+ begin
39
+ # Get agent websocket authorization
40
+ result = api_instance.get_agent_websocket_authorization
41
+ p result
42
+ rescue UltracartClient::ApiError => e
43
+ puts "Error when calling ConversationApi->get_agent_websocket_authorization: #{e}"
44
+ end
45
+ ```
46
+
47
+ #### Using the get_agent_websocket_authorization_with_http_info variant
48
+
49
+ This returns an Array which contains the response data, status code and headers.
50
+
51
+ > <Array(<ConversationAgentAuthResponse>, Integer, Hash)> get_agent_websocket_authorization_with_http_info
52
+
53
+ ```ruby
54
+ begin
55
+ # Get agent websocket authorization
56
+ data, status_code, headers = api_instance.get_agent_websocket_authorization_with_http_info
57
+ p status_code # => 2xx
58
+ p headers # => { ... }
59
+ p data # => <ConversationAgentAuthResponse>
60
+ rescue UltracartClient::ApiError => e
61
+ puts "Error when calling ConversationApi->get_agent_websocket_authorization_with_http_info: #{e}"
62
+ end
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ This endpoint does not need any parameter.
68
+
69
+ ### Return type
70
+
71
+ [**ConversationAgentAuthResponse**](ConversationAgentAuthResponse.md)
72
+
73
+ ### Authorization
74
+
75
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
76
+
77
+ ### HTTP request headers
78
+
79
+ - **Content-Type**: Not defined
80
+ - **Accept**: application/json
81
+
82
+
83
+ ## get_conversation
84
+
85
+ > <Conversation> get_conversation(conversation_uuid)
86
+
87
+ Retrieve a conversation
88
+
89
+ Retrieve a conversation including the participants and messages
90
+
91
+ ### Examples
92
+
93
+ ```ruby
94
+ require 'time'
95
+ require 'ultracart_api'
96
+ require 'json'
97
+ require 'yaml'
98
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
99
+
100
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
101
+ # As such, this might not be the best way to use this object.
102
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
103
+
104
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
105
+ conversation_uuid = 'conversation_uuid_example' # String |
106
+
107
+ begin
108
+ # Retrieve a conversation
109
+ result = api_instance.get_conversation(conversation_uuid)
110
+ p result
111
+ rescue UltracartClient::ApiError => e
112
+ puts "Error when calling ConversationApi->get_conversation: #{e}"
113
+ end
114
+ ```
115
+
116
+ #### Using the get_conversation_with_http_info variant
117
+
118
+ This returns an Array which contains the response data, status code and headers.
119
+
120
+ > <Array(<Conversation>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid)
121
+
122
+ ```ruby
123
+ begin
124
+ # Retrieve a conversation
125
+ data, status_code, headers = api_instance.get_conversation_with_http_info(conversation_uuid)
126
+ p status_code # => 2xx
127
+ p headers # => { ... }
128
+ p data # => <Conversation>
129
+ rescue UltracartClient::ApiError => e
130
+ puts "Error when calling ConversationApi->get_conversation_with_http_info: #{e}"
131
+ end
132
+ ```
133
+
134
+ ### Parameters
135
+
136
+ | Name | Type | Description | Notes |
137
+ | ---- | ---- | ----------- | ----- |
138
+ | **conversation_uuid** | **String** | | |
139
+
140
+ ### Return type
141
+
142
+ [**Conversation**](Conversation.md)
143
+
144
+ ### Authorization
145
+
146
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
147
+
148
+ ### HTTP request headers
149
+
150
+ - **Content-Type**: Not defined
151
+ - **Accept**: application/json
152
+
153
+
154
+ ## get_conversations
155
+
156
+ > <ConversationsResponse> get_conversations(opts)
157
+
158
+ Retrieve a list of conversation summaries newest to oldest
159
+
160
+ Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
161
+
162
+ ### Examples
163
+
164
+ ```ruby
165
+ require 'time'
166
+ require 'ultracart_api'
167
+ require 'json'
168
+ require 'yaml'
169
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
170
+
171
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
172
+ # As such, this might not be the best way to use this object.
173
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
174
+
175
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
176
+ opts = {
177
+ _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
178
+ _offset: 56 # Integer | Pagination of the record set. Offset is a zero based index.
179
+ }
180
+
181
+ begin
182
+ # Retrieve a list of conversation summaries newest to oldest
183
+ result = api_instance.get_conversations(opts)
184
+ p result
185
+ rescue UltracartClient::ApiError => e
186
+ puts "Error when calling ConversationApi->get_conversations: #{e}"
187
+ end
188
+ ```
189
+
190
+ #### Using the get_conversations_with_http_info variant
191
+
192
+ This returns an Array which contains the response data, status code and headers.
193
+
194
+ > <Array(<ConversationsResponse>, Integer, Hash)> get_conversations_with_http_info(opts)
195
+
196
+ ```ruby
197
+ begin
198
+ # Retrieve a list of conversation summaries newest to oldest
199
+ data, status_code, headers = api_instance.get_conversations_with_http_info(opts)
200
+ p status_code # => 2xx
201
+ p headers # => { ... }
202
+ p data # => <ConversationsResponse>
203
+ rescue UltracartClient::ApiError => e
204
+ puts "Error when calling ConversationApi->get_conversations_with_http_info: #{e}"
205
+ end
206
+ ```
207
+
208
+ ### Parameters
209
+
210
+ | Name | Type | Description | Notes |
211
+ | ---- | ---- | ----------- | ----- |
212
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Max 200) | [optional][default to 100] |
213
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
214
+
215
+ ### Return type
216
+
217
+ [**ConversationsResponse**](ConversationsResponse.md)
218
+
219
+ ### Authorization
220
+
221
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: Not defined
226
+ - **Accept**: application/json
227
+
228
+
229
+ ## join_conversation
230
+
231
+ > join_conversation(conversation_uuid)
232
+
233
+ Join a conversation
234
+
235
+ Join a conversation
236
+
237
+ ### Examples
238
+
239
+ ```ruby
240
+ require 'time'
241
+ require 'ultracart_api'
242
+ require 'json'
243
+ require 'yaml'
244
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
245
+
246
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
247
+ # As such, this might not be the best way to use this object.
248
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
249
+
250
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
251
+ conversation_uuid = 'conversation_uuid_example' # String |
252
+
253
+ begin
254
+ # Join a conversation
255
+ api_instance.join_conversation(conversation_uuid)
256
+ rescue UltracartClient::ApiError => e
257
+ puts "Error when calling ConversationApi->join_conversation: #{e}"
258
+ end
259
+ ```
260
+
261
+ #### Using the join_conversation_with_http_info variant
262
+
263
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
264
+
265
+ > <Array(nil, Integer, Hash)> join_conversation_with_http_info(conversation_uuid)
266
+
267
+ ```ruby
268
+ begin
269
+ # Join a conversation
270
+ data, status_code, headers = api_instance.join_conversation_with_http_info(conversation_uuid)
271
+ p status_code # => 2xx
272
+ p headers # => { ... }
273
+ p data # => nil
274
+ rescue UltracartClient::ApiError => e
275
+ puts "Error when calling ConversationApi->join_conversation_with_http_info: #{e}"
276
+ end
277
+ ```
278
+
279
+ ### Parameters
280
+
281
+ | Name | Type | Description | Notes |
282
+ | ---- | ---- | ----------- | ----- |
283
+ | **conversation_uuid** | **String** | | |
284
+
285
+ ### Return type
286
+
287
+ nil (empty response body)
288
+
289
+ ### Authorization
290
+
291
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
292
+
293
+ ### HTTP request headers
294
+
295
+ - **Content-Type**: Not defined
296
+ - **Accept**: application/json
297
+
298
+
299
+ ## leave_conversation
300
+
301
+ > leave_conversation(conversation_uuid)
302
+
303
+ Leave a conversation
304
+
305
+ Leave a conversation
306
+
307
+ ### Examples
308
+
309
+ ```ruby
310
+ require 'time'
311
+ require 'ultracart_api'
312
+ require 'json'
313
+ require 'yaml'
314
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
315
+
316
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
317
+ # As such, this might not be the best way to use this object.
318
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
319
+
320
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
321
+ conversation_uuid = 'conversation_uuid_example' # String |
322
+
323
+ begin
324
+ # Leave a conversation
325
+ api_instance.leave_conversation(conversation_uuid)
326
+ rescue UltracartClient::ApiError => e
327
+ puts "Error when calling ConversationApi->leave_conversation: #{e}"
328
+ end
329
+ ```
330
+
331
+ #### Using the leave_conversation_with_http_info variant
332
+
333
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
334
+
335
+ > <Array(nil, Integer, Hash)> leave_conversation_with_http_info(conversation_uuid)
336
+
337
+ ```ruby
338
+ begin
339
+ # Leave a conversation
340
+ data, status_code, headers = api_instance.leave_conversation_with_http_info(conversation_uuid)
341
+ p status_code # => 2xx
342
+ p headers # => { ... }
343
+ p data # => nil
344
+ rescue UltracartClient::ApiError => e
345
+ puts "Error when calling ConversationApi->leave_conversation_with_http_info: #{e}"
346
+ end
347
+ ```
348
+
349
+ ### Parameters
350
+
351
+ | Name | Type | Description | Notes |
352
+ | ---- | ---- | ----------- | ----- |
353
+ | **conversation_uuid** | **String** | | |
354
+
355
+ ### Return type
356
+
357
+ nil (empty response body)
358
+
359
+ ### Authorization
360
+
361
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
362
+
363
+ ### HTTP request headers
364
+
365
+ - **Content-Type**: Not defined
366
+ - **Accept**: application/json
367
+
368
+
369
+ ## start_conversation
370
+
371
+ > <ConversationStartResponse> start_conversation(start_request)
372
+
373
+ Start a conversation
374
+
375
+ Start a new conversation
376
+
377
+ ### Examples
378
+
379
+ ```ruby
380
+ require 'time'
381
+ require 'ultracart_api'
382
+ require 'json'
383
+ require 'yaml'
384
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
385
+
386
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
387
+ # As such, this might not be the best way to use this object.
388
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
389
+
390
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
391
+ start_request = UltracartClient::ConversationStartRequest.new # ConversationStartRequest | Start request
392
+
393
+ begin
394
+ # Start a conversation
395
+ result = api_instance.start_conversation(start_request)
396
+ p result
397
+ rescue UltracartClient::ApiError => e
398
+ puts "Error when calling ConversationApi->start_conversation: #{e}"
399
+ end
400
+ ```
401
+
402
+ #### Using the start_conversation_with_http_info variant
403
+
404
+ This returns an Array which contains the response data, status code and headers.
405
+
406
+ > <Array(<ConversationStartResponse>, Integer, Hash)> start_conversation_with_http_info(start_request)
407
+
408
+ ```ruby
409
+ begin
410
+ # Start a conversation
411
+ data, status_code, headers = api_instance.start_conversation_with_http_info(start_request)
412
+ p status_code # => 2xx
413
+ p headers # => { ... }
414
+ p data # => <ConversationStartResponse>
415
+ rescue UltracartClient::ApiError => e
416
+ puts "Error when calling ConversationApi->start_conversation_with_http_info: #{e}"
417
+ end
418
+ ```
419
+
420
+ ### Parameters
421
+
422
+ | Name | Type | Description | Notes |
423
+ | ---- | ---- | ----------- | ----- |
424
+ | **start_request** | [**ConversationStartRequest**](ConversationStartRequest.md) | Start request | |
425
+
426
+ ### Return type
427
+
428
+ [**ConversationStartResponse**](ConversationStartResponse.md)
429
+
430
+ ### Authorization
431
+
432
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
433
+
434
+ ### HTTP request headers
435
+
436
+ - **Content-Type**: application/json
437
+ - **Accept**: application/json
438
+
@@ -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&lt;String&gt;** | | [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&lt;String&gt;** | | [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
+