ultracart_api 4.0.62.rc → 4.0.64.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -4
  3. data/docs/ConversationApi.md +154 -4
  4. data/docs/ConversationMessagesResponse.md +26 -0
  5. data/docs/EmailPostcardTracking.md +66 -0
  6. data/docs/EmailPostcardTrackingResponse.md +26 -0
  7. data/docs/StorefrontApi.md +72 -0
  8. data/lib/ultracart_api/api/conversation_api.rb +134 -0
  9. data/lib/ultracart_api/api/storefront_api.rb +68 -0
  10. data/lib/ultracart_api/models/conversation_messages_response.rb +258 -0
  11. data/lib/ultracart_api/models/email_postcard_tracking.rb +439 -0
  12. data/lib/ultracart_api/models/email_postcard_tracking_response.rb +256 -0
  13. data/lib/ultracart_api/version.rb +1 -1
  14. data/lib/ultracart_api.rb +3 -0
  15. metadata +8 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ec9e9c20f60990fdd7b6e160a82923a67a4cbabbbf13978693bcace76a29212e
4
- data.tar.gz: d35a763274a3507a9d61b8610229b7ee0097e3e517b2f7ec511eb50eed0f8836
3
+ metadata.gz: e1ed1c97e3f263b06950618cb32dfc1ee9a59a5bd94a42b54c29b474be60adef
4
+ data.tar.gz: 84cc1f79eaaa7e85018ef417c020d639a0a7d4bc95668c6bd83a46e004d66a8c
5
5
  SHA512:
6
- metadata.gz: 2652166dcc0817892b295d70b82caf28a1d735793292cba1e90bf60bcb61cd974c3fb040f70fa161d9588c119ad834efab68b53012ce034daf284f4bdc415117
7
- data.tar.gz: 2cf021ff4d5d609f74d386fbafa0dc372cb14f525c9333a3830980df883aab9ce605a10cae6fa3930614a4c716c43d25d760d501007aca9cca5b6e1fe5546226
6
+ metadata.gz: 64acc6802ec8ded7e8c438358339e97119ac57d46879a43b7a0cb49f544e5d4661491c70a33824134c3068459ad32d5f696f2e82cc0410a2d91e5a153ae677f8
7
+ data.tar.gz: 0656ec27b524e46538da54766cb20a6fa26475c3e0c61898b95829102edb4b9f1040a9026acfae3e98081c2ef1efc4080c2f3536a2215dda1d2cfca5a6de2a9c
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.62.rc
10
+ - Package version: 4.0.64.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.62.rc.gem
27
+ gem install ./ultracart_api-4.0.64.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.62.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.64.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.62.rc'
36
+ gem 'ultracart_api', '~> 4.0.64.rc'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -131,8 +131,10 @@ 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_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
134
135
  *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
135
136
  *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
137
+ *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
136
138
  *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
137
139
  *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
138
140
  *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
