ultracart_api 3.10.45 → 3.10.47
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 +12 -4
- data/docs/ConversationApi.md +109 -2
- data/docs/ConversationMessagesResponse.md +12 -0
- data/docs/EmailPostcardTracking.md +32 -0
- data/docs/EmailPostcardTrackingResponse.md +12 -0
- data/docs/StorefrontApi.md +52 -0
- data/lib/ultracart_api/api/conversation_api.rb +115 -0
- data/lib/ultracart_api/api/storefront_api.rb +59 -0
- data/lib/ultracart_api/models/conversation_messages_response.rb +223 -0
- data/lib/ultracart_api/models/email_postcard_tracking.rb +404 -0
- data/lib/ultracart_api/models/email_postcard_tracking_response.rb +221 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +3 -0
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6c81286e0c3b92487863d04107623efd2989df4d89073257247f1e8591f1c3b3
|
|
4
|
+
data.tar.gz: 63bfd9540814e060d2d9779fa72a87d2c30fb754103759b144d44eb24b61e571
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fa099d7d6f856a4cbf381ffbb978e774331682c71937507407c155f224773702d3798dbc8086eb2746616dcdc5d73cca9f8ab6362894228a4973183e24f3c2a1
|
|
7
|
+
data.tar.gz: 8d9a82ac81ed72f5586d8c04650838401622b0e069013d115d66bc484e2bdf4a1ba78c66f6c0fdf5c3e761005512269ed026fe6684a98827849cd6034e55e6c9
|
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.47
|
|
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.47.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.47.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.47'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -125,8 +125,10 @@ 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_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
128
129
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
129
130
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
131
|
+
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
|
130
132
|
*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
133
|
*UltracartClient::ConversationApi* | [**get_conversation_webchat_queue_statuses**](docs/ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
|
|
132
134
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
|
@@ -269,6 +271,7 @@ Class | Method | HTTP request | Description
|
|
|
269
271
|
*UltracartClient::StorefrontApi* | [**get_email_commseq**](docs/StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
|
|
270
272
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_email_stats**](docs/StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
|
|
271
273
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_stats**](docs/StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
|
|
274
|
+
*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_tracking**](docs/StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
|
|
272
275
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_stat_overall**](docs/StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
|
|
273
276
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_stats**](docs/StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
|
|
274
277
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_waiting**](docs/StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
|
|
@@ -571,6 +574,7 @@ Class | Method | HTTP request | Description
|
|
|
571
574
|
- [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
|
|
572
575
|
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
|
573
576
|
- [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
|
577
|
+
- [UltracartClient::ConversationMessagesResponse](docs/ConversationMessagesResponse.md)
|
|
574
578
|
- [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
|
|
575
579
|
- [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
|
|
576
580
|
- [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
|
|
@@ -764,6 +768,8 @@ Class | Method | HTTP request | Description
|
|
|
764
768
|
- [UltracartClient::EmailPlanAdditional](docs/EmailPlanAdditional.md)
|
|
765
769
|
- [UltracartClient::EmailPlanResponse](docs/EmailPlanResponse.md)
|
|
766
770
|
- [UltracartClient::EmailPostcardStat](docs/EmailPostcardStat.md)
|
|
771
|
+
- [UltracartClient::EmailPostcardTracking](docs/EmailPostcardTracking.md)
|
|
772
|
+
- [UltracartClient::EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
|
|
767
773
|
- [UltracartClient::EmailSegment](docs/EmailSegment.md)
|
|
768
774
|
- [UltracartClient::EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
|
|
769
775
|
- [UltracartClient::EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
|
|
@@ -1182,6 +1188,8 @@ Not every change is committed to every SDK.
|
|
|
1182
1188
|
|
|
1183
1189
|
| Version | Date | Comments |
|
|
1184
1190
|
| --: | :-: | --- |
|
|
1191
|
+
| 3.10.47 | 09/19/2022 | conversations pagination |
|
|
1192
|
+
| 3.10.46 | 09/13/2022 | storefront comms - postcard tracking |
|
|
1185
1193
|
| 3.10.45 | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
|
|
1186
1194
|
| 3.10.44 | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
|
|
1187
1195
|
| 3.10.43 | 09/02/2022 | customer editor added loyal ledger descriptions |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -4,8 +4,10 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
+
[**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
7
8
|
[**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
8
9
|
[**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
10
|
+
[**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
|
9
11
|
[**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
12
|
[**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
|
|
11
13
|
[**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
|
@@ -15,6 +17,50 @@ Method | HTTP request | Description
|
|
|
15
17
|
[**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
|
|
16
18
|
|
|
17
19
|
|
|
20
|
+
# **get_agent_keep_alive**
|
|
21
|
+
> get_agent_keep_alive
|
|
22
|
+
|
|
23
|
+
Agent keep alive
|
|
24
|
+
|
|
25
|
+
Called periodically by the conversation API to keep the session alive.
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
```ruby
|
|
29
|
+
# load the gem
|
|
30
|
+
require 'ultracart_api'
|
|
31
|
+
|
|
32
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
33
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
34
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
begin
|
|
39
|
+
#Agent keep alive
|
|
40
|
+
api_instance.get_agent_keep_alive
|
|
41
|
+
rescue UltracartClient::ApiError => e
|
|
42
|
+
puts "Exception when calling ConversationApi->get_agent_keep_alive: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
This endpoint does not need any parameter.
|
|
48
|
+
|
|
49
|
+
### Return type
|
|
50
|
+
|
|
51
|
+
nil (empty response body)
|
|
52
|
+
|
|
53
|
+
### Authorization
|
|
54
|
+
|
|
55
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
56
|
+
|
|
57
|
+
### HTTP request headers
|
|
58
|
+
|
|
59
|
+
- **Content-Type**: application/json
|
|
60
|
+
- **Accept**: application/json
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
18
64
|
# **get_agent_websocket_authorization**
|
|
19
65
|
> ConversationAgentAuthResponse get_agent_websocket_authorization
|
|
20
66
|
|
|
@@ -61,7 +107,7 @@ This endpoint does not need any parameter.
|
|
|
61
107
|
|
|
62
108
|
|
|
63
109
|
# **get_conversation**
|
|
64
|
-
> ConversationResponse get_conversation(conversation_uuid)
|
|
110
|
+
> ConversationResponse get_conversation(conversation_uuid, opts)
|
|
65
111
|
|
|
66
112
|
Retrieve a conversation
|
|
67
113
|
|
|
@@ -79,10 +125,13 @@ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, fa
|
|
|
79
125
|
|
|
80
126
|
conversation_uuid = 'conversation_uuid_example' # String |
|
|
81
127
|
|
|
128
|
+
opts = {
|
|
129
|
+
limit: 56 # Integer |
|
|
130
|
+
}
|
|
82
131
|
|
|
83
132
|
begin
|
|
84
133
|
#Retrieve a conversation
|
|
85
|
-
result = api_instance.get_conversation(conversation_uuid)
|
|
134
|
+
result = api_instance.get_conversation(conversation_uuid, opts)
|
|
86
135
|
p result
|
|
87
136
|
rescue UltracartClient::ApiError => e
|
|
88
137
|
puts "Exception when calling ConversationApi->get_conversation: #{e}"
|
|
@@ -94,6 +143,7 @@ end
|
|
|
94
143
|
Name | Type | Description | Notes
|
|
95
144
|
------------- | ------------- | ------------- | -------------
|
|
96
145
|
**conversation_uuid** | **String**| |
|
|
146
|
+
**limit** | **Integer**| | [optional]
|
|
97
147
|
|
|
98
148
|
### Return type
|
|
99
149
|
|
|
@@ -110,6 +160,63 @@ Name | Type | Description | Notes
|
|
|
110
160
|
|
|
111
161
|
|
|
112
162
|
|
|
163
|
+
# **get_conversation_messages**
|
|
164
|
+
> ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
|
|
165
|
+
|
|
166
|
+
Retrieve conversation messages
|
|
167
|
+
|
|
168
|
+
Retrieve conversation messages since a particular time
|
|
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
|
+
since = 789 # Integer |
|
|
183
|
+
|
|
184
|
+
opts = {
|
|
185
|
+
limit: 56 # Integer |
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
begin
|
|
189
|
+
#Retrieve conversation messages
|
|
190
|
+
result = api_instance.get_conversation_messages(conversation_uuid, since, opts)
|
|
191
|
+
p result
|
|
192
|
+
rescue UltracartClient::ApiError => e
|
|
193
|
+
puts "Exception when calling ConversationApi->get_conversation_messages: #{e}"
|
|
194
|
+
end
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Parameters
|
|
198
|
+
|
|
199
|
+
Name | Type | Description | Notes
|
|
200
|
+
------------- | ------------- | ------------- | -------------
|
|
201
|
+
**conversation_uuid** | **String**| |
|
|
202
|
+
**since** | **Integer**| |
|
|
203
|
+
**limit** | **Integer**| | [optional]
|
|
204
|
+
|
|
205
|
+
### Return type
|
|
206
|
+
|
|
207
|
+
[**ConversationMessagesResponse**](ConversationMessagesResponse.md)
|
|
208
|
+
|
|
209
|
+
### Authorization
|
|
210
|
+
|
|
211
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
212
|
+
|
|
213
|
+
### HTTP request headers
|
|
214
|
+
|
|
215
|
+
- **Content-Type**: application/json
|
|
216
|
+
- **Accept**: application/json
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
113
220
|
# **get_conversation_multimedia_upload_url**
|
|
114
221
|
> ConversationMultimediaUploadUrlResponse get_conversation_multimedia_upload_url(extension)
|
|
115
222
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationMessagesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**conversation_messages** | [**Array<ConversationMessage>**](ConversationMessage.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
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::EmailPostcardTracking
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**commseq_postcard_uuid** | **String** | | [optional]
|
|
7
|
+
**commseq_step_uuid** | **String** | | [optional]
|
|
8
|
+
**commseq_uuid** | **String** | | [optional]
|
|
9
|
+
**conversion_dts** | **String** | Conversion date time. | [optional]
|
|
10
|
+
**cost** | **Float** | | [optional]
|
|
11
|
+
**customer_uuid** | **String** | | [optional]
|
|
12
|
+
**delivered_dts** | **String** | Delivered date time. | [optional]
|
|
13
|
+
**from_address_line1** | **String** | | [optional]
|
|
14
|
+
**from_address_line2** | **String** | | [optional]
|
|
15
|
+
**from_city** | **String** | | [optional]
|
|
16
|
+
**from_name** | **String** | | [optional]
|
|
17
|
+
**from_state** | **String** | | [optional]
|
|
18
|
+
**from_zip** | **String** | | [optional]
|
|
19
|
+
**mailed_dts** | **String** | Mailed date time. | [optional]
|
|
20
|
+
**order_id** | **String** | | [optional]
|
|
21
|
+
**postcard_tracking_uuid** | **String** | | [optional]
|
|
22
|
+
**status** | **String** | | [optional]
|
|
23
|
+
**submit_dts** | **String** | Submit date time. | [optional]
|
|
24
|
+
**to_address_line1** | **String** | | [optional]
|
|
25
|
+
**to_address_line2** | **String** | | [optional]
|
|
26
|
+
**to_city** | **String** | | [optional]
|
|
27
|
+
**to_name** | **String** | | [optional]
|
|
28
|
+
**to_state** | **String** | | [optional]
|
|
29
|
+
**to_zip** | **String** | | [optional]
|
|
30
|
+
**tracking_description** | **String** | | [optional]
|
|
31
|
+
|
|
32
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::EmailPostcardTrackingResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
9
|
+
**tracking** | [**EmailPostcardTracking**](EmailPostcardTracking.md) | | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/StorefrontApi.md
CHANGED
|
@@ -44,6 +44,7 @@ Method | HTTP request | Description
|
|
|
44
44
|
[**get_email_commseq**](StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
|
|
45
45
|
[**get_email_commseq_email_stats**](StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
|
|
46
46
|
[**get_email_commseq_postcard_stats**](StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
|
|
47
|
+
[**get_email_commseq_postcard_tracking**](StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
|
|
47
48
|
[**get_email_commseq_stat_overall**](StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
|
|
48
49
|
[**get_email_commseq_step_stats**](StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
|
|
49
50
|
[**get_email_commseq_step_waiting**](StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
|
|
@@ -2190,6 +2191,57 @@ Name | Type | Description | Notes
|
|
|
2190
2191
|
|
|
2191
2192
|
|
|
2192
2193
|
|
|
2194
|
+
# **get_email_commseq_postcard_tracking**
|
|
2195
|
+
> EmailPostcardTrackingResponse get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
|
|
2196
|
+
|
|
2197
|
+
Get email communication postcard tracking
|
|
2198
|
+
|
|
2199
|
+
### Example
|
|
2200
|
+
```ruby
|
|
2201
|
+
# load the gem
|
|
2202
|
+
require 'ultracart_api'
|
|
2203
|
+
|
|
2204
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
2205
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
2206
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
storefront_oid = 56 # Integer |
|
|
2210
|
+
|
|
2211
|
+
commseq_postcard_uuid = 'commseq_postcard_uuid_example' # String |
|
|
2212
|
+
|
|
2213
|
+
|
|
2214
|
+
begin
|
|
2215
|
+
#Get email communication postcard tracking
|
|
2216
|
+
result = api_instance.get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
|
|
2217
|
+
p result
|
|
2218
|
+
rescue UltracartClient::ApiError => e
|
|
2219
|
+
puts "Exception when calling StorefrontApi->get_email_commseq_postcard_tracking: #{e}"
|
|
2220
|
+
end
|
|
2221
|
+
```
|
|
2222
|
+
|
|
2223
|
+
### Parameters
|
|
2224
|
+
|
|
2225
|
+
Name | Type | Description | Notes
|
|
2226
|
+
------------- | ------------- | ------------- | -------------
|
|
2227
|
+
**storefront_oid** | **Integer**| |
|
|
2228
|
+
**commseq_postcard_uuid** | **String**| |
|
|
2229
|
+
|
|
2230
|
+
### Return type
|
|
2231
|
+
|
|
2232
|
+
[**EmailPostcardTrackingResponse**](EmailPostcardTrackingResponse.md)
|
|
2233
|
+
|
|
2234
|
+
### Authorization
|
|
2235
|
+
|
|
2236
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2237
|
+
|
|
2238
|
+
### HTTP request headers
|
|
2239
|
+
|
|
2240
|
+
- **Content-Type**: application/json
|
|
2241
|
+
- **Accept**: application/json
|
|
2242
|
+
|
|
2243
|
+
|
|
2244
|
+
|
|
2193
2245
|
# **get_email_commseq_stat_overall**
|
|
2194
2246
|
> EmailCommseqStatResponse get_email_commseq_stat_overall(storefront_oid, commseq_uuid)
|
|
2195
2247
|
|
|
@@ -32,6 +32,54 @@ module UltracartClient
|
|
|
32
32
|
UltracartClient::ConversationApi.new(api_client)
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
+
# Agent keep alive
|
|
36
|
+
# Called periodically by the conversation API to keep the session alive.
|
|
37
|
+
# @param [Hash] opts the optional parameters
|
|
38
|
+
# @return [nil]
|
|
39
|
+
def get_agent_keep_alive(opts = {})
|
|
40
|
+
get_agent_keep_alive_with_http_info(opts)
|
|
41
|
+
nil
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# Agent keep alive
|
|
45
|
+
# Called periodically by the conversation API to keep the session alive.
|
|
46
|
+
# @param [Hash] opts the optional parameters
|
|
47
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
48
|
+
def get_agent_keep_alive_with_http_info(opts = {})
|
|
49
|
+
if @api_client.config.debugging
|
|
50
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_keep_alive ...'
|
|
51
|
+
end
|
|
52
|
+
# resource path
|
|
53
|
+
local_var_path = '/conversation/agent/keepalive'
|
|
54
|
+
|
|
55
|
+
# query parameters
|
|
56
|
+
query_params = {}
|
|
57
|
+
|
|
58
|
+
# header parameters
|
|
59
|
+
header_params = {}
|
|
60
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
61
|
+
# HTTP header 'Accept' (if needed)
|
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
63
|
+
# HTTP header 'Content-Type'
|
|
64
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
65
|
+
|
|
66
|
+
# form parameters
|
|
67
|
+
form_params = {}
|
|
68
|
+
|
|
69
|
+
# http body (model)
|
|
70
|
+
post_body = nil
|
|
71
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
72
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
73
|
+
:header_params => header_params,
|
|
74
|
+
:query_params => query_params,
|
|
75
|
+
:form_params => form_params,
|
|
76
|
+
:body => post_body,
|
|
77
|
+
:auth_names => auth_names)
|
|
78
|
+
if @api_client.config.debugging
|
|
79
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_agent_keep_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
80
|
+
end
|
|
81
|
+
return data, status_code, headers
|
|
82
|
+
end
|
|
35
83
|
# Get agent websocket authorization
|
|
36
84
|
# Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
37
85
|
# @param [Hash] opts the optional parameters
|
|
@@ -85,6 +133,7 @@ module UltracartClient
|
|
|
85
133
|
# Retrieve a conversation including the participants and messages
|
|
86
134
|
# @param conversation_uuid
|
|
87
135
|
# @param [Hash] opts the optional parameters
|
|
136
|
+
# @option opts [Integer] :limit
|
|
88
137
|
# @return [ConversationResponse]
|
|
89
138
|
def get_conversation(conversation_uuid, opts = {})
|
|
90
139
|
data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
|
|
@@ -95,6 +144,7 @@ module UltracartClient
|
|
|
95
144
|
# Retrieve a conversation including the participants and messages
|
|
96
145
|
# @param conversation_uuid
|
|
97
146
|
# @param [Hash] opts the optional parameters
|
|
147
|
+
# @option opts [Integer] :limit
|
|
98
148
|
# @return [Array<(ConversationResponse, Fixnum, Hash)>] ConversationResponse data, response status code and response headers
|
|
99
149
|
def get_conversation_with_http_info(conversation_uuid, opts = {})
|
|
100
150
|
if @api_client.config.debugging
|
|
@@ -109,6 +159,7 @@ module UltracartClient
|
|
|
109
159
|
|
|
110
160
|
# query parameters
|
|
111
161
|
query_params = {}
|
|
162
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
112
163
|
|
|
113
164
|
# header parameters
|
|
114
165
|
header_params = {}
|
|
@@ -136,6 +187,70 @@ module UltracartClient
|
|
|
136
187
|
end
|
|
137
188
|
return data, status_code, headers
|
|
138
189
|
end
|
|
190
|
+
# Retrieve conversation messages
|
|
191
|
+
# Retrieve conversation messages since a particular time
|
|
192
|
+
# @param conversation_uuid
|
|
193
|
+
# @param since
|
|
194
|
+
# @param [Hash] opts the optional parameters
|
|
195
|
+
# @option opts [Integer] :limit
|
|
196
|
+
# @return [ConversationMessagesResponse]
|
|
197
|
+
def get_conversation_messages(conversation_uuid, since, opts = {})
|
|
198
|
+
data, _status_code, _headers = get_conversation_messages_with_http_info(conversation_uuid, since, opts)
|
|
199
|
+
data
|
|
200
|
+
end
|
|
201
|
+
|
|
202
|
+
# Retrieve conversation messages
|
|
203
|
+
# Retrieve conversation messages since a particular time
|
|
204
|
+
# @param conversation_uuid
|
|
205
|
+
# @param since
|
|
206
|
+
# @param [Hash] opts the optional parameters
|
|
207
|
+
# @option opts [Integer] :limit
|
|
208
|
+
# @return [Array<(ConversationMessagesResponse, Fixnum, Hash)>] ConversationMessagesResponse data, response status code and response headers
|
|
209
|
+
def get_conversation_messages_with_http_info(conversation_uuid, since, opts = {})
|
|
210
|
+
if @api_client.config.debugging
|
|
211
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_messages ...'
|
|
212
|
+
end
|
|
213
|
+
# verify the required parameter 'conversation_uuid' is set
|
|
214
|
+
if @api_client.config.client_side_validation && conversation_uuid.nil?
|
|
215
|
+
fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_messages"
|
|
216
|
+
end
|
|
217
|
+
# verify the required parameter 'since' is set
|
|
218
|
+
if @api_client.config.client_side_validation && since.nil?
|
|
219
|
+
fail ArgumentError, "Missing the required parameter 'since' when calling ConversationApi.get_conversation_messages"
|
|
220
|
+
end
|
|
221
|
+
# resource path
|
|
222
|
+
local_var_path = '/conversation/conversations/{conversation_uuid}/messages/{since}'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s).sub('{' + 'since' + '}', since.to_s)
|
|
223
|
+
|
|
224
|
+
# query parameters
|
|
225
|
+
query_params = {}
|
|
226
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
227
|
+
|
|
228
|
+
# header parameters
|
|
229
|
+
header_params = {}
|
|
230
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
231
|
+
# HTTP header 'Accept' (if needed)
|
|
232
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
233
|
+
# HTTP header 'Content-Type'
|
|
234
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
235
|
+
|
|
236
|
+
# form parameters
|
|
237
|
+
form_params = {}
|
|
238
|
+
|
|
239
|
+
# http body (model)
|
|
240
|
+
post_body = nil
|
|
241
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
242
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
243
|
+
:header_params => header_params,
|
|
244
|
+
:query_params => query_params,
|
|
245
|
+
:form_params => form_params,
|
|
246
|
+
:body => post_body,
|
|
247
|
+
:auth_names => auth_names,
|
|
248
|
+
:return_type => 'ConversationMessagesResponse')
|
|
249
|
+
if @api_client.config.debugging
|
|
250
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
251
|
+
end
|
|
252
|
+
return data, status_code, headers
|
|
253
|
+
end
|
|
139
254
|
# Get a presigned conersation multimedia upload URL
|
|
140
255
|
# Get a presigned conersation multimedia upload URL
|
|
141
256
|
# @param extension
|
|
@@ -2339,6 +2339,65 @@ module UltracartClient
|
|
|
2339
2339
|
end
|
|
2340
2340
|
return data, status_code, headers
|
|
2341
2341
|
end
|
|
2342
|
+
# Get email communication postcard tracking
|
|
2343
|
+
# @param storefront_oid
|
|
2344
|
+
# @param commseq_postcard_uuid
|
|
2345
|
+
# @param [Hash] opts the optional parameters
|
|
2346
|
+
# @return [EmailPostcardTrackingResponse]
|
|
2347
|
+
def get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid, opts = {})
|
|
2348
|
+
data, _status_code, _headers = get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts)
|
|
2349
|
+
data
|
|
2350
|
+
end
|
|
2351
|
+
|
|
2352
|
+
# Get email communication postcard tracking
|
|
2353
|
+
# @param storefront_oid
|
|
2354
|
+
# @param commseq_postcard_uuid
|
|
2355
|
+
# @param [Hash] opts the optional parameters
|
|
2356
|
+
# @return [Array<(EmailPostcardTrackingResponse, Fixnum, Hash)>] EmailPostcardTrackingResponse data, response status code and response headers
|
|
2357
|
+
def get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {})
|
|
2358
|
+
if @api_client.config.debugging
|
|
2359
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_postcard_tracking ...'
|
|
2360
|
+
end
|
|
2361
|
+
# verify the required parameter 'storefront_oid' is set
|
|
2362
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
2363
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
|
|
2364
|
+
end
|
|
2365
|
+
# verify the required parameter 'commseq_postcard_uuid' is set
|
|
2366
|
+
if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
|
|
2367
|
+
fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
|
|
2368
|
+
end
|
|
2369
|
+
# resource path
|
|
2370
|
+
local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_postcard_uuid' + '}', commseq_postcard_uuid.to_s)
|
|
2371
|
+
|
|
2372
|
+
# query parameters
|
|
2373
|
+
query_params = {}
|
|
2374
|
+
|
|
2375
|
+
# header parameters
|
|
2376
|
+
header_params = {}
|
|
2377
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
2378
|
+
# HTTP header 'Accept' (if needed)
|
|
2379
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2380
|
+
# HTTP header 'Content-Type'
|
|
2381
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
2382
|
+
|
|
2383
|
+
# form parameters
|
|
2384
|
+
form_params = {}
|
|
2385
|
+
|
|
2386
|
+
# http body (model)
|
|
2387
|
+
post_body = nil
|
|
2388
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
2389
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
2390
|
+
:header_params => header_params,
|
|
2391
|
+
:query_params => query_params,
|
|
2392
|
+
:form_params => form_params,
|
|
2393
|
+
:body => post_body,
|
|
2394
|
+
:auth_names => auth_names,
|
|
2395
|
+
:return_type => 'EmailPostcardTrackingResponse')
|
|
2396
|
+
if @api_client.config.debugging
|
|
2397
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_postcard_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2398
|
+
end
|
|
2399
|
+
return data, status_code, headers
|
|
2400
|
+
end
|
|
2342
2401
|
# Get communication sequence stats overall
|
|
2343
2402
|
# @param storefront_oid
|
|
2344
2403
|
# @param commseq_uuid
|