ultracart_api 4.0.85.rc → 4.0.87.rc

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.
Files changed (20) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -4
  3. data/docs/ConversationApi.md +72 -0
  4. data/docs/ConversationWebchatContext.md +26 -0
  5. data/docs/CouponPercentOffMsrpItems.md +5 -1
  6. data/docs/HitPageView.md +38 -0
  7. data/docs/HitPageViewMetaData.md +20 -0
  8. data/docs/HitSessionStart.md +50 -0
  9. data/docs/HitSessionUtm.md +46 -0
  10. data/lib/ultracart_api/api/conversation_api.rb +64 -0
  11. data/lib/ultracart_api/models/conversation_webchat_context.rb +257 -0
  12. data/lib/ultracart_api/models/conversation_websocket_message.rb +2 -2
  13. data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +24 -4
  14. data/lib/ultracart_api/models/hit_page_view.rb +311 -0
  15. data/lib/ultracart_api/models/hit_page_view_meta_data.rb +228 -0
  16. data/lib/ultracart_api/models/hit_session_start.rb +363 -0
  17. data/lib/ultracart_api/models/hit_session_utm.rb +345 -0
  18. data/lib/ultracart_api/version.rb +1 -1
  19. data/lib/ultracart_api.rb +5 -0
  20. metadata +11 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 723d0ab84f7c853d3cef91943efa454e50b0c41ebe17bc04b1ec1bbeca68d8d3
4
- data.tar.gz: f0270981b9ecd0fa99d1a31485816d2c166314d9ffd5f07d87cc994a7745e59f
3
+ metadata.gz: dc219066ac586692df1300754f45595fffa03ab2734801bd0950156d5b64d3ab
4
+ data.tar.gz: bea4eee612019ac116e992d5c68ecc4844ee051ce97ff6d7ec37150c1753f67a
5
5
  SHA512:
6
- metadata.gz: 97b09e707acd5f31e89e0b0d6ca64ac0fce768a82c4cb33a5d7cf4d059e94bbb3f3493e630b3e3d7f9e638ab1d5b85a4ea4c64171e488cddf6cc2591f31649ba
7
- data.tar.gz: 0d3e0fd392d2aff7b71b0c3173b13764f569a99249f32269a46759756f0760a7ec676ba6f18c2795140582e873a339000e9803adfa3fab6a79be881a6cf2bcff
6
+ metadata.gz: 3fb52576a7a509c0664f5b0c51db4679150841c357c003e35feeed6f1c4174f9ca32228c2ad97a7c51877ff550adf7526860682ec2e58ba2e27d68416420cebd
7
+ data.tar.gz: cc957623034627e837c4a660c9c52c349a82d22527f7aac85bc54cdb1187257119559dfbf1bcf81861562d8a9b7ae960986ca78d5c46cc55d0611f302d137c39
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.85.rc
10
+ - Package version: 4.0.87.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.85.rc.gem
27
+ gem install ./ultracart_api-4.0.87.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.85.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.87.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.85.rc'
36
+ gem 'ultracart_api', '~> 4.0.87.rc'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -134,6 +134,7 @@ Class | Method | HTTP request | Description
134
134
  *UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
135
135
  *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
136
136
  *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
137
+ *UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
137
138
  *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
138
139
  *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
139
140
  *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
@@ -606,6 +607,7 @@ Class | Method | HTTP request | Description
606
607
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
607
608
  - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
608
609
  - [UltracartClient::ConversationTwilioAccount](docs/ConversationTwilioAccount.md)