@@ -275,6 +277,7 @@ Class | Method | HTTP request | Description
275
277
  *UltracartClient::StorefrontApi* | [**get_email_commseq**](docs/StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
276
278
  *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
277
279
  *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
280
+ *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
278
281
  *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
279
282
  *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
280
283
  *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
@@ -577,6 +580,7 @@ Class | Method | HTTP request | Description
577
580
  - [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
578
581
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
579
582
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
583
+ - [UltracartClient::ConversationMessagesResponse](docs/ConversationMessagesResponse.md)
580
584
  - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
581
585
  - [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
582
586
  - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
@@ -770,6 +774,8 @@ Class | Method | HTTP request | Description
770
774
  - [UltracartClient::EmailPlanAdditional](docs/EmailPlanAdditional.md)
771
775
  - [UltracartClient::EmailPlanResponse](docs/EmailPlanResponse.md)
772
776
  - [UltracartClient::EmailPostcardStat](docs/EmailPostcardStat.md)
777
+ - [UltracartClient::EmailPostcardTracking](docs/EmailPostcardTracking.md)
778
+ - [UltracartClient::EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
773
779
  - [UltracartClient::EmailSegment](docs/EmailSegment.md)
774
780
  - [UltracartClient::EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
775
781
  - [UltracartClient::EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
@@ -1191,6 +1197,8 @@ Not every change is committed to every SDK.
1191
1197
 
1192
1198
  | Version | Date | Comments |
1193
1199
  | --: | :-: | --- |
1200
+ | 4.0.64-RC | 09/19/2022 | conversations pagination |
1201
+ | 4.0.63-RC | 09/13/2022 | storefront comms - postcard tracking |
1194
1202
  | 4.0.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
1195
1203
  | 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
1196
1204
  | 4.0.60-RC | 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,73 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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
+
22
+ > get_agent_keep_alive
23
+
24
+ Agent keep alive
25
+
26
+ Called periodically by the conversation API to keep the session alive.
27
+
28
+ ### Examples
29
+
30
+ ```ruby
31
+ require 'time'
32
+ require 'ultracart_api'
33
+ require 'json'
34
+ require 'yaml'
35
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
36
+
37
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
38
+ # As such, this might not be the best way to use this object.
39
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
40
+
41
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
42
+
43
+ begin
44
+ # Agent keep alive
45
+ api_instance.get_agent_keep_alive
46
+ rescue UltracartClient::ApiError => e
47
+ puts "Error when calling ConversationApi->get_agent_keep_alive: #{e}"
48
+ end
49
+ ```
50
+
51
+ #### Using the get_agent_keep_alive_with_http_info variant
52
+
53
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
54
+
55
+ > <Array(nil, Integer, Hash)> get_agent_keep_alive_with_http_info
56
+
57
+ ```ruby
58
+ begin
59
+ # Agent keep alive
60
+ data, status_code, headers = api_instance.get_agent_keep_alive_with_http_info
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => nil
64
+ rescue UltracartClient::ApiError => e
65
+ puts "Error when calling ConversationApi->get_agent_keep_alive_with_http_info: #{e}"
66
+ end
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ This endpoint does not need any parameter.
72
+
73
+ ### Return type
74
+
75
+ nil (empty response body)
76
+
77
+ ### Authorization
78
+
79
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: Not defined
84
+ - **Accept**: application/json
85
+
86
+
18
87
  ## get_agent_websocket_authorization
19
88
 
20
89
  > <ConversationAgentAuthResponse> get_agent_websocket_authorization
@@ -85,7 +154,7 @@ This endpoint does not need any parameter.
85
154
 
86
155
  ## get_conversation
87
156
 
88
- > <ConversationResponse> get_conversation(conversation_uuid)
157
+ > <ConversationResponse> get_conversation(conversation_uuid, opts)
89
158
 
90
159
  Retrieve a conversation
91
160
 
@@ -106,10 +175,13 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
106
175
 
107
176
  api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
108
177
  conversation_uuid = 'conversation_uuid_example' # String |
178
+ opts = {
179
+ limit: 56 # Integer |
180
+ }
109
181
 
110
182
  begin
111
183
  # Retrieve a conversation
112
- result = api_instance.get_conversation(conversation_uuid)
184
+ result = api_instance.get_conversation(conversation_uuid, opts)
113
185
  p result
114
186
  rescue UltracartClient::ApiError => e
115
187
  puts "Error when calling ConversationApi->get_conversation: #{e}"
@@ -120,12 +192,12 @@ end
120
192
 
121
193
  This returns an Array which contains the response data, status code and headers.
122
194
 
123
- > <Array(<ConversationResponse>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid)
195
+ > <Array(<ConversationResponse>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid, opts)
124
196
 
125
197
  ```ruby
126
198
  begin
127
199
  # Retrieve a conversation
128
- data, status_code, headers = api_instance.get_conversation_with_http_info(conversation_uuid)
200
+ data, status_code, headers = api_instance.get_conversation_with_http_info(conversation_uuid, opts)
129
201
  p status_code # => 2xx
130
202
  p headers # => { ... }
131
203
  p data # => <ConversationResponse>
@@ -139,6 +211,7 @@ end
139
211
  | Name | Type | Description | Notes |
140
212
  | ---- | ---- | ----------- | ----- |
141
213
  | **conversation_uuid** | **String** | | |
214
+ | **limit** | **Integer** | | [optional] |
142
215
 
143
216
  ### Return type
144
217
 
@@ -154,6 +227,83 @@ end
154
227
  - **Accept**: application/json
155
228
 
156
229
 
230
+ ## get_conversation_messages
231
+
232
+ > <ConversationMessagesResponse> get_conversation_messages(conversation_uuid, since, opts)
233
+
234
+ Retrieve conversation messages
235
+
236
+ Retrieve conversation messages since a particular time
237
+
238
+ ### Examples
239
+
240
+ ```ruby
241
+ require 'time'
242
+ require 'ultracart_api'
243
+ require 'json'
244
+ require 'yaml'
245
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
246
+
247
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
248
+ # As such, this might not be the best way to use this object.
249
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
250
+
251
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
252
+ conversation_uuid = 'conversation_uuid_example' # String |
253
+ since = 789 # Integer |
254
+ opts = {
255
+ limit: 56 # Integer |
256
+ }
257
+
258
+ begin
259
+ # Retrieve conversation messages
260
+ result = api_instance.get_conversation_messages(conversation_uuid, since, opts)
261
+ p result
262
+ rescue UltracartClient::ApiError => e
263
+ puts "Error when calling ConversationApi->get_conversation_messages: #{e}"
264
+ end
265
+ ```
266
+
267
+ #### Using the get_conversation_messages_with_http_info variant
268
+
269
+ This returns an Array which contains the response data, status code and headers.
270
+
271
+ > <Array(<ConversationMessagesResponse>, Integer, Hash)> get_conversation_messages_with_http_info(conversation_uuid, since, opts)
272
+
273
+ ```ruby
274
+ begin
275
+ # Retrieve conversation messages
276
+ data, status_code, headers = api_instance.get_conversation_messages_with_http_info(conversation_uuid, since, opts)
277
+ p status_code # => 2xx
278
+ p headers # => { ... }
279
+ p data # => <ConversationMessagesResponse>
280
+ rescue UltracartClient::ApiError => e
281
+ puts "Error when calling ConversationApi->get_conversation_messages_with_http_info: #{e}"
282
+ end
283
+ ```
284
+
285
+ ### Parameters
286
+
287
+ | Name | Type | Description | Notes |
288
+ | ---- | ---- | ----------- | ----- |
289
+ | **conversation_uuid** | **String** | | |
290
+ | **since** | **Integer** | | |
291
+ | **limit** | **Integer** | | [optional] |
292
+
293
+ ### Return type
294
+
295
+ [**ConversationMessagesResponse**](ConversationMessagesResponse.md)
296
+
297
+ ### Authorization
298
+
299
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
300
+
301
+ ### HTTP request headers
302
+
303
+ - **Content-Type**: Not defined
304
+ - **Accept**: application/json
305
+
306
+
157
307
  ## get_conversation_multimedia_upload_url
158
308
 
159
309
  > <ConversationMultimediaUploadUrlResponse> get_conversation_multimedia_upload_url(extension)
data/docs/ConversationMessagesResponse.md ADDED
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ConversationMessagesResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conversation_messages** | [**Array&lt;ConversationMessage&gt;**](ConversationMessage.md) | | [optional] |
8
+ | **error** | [**Error**](Error.md) | | [optional] |
9
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ConversationMessagesResponse.new(
19
+ conversation_messages: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
data/docs/EmailPostcardTracking.md ADDED
@@ -0,0 +1,66 @@
1
+ # UltracartClient::EmailPostcardTracking
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **commseq_postcard_uuid** | **String** | | [optional] |
8
+ | **commseq_step_uuid** | **String** | | [optional] |
9
+ | **commseq_uuid** | **String** | | [optional] |
10
+ | **conversion_dts** | **String** | Conversion date time. | [optional] |
11
+ | **cost** | **Float** | | [optional] |
12
+ | **customer_uuid** | **String** | | [optional] |
13
+ | **delivered_dts** | **String** | Delivered date time. | [optional] |
14
+ | **from_address_line1** | **String** | | [optional] |
15
+ | **from_address_line2** | **String** | | [optional] |
16
+ | **from_city** | **String** | | [optional] |
17
+ | **from_name** | **String** | | [optional] |
18
+ | **from_state** | **String** | | [optional] |
19
+ | **from_zip** | **String** | | [optional] |
20
+ | **mailed_dts** | **String** | Mailed date time. | [optional] |
21
+ | **order_id** | **String** | | [optional] |
22
+ | **postcard_tracking_uuid** | **String** | | [optional] |
23
+ | **status** | **String** | | [optional] |
24
+ | **submit_dts** | **String** | Submit date time. | [optional] |
25
+ | **to_address_line1** | **String** | | [optional] |
26
+ | **to_address_line2** | **String** | | [optional] |
27
+ | **to_city** | **String** | | [optional] |
28
+ | **to_name** | **String** | | [optional] |
29
+ | **to_state** | **String** | | [optional] |
30
+ | **to_zip** | **String** | | [optional] |
31
+ | **tracking_description** | **String** | | [optional] |
32
+
33
+ ## Example
34
+
35
+ ```ruby
36
+ require 'ultracart_api'
37
+
38
+ instance = UltracartClient::EmailPostcardTracking.new(
39
+ commseq_postcard_uuid: null,
40
+ commseq_step_uuid: null,
41
+ commseq_uuid: null,
42
+ conversion_dts: null,
43
+ cost: null,
44
+ customer_uuid: null,
45
+ delivered_dts: null,
46
+ from_address_line1: null,
47
+ from_address_line2: null,
48
+ from_city: null,
49
+ from_name: null,
50
+ from_state: null,
51
+ from_zip: null,
52
+ mailed_dts: null,
53
+ order_id: null,
54
+ postcard_tracking_uuid: null,
55
+ status: null,
56
+ submit_dts: null,
57
+ to_address_line1: null,
58
+ to_address_line2: null,
59
+ to_city: null,
60
+ to_name: null,
61
+ to_state: null,
62
+ to_zip: null,
63
+ tracking_description: null
64
+ )
65
+ ```
66
+
data/docs/EmailPostcardTrackingResponse.md ADDED
@@ -0,0 +1,26 @@
1
+ # UltracartClient::EmailPostcardTrackingResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
9
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
10
+ | **tracking** | [**EmailPostcardTracking**](EmailPostcardTracking.md) | | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::EmailPostcardTrackingResponse.new(
19
+ error: null,
20
+ metadata: null,
21
+ success: null,
22
+ tracking: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
data/docs/StorefrontApi.md CHANGED
@@ -44,6 +44,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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 |
@@ -3000,6 +3001,77 @@ end
3000
3001
  - **Accept**: application/json
3001
3002
 
3002
3003
 
3004
+ ## get_email_commseq_postcard_tracking
3005
+
3006
+ > <EmailPostcardTrackingResponse> get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
3007
+
3008
+ Get email communication postcard tracking
3009
+
3010
+ ### Examples
3011
+
3012
+ ```ruby
3013
+ require 'time'
3014
+ require 'ultracart_api'
3015
+ require 'json'
3016
+ require 'yaml'
3017
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
3018
+
3019
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
3020
+ # As such, this might not be the best way to use this object.
3021
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
3022
+
3023
+ api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
3024
+ storefront_oid = 56 # Integer |
3025
+ commseq_postcard_uuid = 'commseq_postcard_uuid_example' # String |
3026
+
3027
+ begin
3028
+ # Get email communication postcard tracking
3029
+ result = api_instance.get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
3030
+ p result
3031
+ rescue UltracartClient::ApiError => e
3032
+ puts "Error when calling StorefrontApi->get_email_commseq_postcard_tracking: #{e}"
3033
+ end
3034
+ ```
3035
+
3036
+ #### Using the get_email_commseq_postcard_tracking_with_http_info variant
3037
+
3038
+ This returns an Array which contains the response data, status code and headers.
3039
+
3040
+ > <Array(<EmailPostcardTrackingResponse>, Integer, Hash)> get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid)
3041
+
3042
+ ```ruby
3043
+ begin
3044
+ # Get email communication postcard tracking
3045
+ data, status_code, headers = api_instance.get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid)
3046
+ p status_code # => 2xx
3047
+ p headers # => { ... }
3048
+ p data # => <EmailPostcardTrackingResponse>
3049
+ rescue UltracartClient::ApiError => e
3050
+ puts "Error when calling StorefrontApi->get_email_commseq_postcard_tracking_with_http_info: #{e}"
3051
+ end
3052
+ ```
3053
+
3054
+ ### Parameters
3055
+
3056
+ | Name | Type | Description | Notes |
3057
+ | ---- | ---- | ----------- | ----- |
3058
+ | **storefront_oid** | **Integer** | | |
3059
+ | **commseq_postcard_uuid** | **String** | | |
3060
+
3061
+ ### Return type
3062
+
3063
+ [**EmailPostcardTrackingResponse**](EmailPostcardTrackingResponse.md)
3064
+
3065
+ ### Authorization
3066
+
3067
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
3068
+
3069
+ ### HTTP request headers
3070
+
3071
+ - **Content-Type**: Not defined
3072
+ - **Accept**: application/json
3073
+
3074
+
3003
3075
  ## get_email_commseq_stat_overall
3004
3076
 
3005
3077
  > <EmailCommseqStatResponse> get_email_commseq_stat_overall(storefront_oid, commseq_uuid)
data/lib/ultracart_api/api/conversation_api.rb CHANGED
@@ -32,6 +32,64 @@ 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, Integer, 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 = opts[:query_params] || {}
57
+
58
+ # header parameters
59
+ header_params = opts[: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
+
64
+ # form parameters
65
+ form_params = opts[:form_params] || {}
66
+
67
+ # http body (model)
68
+ post_body = opts[:debug_body]
69
+
70
+ # return_type
71
+ return_type = opts[:debug_return_type]
72
+
73
+ # auth_names
74
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
75
+
76
+ new_options = opts.merge(
77
+ :operation => :"ConversationApi.get_agent_keep_alive",
78
+ :header_params => header_params,
79
+ :query_params => query_params,
80
+ :form_params => form_params,
81
+ :body => post_body,
82
+ :auth_names => auth_names,
83
+ :return_type => return_type
84
+ )
85
+
86
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
87
+ if @api_client.config.debugging
88
+ @api_client.config.logger.debug "API called: ConversationApi#get_agent_keep_alive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
89
+ end
90
+ return data, status_code, headers
91
+ end
92
+
35
93
  # Get agent websocket authorization
36
94
  # Retrieve a JWT to authorize an agent to make a websocket connection.
37
95
  # @param [Hash] opts the optional parameters
@@ -94,6 +152,7 @@ module UltracartClient
94
152
  # Retrieve a conversation including the participants and messages
95
153
  # @param conversation_uuid [String]
96
154
  # @param [Hash] opts the optional parameters
155
+ # @option opts [Integer] :limit
97
156
  # @return [ConversationResponse]
98
157
  def get_conversation(conversation_uuid, opts = {})
99
158
  data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
@@ -104,6 +163,7 @@ module UltracartClient
104
163
  # Retrieve a conversation including the participants and messages
105
164
  # @param conversation_uuid [String]
106
165
  # @param [Hash] opts the optional parameters
166
+ # @option opts [Integer] :limit
107
167
  # @return [Array<(ConversationResponse, Integer, Hash)>] ConversationResponse data, response status code and response headers
108
168
  def get_conversation_with_http_info(conversation_uuid, opts = {})
109
169
  if @api_client.config.debugging
@@ -118,6 +178,7 @@ module UltracartClient
118
178
 
119
179
  # query parameters
120
180
  query_params = opts[:query_params] || {}
181
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
121
182
 
122
183
  # header parameters
123
184
  header_params = opts[:header_params] || {}
@@ -154,6 +215,79 @@ module UltracartClient
154
215
  return data, status_code, headers
155
216
  end
156
217
 
218
+ # Retrieve conversation messages
219
+ # Retrieve conversation messages since a particular time
220
+ # @param conversation_uuid [String]
221
+ # @param since [Integer]
222
+ # @param [Hash] opts the optional parameters
223
+ # @option opts [Integer] :limit
224
+ # @return [ConversationMessagesResponse]
225
+ def get_conversation_messages(conversation_uuid, since, opts = {})
226
+ data, _status_code, _headers = get_conversation_messages_with_http_info(conversation_uuid, since, opts)
227
+ data
228
+ end
229
+
230
+ # Retrieve conversation messages
231
+ # Retrieve conversation messages since a particular time
232
+ # @param conversation_uuid [String]
233
+ # @param since [Integer]
234
+ # @param [Hash] opts the optional parameters
235
+ # @option opts [Integer] :limit
236
+ # @return [Array<(ConversationMessagesResponse, Integer, Hash)>] ConversationMessagesResponse data, response status code and response headers
237
+ def get_conversation_messages_with_http_info(conversation_uuid, since, opts = {})
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_messages ...'
240
+ end
241
+ # verify the required parameter 'conversation_uuid' is set
242
+ if @api_client.config.client_side_validation && conversation_uuid.nil?
243
+ fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_messages"
244
+ end
245
+ # verify the required parameter 'since' is set
246
+ if @api_client.config.client_side_validation && since.nil?
247
+ fail ArgumentError, "Missing the required parameter 'since' when calling ConversationApi.get_conversation_messages"
248
+ end
249
+ # resource path
250
+ local_var_path = '/conversation/conversations/{conversation_uuid}/messages/{since}'.sub('{' + 'conversation_uuid' + '}', CGI.escape(conversation_uuid.to_s)).sub('{' + 'since' + '}', CGI.escape(since.to_s))
251
+
252
+ # query parameters
253
+ query_params = opts[:query_params] || {}
254
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
255
+
256
+ # header parameters
257
+ header_params = opts[:header_params] || {}
258
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
259
+ # HTTP header 'Accept' (if needed)
260
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
261
+
262
+ # form parameters
263
+ form_params = opts[:form_params] || {}
264
+
265
+ # http body (model)
266
+ post_body = opts[:debug_body]
267
+
268
+ # return_type
269
+ return_type = opts[:debug_return_type] || 'ConversationMessagesResponse'
270
+
271
+ # auth_names
272
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
273
+
274
+ new_options = opts.merge(
275
+ :operation => :"ConversationApi.get_conversation_messages",
276
+ :header_params => header_params,
277
+ :query_params => query_params,
278
+ :form_params => form_params,
279
+ :body => post_body,
280
+ :auth_names => auth_names,
281
+ :return_type => return_type
282
+ )
283
+
284
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
285
+ if @api_client.config.debugging
286
+ @api_client.config.logger.debug "API called: ConversationApi#get_conversation_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
287
+ end
288
+ return data, status_code, headers
289
+ end
290
+
157
291
  # Get a presigned conersation multimedia upload URL
158
292
  # Get a presigned conersation multimedia upload URL
159
293
  # @param extension [String]