ultracart_api 4.0.84.rc → 4.0.86.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +13 -4
- data/docs/ConversationApi.md +72 -0
- data/docs/ConversationEventAddCoupon.md +4 -0
- data/docs/ConversationEventAddItem.md +6 -2
- data/docs/ConversationEventWebchatContext.md +22 -0
- data/docs/ConversationWebchatContext.md +26 -0
- data/docs/ConversationWebsocketMessage.md +2 -0
- data/docs/HitPageView.md +38 -0
- data/docs/HitPageViewMetaData.md +20 -0
- data/docs/HitSessionStart.md +50 -0
- data/docs/HitSessionUtm.md +46 -0
- data/lib/ultracart_api/api/conversation_api.rb +64 -0
- data/lib/ultracart_api/models/conversation_event_add_coupon.rb +19 -1
- data/lib/ultracart_api/models/conversation_event_add_item.rb +27 -7
- data/lib/ultracart_api/models/conversation_event_webchat_context.rb +237 -0
- data/lib/ultracart_api/models/conversation_webchat_context.rb +257 -0
- data/lib/ultracart_api/models/conversation_websocket_message.rb +12 -3
- data/lib/ultracart_api/models/hit_page_view.rb +311 -0
- data/lib/ultracart_api/models/hit_page_view_meta_data.rb +228 -0
- data/lib/ultracart_api/models/hit_session_start.rb +363 -0
- data/lib/ultracart_api/models/hit_session_utm.rb +345 -0
- data/lib/ultracart_api/models/order_property.rb +5 -5
- data/lib/ultracart_api/models/weight.rb +2 -2
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +6 -0
- metadata +14 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2616012b176378834c3507a43f196c35dcb6bbcd99c31645e4d5a26912bd908b
|
4
|
+
data.tar.gz: 708a2a56046daa1abc7883f683761dc6737f7a852d00b671f52919d13407e19f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: efb9efc5ad1a28fadbecbec39403dd2534b7843cf1e7311e05adb02d0a2f32bd5cd5356318b9d4ff4b2824fab69b5d732037ac848a6d33255ae8f936e4c8244d
|
7
|
+
data.tar.gz: fe65f23e2eb6278eeab172d55123441465f16e814156bd584672909bf512033980075ebcc69c31b111b577bdd4ce61252d7a7821343dadec2064c23828e62615
|
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.
|
10
|
+
- Package version: 4.0.86.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.
|
27
|
+
gem install ./ultracart_api-4.0.86.rc.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.86.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.
|
36
|
+
gem 'ultracart_api', '~> 4.0.86.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
|
@@ -594,6 +595,7 @@ Class | Method | HTTP request | Description
|
|
594
595
|
- [UltracartClient::ConversationEventRRWeb](docs/ConversationEventRRWeb.md)
|
595
596
|
- [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
|
596
597
|
- [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
|
598
|
+
- [UltracartClient::ConversationEventWebchatContext](docs/ConversationEventWebchatContext.md)
|
597
599
|
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
598
600
|
- [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
599
601
|
- [UltracartClient::ConversationMessagesResponse](docs/ConversationMessagesResponse.md)
|
@@ -605,6 +607,7 @@ Class | Method | HTTP request | Description
|
|
605
607
|
- [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
|
606
608
|
- [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
|
607
609
|
- [UltracartClient::ConversationTwilioAccount](docs/ConversationTwilioAccount.md)
|
610
|
+
- [UltracartClient::ConversationWebchatContext](docs/ConversationWebchatContext.md)
|
608
611
|
- [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
|
609
612
|
- [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
|
610
613
|
- [UltracartClient::ConversationWebchatQueueStatusQueueEntry](docs/ConversationWebchatQueueStatusQueueEntry.md)
|
@@ -857,6 +860,10 @@ Class | Method | HTTP request | Description
|
|
857
860
|
- [UltracartClient::GroupUserMembership](docs/GroupUserMembership.md)
|
858
861
|
- [UltracartClient::GroupsResponse](docs/GroupsResponse.md)
|
859
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)
|
860
867
|
- [UltracartClient::IntegrationLog](docs/IntegrationLog.md)
|
861
868
|
- [UltracartClient::IntegrationLogFile](docs/IntegrationLogFile.md)
|
862
869
|
- [UltracartClient::IntegrationLogLog](docs/IntegrationLogLog.md)
|
@@ -1226,6 +1233,8 @@ Not every change is committed to every SDK.
|
|
1226
1233
|
|
1227
1234
|
| Version | Date | Comments |
|
1228
1235
|
| --: | :-: | --- |
|
1236
|
+
| 4.0.86-RC | 11/21/2022 | conversation context method |
|
1237
|
+
| 4.0.85-RC | 11/21/2022 | adjusted conversation event model |
|
1229
1238
|
| 4.0.84-RC | 11/15/2022 | conversation methods bug fix |
|
1230
1239
|
| 4.0.83-RC | 11/15/2022 | conversations - enw events for add coupon and items |
|
1231
1240
|
| 4.0.82-RC | 11/15/2022 | order api new method is order refundable |
|
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)
|
@@ -4,6 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **agent_arn** | **String** | | [optional] |
|
8
|
+
| **agent_name** | **String** | | [optional] |
|
7
9
|
| **coupon_code** | **String** | | [optional] |
|
8
10
|
|
9
11
|
## Example
|
@@ -12,6 +14,8 @@
|
|
12
14
|
require 'ultracart_api'
|
13
15
|
|
14
16
|
instance = UltracartClient::ConversationEventAddCoupon.new(
|
17
|
+
agent_arn: null,
|
18
|
+
agent_name: null,
|
15
19
|
coupon_code: null
|
16
20
|
)
|
17
21
|
```
|
@@ -4,7 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
7
|
+
| **agent_arn** | **String** | | [optional] |
|
8
|
+
| **agent_name** | **String** | | [optional] |
|
9
|
+
| **items** | [**Array<CartItem>**](CartItem.md) | | [optional] |
|
8
10
|
|
9
11
|
## Example
|
10
12
|
|
@@ -12,7 +14,9 @@
|
|
12
14
|
require 'ultracart_api'
|
13
15
|
|
14
16
|
instance = UltracartClient::ConversationEventAddItem.new(
|
15
|
-
|
17
|
+
agent_arn: null,
|
18
|
+
agent_name: null,
|
19
|
+
items: null
|
16
20
|
)
|
17
21
|
```
|
18
22
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UltracartClient::ConversationEventWebchatContext
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **cart_id** | **String** | | [optional] |
|
8
|
+
| **ucacid** | **String** | | [optional] |
|
9
|
+
| **url** | **String** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ultracart_api'
|
15
|
+
|
16
|
+
instance = UltracartClient::ConversationEventWebchatContext.new(
|
17
|
+
cart_id: null,
|
18
|
+
ucacid: null,
|
19
|
+
url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -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<HitPageView>**](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
|
+
|
@@ -18,6 +18,7 @@
|
|
18
18
|
| **event_type** | **String** | Type of event | [optional] |
|
19
19
|
| **event_typing** | [**ConversationEventTyping**](ConversationEventTyping.md) | | [optional] |
|
20
20
|
| **event_updated_message** | [**ConversationMessage**](ConversationMessage.md) | | [optional] |
|
21
|
+
| **event_webchat_context** | [**ConversationEventWebchatContext**](ConversationEventWebchatContext.md) | | [optional] |
|
21
22
|
| **message** | [**ConversationMessage**](ConversationMessage.md) | | [optional] |
|
22
23
|
| **type** | **String** | Type of message | [optional] |
|
23
24
|
|
@@ -41,6 +42,7 @@ instance = UltracartClient::ConversationWebsocketMessage.new(
|
|
41
42
|
event_type: null,
|
42
43
|
event_typing: null,
|
43
44
|
event_updated_message: null,
|
45
|
+
event_webchat_context: null,
|
44
46
|
message: null,
|
45
47
|
type: null
|
46
48
|
)
|
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<HitPageViewMetaData>**](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
|
+
|
@@ -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
|
+
|
@@ -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
|
+
|
@@ -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
|
+
|
@@ -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]
|
@@ -15,11 +15,17 @@ require 'time'
|
|
15
15
|
|
16
16
|
module UltracartClient
|
17
17
|
class ConversationEventAddCoupon
|
18
|
+
attr_accessor :agent_arn
|
19
|
+
|
20
|
+
attr_accessor :agent_name
|
21
|
+
|
18
22
|
attr_accessor :coupon_code
|
19
23
|
|
20
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
21
25
|
def self.attribute_map
|
22
26
|
{
|
27
|
+
:'agent_arn' => :'agent_arn',
|
28
|
+
:'agent_name' => :'agent_name',
|
23
29
|
:'coupon_code' => :'coupon_code'
|
24
30
|
}
|
25
31
|
end
|
@@ -32,6 +38,8 @@ module UltracartClient
|
|
32
38
|
# Attribute type mapping.
|
33
39
|
def self.openapi_types
|
34
40
|
{
|
41
|
+
:'agent_arn' => :'String',
|
42
|
+
:'agent_name' => :'String',
|
35
43
|
:'coupon_code' => :'String'
|
36
44
|
}
|
37
45
|
end
|
@@ -57,6 +65,14 @@ module UltracartClient
|
|
57
65
|
h[k.to_sym] = v
|
58
66
|
}
|
59
67
|
|
68
|
+
if attributes.key?(:'agent_arn')
|
69
|
+
self.agent_arn = attributes[:'agent_arn']
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.key?(:'agent_name')
|
73
|
+
self.agent_name = attributes[:'agent_name']
|
74
|
+
end
|
75
|
+
|
60
76
|
if attributes.key?(:'coupon_code')
|
61
77
|
self.coupon_code = attributes[:'coupon_code']
|
62
78
|
end
|
@@ -80,6 +96,8 @@ module UltracartClient
|
|
80
96
|
def ==(o)
|
81
97
|
return true if self.equal?(o)
|
82
98
|
self.class == o.class &&
|
99
|
+
agent_arn == o.agent_arn &&
|
100
|
+
agent_name == o.agent_name &&
|
83
101
|
coupon_code == o.coupon_code
|
84
102
|
end
|
85
103
|
|
@@ -92,7 +110,7 @@ module UltracartClient
|
|
92
110
|
# Calculates hash code according to all attributes.
|
93
111
|
# @return [Integer] Hash code
|
94
112
|
def hash
|
95
|
-
[coupon_code].hash
|
113
|
+
[agent_arn, agent_name, coupon_code].hash
|
96
114
|
end
|
97
115
|
|
98
116
|
# Builds the object from hash
|
@@ -15,12 +15,18 @@ require 'time'
|
|
15
15
|
|
16
16
|
module UltracartClient
|
17
17
|
class ConversationEventAddItem
|
18
|
-
attr_accessor :
|
18
|
+
attr_accessor :agent_arn
|
19
|
+
|
20
|
+
attr_accessor :agent_name
|
21
|
+
|
22
|
+
attr_accessor :items
|
19
23
|
|
20
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
21
25
|
def self.attribute_map
|
22
26
|
{
|
23
|
-
:'
|
27
|
+
:'agent_arn' => :'agent_arn',
|
28
|
+
:'agent_name' => :'agent_name',
|
29
|
+
:'items' => :'items'
|
24
30
|
}
|
25
31
|
end
|
26
32
|
|
@@ -32,7 +38,9 @@ module UltracartClient
|
|
32
38
|
# Attribute type mapping.
|
33
39
|
def self.openapi_types
|
34
40
|
{
|
35
|
-
:'
|
41
|
+
:'agent_arn' => :'String',
|
42
|
+
:'agent_name' => :'String',
|
43
|
+
:'items' => :'Array<CartItem>'
|
36
44
|
}
|
37
45
|
end
|
38
46
|
|
@@ -57,8 +65,18 @@ module UltracartClient
|
|
57
65
|
h[k.to_sym] = v
|
58
66
|
}
|
59
67
|
|
60
|
-
if attributes.key?(:'
|
61
|
-
self.
|
68
|
+
if attributes.key?(:'agent_arn')
|
69
|
+
self.agent_arn = attributes[:'agent_arn']
|
70
|
+
end
|
71
|
+
|
72
|
+
if attributes.key?(:'agent_name')
|
73
|
+
self.agent_name = attributes[:'agent_name']
|
74
|
+
end
|
75
|
+
|
76
|
+
if attributes.key?(:'items')
|
77
|
+
if (value = attributes[:'items']).is_a?(Array)
|
78
|
+
self.items = value
|
79
|
+
end
|
62
80
|
end
|
63
81
|
end
|
64
82
|
|
@@ -80,7 +98,9 @@ module UltracartClient
|
|
80
98
|
def ==(o)
|
81
99
|
return true if self.equal?(o)
|
82
100
|
self.class == o.class &&
|
83
|
-
|
101
|
+
agent_arn == o.agent_arn &&
|
102
|
+
agent_name == o.agent_name &&
|
103
|
+
items == o.items
|
84
104
|
end
|
85
105
|
|
86
106
|
# @see the `==` method
|
@@ -92,7 +112,7 @@ module UltracartClient
|
|
92
112
|
# Calculates hash code according to all attributes.
|
93
113
|
# @return [Integer] Hash code
|
94
114
|
def hash
|
95
|
-
[
|
115
|
+
[agent_arn, agent_name, items].hash
|
96
116
|
end
|
97
117
|
|
98
118
|
# Builds the object from hash
|