610
+ - [UltracartClient::ConversationWebchatContext](docs/ConversationWebchatContext.md)
609
611
  - [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
610
612
  - [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
611
613
  - [UltracartClient::ConversationWebchatQueueStatusQueueEntry](docs/ConversationWebchatQueueStatusQueueEntry.md)
@@ -858,6 +860,10 @@ Class | Method | HTTP request | Description
858
860
  - [UltracartClient::GroupUserMembership](docs/GroupUserMembership.md)
859
861
  - [UltracartClient::GroupsResponse](docs/GroupsResponse.md)
860
862
  - [UltracartClient::HTTPHeader](docs/HTTPHeader.md)
863
+ - [UltracartClient::HitPageView](docs/HitPageView.md)
864
+ - [UltracartClient::HitPageViewMetaData](docs/HitPageViewMetaData.md)
865
+ - [UltracartClient::HitSessionStart](docs/HitSessionStart.md)
866
+ - [UltracartClient::HitSessionUtm](docs/HitSessionUtm.md)
861
867
  - [UltracartClient::IntegrationLog](docs/IntegrationLog.md)
862
868
  - [UltracartClient::IntegrationLogFile](docs/IntegrationLogFile.md)
863
869
  - [UltracartClient::IntegrationLogLog](docs/IntegrationLogLog.md)
@@ -1227,6 +1233,8 @@ Not every change is committed to every SDK.
1227
1233
 
1228
1234
  | Version | Date | Comments |
1229
1235
  | --: | :-: | --- |
1236
+ | 4.0.87-RC | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
1237
+ | 4.0.86-RC | 11/21/2022 | conversation context method |
1230
1238
  | 4.0.85-RC | 11/21/2022 | adjusted conversation event model |
1231
1239
  | 4.0.84-RC | 11/15/2022 | conversation methods bug fix |
1232
1240
  | 4.0.83-RC | 11/15/2022 | conversations - enw events for add coupon and items |
data/docs/ConversationApi.md CHANGED
@@ -7,6 +7,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
7
7
  | [**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive |
8
8
  | [**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization |
9
9
  | [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation |
10
+ | [**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context |
10
11
  | [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages |
11
12
  | [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL |
12
13
  | [**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses |
@@ -227,6 +228,77 @@ end
227
228
  - **Accept**: application/json
228
229
 
229
230
 
231
+ ## get_conversation_context
232
+
233
+ > <ConversationWebchatContext> get_conversation_context(conversation_uuid)
234
+
235
+ Get a webchat conversation context
236
+
237
+ Get a webchat conversation context
238
+
239
+ ### Examples
240
+
241
+ ```ruby
242
+ require 'time'
243
+ require 'ultracart_api'
244
+ require 'json'
245
+ require 'yaml'
246
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
247
+
248
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
249
+ # As such, this might not be the best way to use this object.
250
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
251
+
252
+ api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
253
+ conversation_uuid = 'conversation_uuid_example' # String |
254
+
255
+ begin
256
+ # Get a webchat conversation context
257
+ result = api_instance.get_conversation_context(conversation_uuid)
258
+ p result
259
+ rescue UltracartClient::ApiError => e
260
+ puts "Error when calling ConversationApi->get_conversation_context: #{e}"
261
+ end
262
+ ```
263
+
264
+ #### Using the get_conversation_context_with_http_info variant
265
+
266
+ This returns an Array which contains the response data, status code and headers.
267
+
268
+ > <Array(<ConversationWebchatContext>, Integer, Hash)> get_conversation_context_with_http_info(conversation_uuid)
269
+
270
+ ```ruby
271
+ begin
272
+ # Get a webchat conversation context
273
+ data, status_code, headers = api_instance.get_conversation_context_with_http_info(conversation_uuid)
274
+ p status_code # => 2xx
275
+ p headers # => { ... }
276
+ p data # => <ConversationWebchatContext>
277
+ rescue UltracartClient::ApiError => e
278
+ puts "Error when calling ConversationApi->get_conversation_context_with_http_info: #{e}"
279
+ end
280
+ ```
281
+
282
+ ### Parameters
283
+
284
+ | Name | Type | Description | Notes |
285
+ | ---- | ---- | ----------- | ----- |
286
+ | **conversation_uuid** | **String** | | |
287
+
288
+ ### Return type
289
+
290
+ [**ConversationWebchatContext**](ConversationWebchatContext.md)
291
+
292
+ ### Authorization
293
+
294
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
295
+
296
+ ### HTTP request headers
297
+
298
+ - **Content-Type**: Not defined
299
+ - **Accept**: application/json
300
+
301
+
230
302
  ## get_conversation_messages
231
303
 
232
304
  > <ConversationMessagesResponse> get_conversation_messages(conversation_uuid, since, opts)
data/docs/ConversationWebchatContext.md ADDED
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ConversationWebchatContext
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cart** | [**Cart**](Cart.md) | | [optional] |
8
+ | **current_url** | **String** | | [optional] |
9
+ | **page_view** | [**Array&lt;HitPageView&gt;**](HitPageView.md) | | [optional] |
10
+ | **session_start** | [**HitSessionStart**](HitSessionStart.md) | | [optional] |
11
+ | **session_utm** | [**HitSessionUtm**](HitSessionUtm.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ConversationWebchatContext.new(
19
+ cart: null,
20
+ current_url: null,
21
+ page_view: null,
22
+ session_start: null,
23
+ session_utm: null
24
+ )
25
+ ```
26
+
data/docs/CouponPercentOffMsrpItems.md CHANGED
@@ -8,6 +8,8 @@
8
8
  | **excluded_items** | **Array&lt;String&gt;** | A list of items which cannot be discounted. | [optional] |
9
9
  | **items** | **Array&lt;String&gt;** | An list of items which will receive a discount. | [optional] |
10
10
  | **limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional] |
11
+ | **minimum_cumulative_msrp** | **Float** | The (optional) minimum cumulative msrp of qualifying items. | [optional] |
12
+ | **minimum_subtotal** | **Float** | The (optional) minimum subtotal of qualifying items. | [optional] |
11
13
 
12
14
  ## Example
13
15
 
@@ -18,7 +20,9 @@ instance = UltracartClient::CouponPercentOffMsrpItems.new(
18
20
  discount_percent: null,
19
21
  excluded_items: null,
20
22
  items: null,
21
- limit: null
23
+ limit: null,
24
+ minimum_cumulative_msrp: null,
25
+ minimum_subtotal: null
22
26
  )
23
27
  ```
24
28
 
data/docs/HitPageView.md ADDED
@@ -0,0 +1,38 @@
1
+ # UltracartClient::HitPageView
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **bounce** | **Boolean** | | [optional] |
8
+ | **meta_data** | [**Array&lt;HitPageViewMetaData&gt;**](HitPageViewMetaData.md) | | [optional] |
9
+ | **method** | **String** | | [optional] |
10
+ | **prefetch** | **Boolean** | | [optional] |
11
+ | **query** | **String** | | [optional] |
12
+ | **recording** | **Boolean** | | [optional] |
13
+ | **redirect** | **Boolean** | | [optional] |
14
+ | **referrer** | **String** | | [optional] |
15
+ | **time_on_page** | **Float** | | [optional] |
16
+ | **title** | **String** | | [optional] |
17
+ | **url** | **String** | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'ultracart_api'
23
+
24
+ instance = UltracartClient::HitPageView.new(
25
+ bounce: null,
26
+ meta_data: null,
27
+ method: null,
28
+ prefetch: null,
29
+ query: null,
30
+ recording: null,
31
+ redirect: null,
32
+ referrer: null,
33
+ time_on_page: null,
34
+ title: null,
35
+ url: null
36
+ )
37
+ ```
38
+
data/docs/HitPageViewMetaData.md ADDED
@@ -0,0 +1,20 @@
1
+ # UltracartClient::HitPageViewMetaData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **key** | **String** | | [optional] |
8
+ | **value** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::HitPageViewMetaData.new(
16
+ key: null,
17
+ value: null
18
+ )
19
+ ```
20
+
data/docs/HitSessionStart.md ADDED
@@ -0,0 +1,50 @@
1
+ # UltracartClient::HitSessionStart
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **bot** | **Boolean** | | [optional] |
8
+ | **bounce** | **Boolean** | | [optional] |
9
+ | **channel** | **String** | | [optional] |
10
+ | **device_switch_detected** | **Boolean** | | [optional] |
11
+ | **fake_bot** | **Boolean** | | [optional] |
12
+ | **geolocation_country** | **String** | | [optional] |
13
+ | **geolocation_latitude** | **Float** | | [optional] |
14
+ | **geolocation_longitude** | **Float** | | [optional] |
15
+ | **geolocation_province** | **String** | | [optional] |
16
+ | **no_cookie_support** | **Boolean** | | [optional] |
17
+ | **prefetch** | **Boolean** | | [optional] |
18
+ | **referrer** | **String** | | [optional] |
19
+ | **screen_height** | **Integer** | | [optional] |
20
+ | **screen_width** | **Integer** | | [optional] |
21
+ | **time_on_site** | **Float** | | [optional] |
22
+ | **user_agent** | **String** | | [optional] |
23
+ | **user_ip** | **String** | | [optional] |
24
+
25
+ ## Example
26
+
27
+ ```ruby
28
+ require 'ultracart_api'
29
+
30
+ instance = UltracartClient::HitSessionStart.new(
31
+ bot: null,
32
+ bounce: null,
33
+ channel: null,
34
+ device_switch_detected: null,
35
+ fake_bot: null,
36
+ geolocation_country: null,
37
+ geolocation_latitude: null,
38
+ geolocation_longitude: null,
39
+ geolocation_province: null,
40
+ no_cookie_support: null,
41
+ prefetch: null,
42
+ referrer: null,
43
+ screen_height: null,
44
+ screen_width: null,
45
+ time_on_site: null,
46
+ user_agent: null,
47
+ user_ip: null
48
+ )
49
+ ```
50
+
data/docs/HitSessionUtm.md ADDED
@@ -0,0 +1,46 @@
1
+ # UltracartClient::HitSessionUtm
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **fb_ad_id** | **String** | | [optional] |
8
+ | **fbclid** | **String** | | [optional] |
9
+ | **gbraid** | **String** | | [optional] |
10
+ | **gclid** | **String** | | [optional] |
11
+ | **msclkid** | **String** | | [optional] |
12
+ | **ttclid** | **String** | | [optional] |
13
+ | **uc_message_id** | **String** | | [optional] |
14
+ | **utm_campaign** | **String** | | [optional] |
15
+ | **utm_content** | **String** | | [optional] |
16
+ | **utm_id** | **String** | | [optional] |
17
+ | **utm_medium** | **String** | | [optional] |
18
+ | **utm_source** | **String** | | [optional] |
19
+ | **utm_term** | **String** | | [optional] |
20
+ | **vmcid** | **String** | | [optional] |
21
+ | **wbraid** | **String** | | [optional] |
22
+
23
+ ## Example
24
+
25
+ ```ruby
26
+ require 'ultracart_api'
27
+
28
+ instance = UltracartClient::HitSessionUtm.new(
29
+ fb_ad_id: null,
30
+ fbclid: null,
31
+ gbraid: null,
32
+ gclid: null,
33
+ msclkid: null,
34
+ ttclid: null,
35
+ uc_message_id: null,
36
+ utm_campaign: null,
37
+ utm_content: null,
38
+ utm_id: null,
39
+ utm_medium: null,
40
+ utm_source: null,
41
+ utm_term: null,
42
+ vmcid: null,
43
+ wbraid: null
44
+ )
45
+ ```
46
+
data/lib/ultracart_api/api/conversation_api.rb CHANGED
@@ -215,6 +215,70 @@ module UltracartClient
215
215
  return data, status_code, headers
216
216
  end
217
217
 
218
+ # Get a webchat conversation context
219
+ # Get a webchat conversation context
220
+ # @param conversation_uuid [String]
221
+ # @param [Hash] opts the optional parameters
222
+ # @return [ConversationWebchatContext]
223
+ def get_conversation_context(conversation_uuid, opts = {})
224
+ data, _status_code, _headers = get_conversation_context_with_http_info(conversation_uuid, opts)
225
+ data
226
+ end
227
+
228
+ # Get a webchat conversation context
229
+ # Get a webchat conversation context
230
+ # @param conversation_uuid [String]
231
+ # @param [Hash] opts the optional parameters
232
+ # @return [Array<(ConversationWebchatContext, Integer, Hash)>] ConversationWebchatContext data, response status code and response headers
233
+ def get_conversation_context_with_http_info(conversation_uuid, opts = {})
234
+ if @api_client.config.debugging
235
+ @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_context ...'
236
+ end
237
+ # verify the required parameter 'conversation_uuid' is set
238
+ if @api_client.config.client_side_validation && conversation_uuid.nil?
239
+ fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.get_conversation_context"
240
+ end
241
+ # resource path
242
+ local_var_path = '/conversation/conversations/{conversation_uuid}/context'.sub('{' + 'conversation_uuid' + '}', CGI.escape(conversation_uuid.to_s))
243
+
244
+ # query parameters
245
+ query_params = opts[:query_params] || {}
246
+
247
+ # header parameters
248
+ header_params = opts[:header_params] || {}
249
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
250
+ # HTTP header 'Accept' (if needed)
251
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
252
+
253
+ # form parameters
254
+ form_params = opts[:form_params] || {}
255
+
256
+ # http body (model)
257
+ post_body = opts[:debug_body]
258
+
259
+ # return_type
260
+ return_type = opts[:debug_return_type] || 'ConversationWebchatContext'
261
+
262
+ # auth_names
263
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
264
+
265
+ new_options = opts.merge(
266
+ :operation => :"ConversationApi.get_conversation_context",
267
+ :header_params => header_params,
268
+ :query_params => query_params,
269
+ :form_params => form_params,
270
+ :body => post_body,
271
+ :auth_names => auth_names,
272
+ :return_type => return_type
273
+ )
274
+
275
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
276
+ if @api_client.config.debugging
277
+ @api_client.config.logger.debug "API called: ConversationApi#get_conversation_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
278
+ end
279
+ return data, status_code, headers
280
+ end
281
+
218
282
  # Retrieve conversation messages
219
283
  # Retrieve conversation messages since a particular time
220
284
  # @param conversation_uuid [String]