ultracart_api 3.10.19 → 3.10.22
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +25 -4
- data/docs/Activity.md +2 -0
- data/docs/Conversation.md +12 -0
- data/docs/ConversationAgentAuthResponse.md +13 -0
- data/docs/ConversationApi.md +360 -0
- data/docs/ConversationMessage.md +13 -0
- data/docs/ConversationMessageTransportStatus.md +9 -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/lib/ultracart_api/api/conversation_api.rb +412 -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 +231 -0
- data/lib/ultracart_api/models/conversation_message.rb +234 -0
- data/lib/ultracart_api/models/conversation_message_transport_status.rb +193 -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/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: 05722e44889d98eac4a8db4a0227dbbdc2469b7f727d73163c519669929de1a2
|
4
|
+
data.tar.gz: c3cd123c695a10b0febf241f82343e52c426df8726ce0dc7dbfdb7e3e1c60961
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5374b87901b42001e7faadcd3d128bc1a5e60b8335427af72749745773ad0fa909f5b19638bee04173e8c3c304a7a1895dc5547832e5ba20503685eeb29becad
|
7
|
+
data.tar.gz: c3e2892579f7146cebdab8f6769ddc20e006f7eb7ce50cfdf7be19fb0e6a5cfa9b2271585c8a9f5f0904d3f488d4ba7146917b0ba59211e1939372126df91a6a
|
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.22
|
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.22.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.22.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.22'
|
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
|
@@ -548,6 +555,15 @@ Class | Method | HTTP request | Description
|
|
548
555
|
- [UltracartClient::CheckoutSetupBrowserKeyResponse](docs/CheckoutSetupBrowserKeyResponse.md)
|
549
556
|
- [UltracartClient::CheckoutStateProvinceResponse](docs/CheckoutStateProvinceResponse.md)
|
550
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::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
562
|
+
- [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
|
563
|
+
- [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
|
564
|
+
- [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
|
565
|
+
- [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
|
566
|
+
- [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
|
551
567
|
- [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
|
552
568
|
- [UltracartClient::Country](docs/Country.md)
|
553
569
|
- [UltracartClient::Coupon](docs/Coupon.md)
|
@@ -1095,6 +1111,8 @@ Class | Method | HTTP request | Description
|
|
1095
1111
|
- checkout_write: Allows you to write checkout information.
|
1096
1112
|
- configuration_read: Allows you to read configuration information.
|
1097
1113
|
- configuration_write: Allows you to write configuration information.
|
1114
|
+
- conversation_read: Allows you to read conversation information.
|
1115
|
+
- conversation_write: Allows you to write conversation information.
|
1098
1116
|
- coupon_read: Allows you to read coupon information.
|
1099
1117
|
- coupon_write: Allows you to write coupon information.
|
1100
1118
|
- customer_read: Allows you to read customer information.
|
@@ -1134,6 +1152,9 @@ Not every change is committed to every SDK.
|
|
1134
1152
|
|
1135
1153
|
| Version | Date | Comments |
|
1136
1154
|
| --: | :-: | --- |
|
1155
|
+
| 3.10.22 | 07/20/2022 | conversation participant name added |
|
1156
|
+
| 3.10.21 | 07/18/2022 | twilio dev |
|
1157
|
+
| 3.10.20 | 07/14/2022 | Add channel storefront_oid to the customer activity record |
|
1137
1158
|
| 3.10.19 | 07/11/2022 | Customer API - mergeCustomer method |
|
1138
1159
|
| 3.10.18 | 06/23/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
|
1139
1160
|
| 3.10.17 | 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,13 @@
|
|
1
|
+
# UltracartClient::ConversationAgentAuthResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_participant_arn** | **String** | | [optional]
|
7
|
+
**conversation_participant_name** | **String** | | [optional]
|
8
|
+
**jwt** | **String** | | [optional]
|
9
|
+
**merchant_id** | **String** | | [optional]
|
10
|
+
**twilio_phone_numbers** | **Array<String>** | | [optional]
|
11
|
+
**websocket_url** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -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,13 @@
|
|
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
|
+
**transport_statuses** | [**Array<ConversationMessageTransportStatus>**](ConversationMessageTransportStatus.md) | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::ConversationMessageTransportStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_participant_arn** | **String** | | [optional]
|
7
|
+
**status** | **String** | | [optional]
|
8
|
+
|
9
|
+
|
@@ -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
|
+
|