ultracart_api 3.10.84 → 3.10.86
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 +150 -0
- data/docs/ConversationDepartment.md +0 -1
- data/docs/ConversationEngagement.md +1 -0
- data/docs/Coupon.md +4 -0
- data/docs/CouponMoreLoyaltyCashback.md +8 -0
- data/docs/CouponMoreLoyaltyPoints.md +8 -0
- data/docs/CouponPercentMoreLoyaltyCashback.md +8 -0
- data/docs/CouponPercentMoreLoyaltyPoints.md +8 -0
- data/lib/ultracart_api/api/conversation_api.rb +162 -0
- data/lib/ultracart_api/models/conversation_department.rb +1 -10
- data/lib/ultracart_api/models/conversation_engagement.rb +10 -1
- data/lib/ultracart_api/models/coupon.rb +37 -1
- data/lib/ultracart_api/models/coupon_more_loyalty_cashback.rb +185 -0
- data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +185 -0
- data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +185 -0
- data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +185 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 794a929648481e074401588dfb60b5339224224516952ee3bf33fa973be38c0b
|
4
|
+
data.tar.gz: 3a154eefa5642fd9ab279fec2dd2df5eeac795ec93ee330e5f390893ed810d7d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9761950a499f4c36eb76e16dbe3e2d788f6774836f538e181d9cae690aa242cdcda0e7f88b78a9f2896eeb827aadcf6fe4227f33bdc499967a1c0cbd5a27a1db
|
7
|
+
data.tar.gz: 88cece7949b1d3d266d21c845e8b5ee9221c729074113f0cf640b58ae681e36f56b3644c6c19632b80009e1d597c3b45437729db752afb2953b4d186e554c391
|
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.86
|
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.86.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.86.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.86'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -125,6 +125,9 @@ 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* | [**delete_conversation_canned_message**](docs/ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
129
|
+
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
130
|
+
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
128
131
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
129
132
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
130
133
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
@@ -679,8 +682,12 @@ Class | Method | HTTP request | Description
|
|
679
682
|
- [UltracartClient::CouponFreeShippingWithSubtotal](docs/CouponFreeShippingWithSubtotal.md)
|
680
683
|
- [UltracartClient::CouponItemSearchResult](docs/CouponItemSearchResult.md)
|
681
684
|
- [UltracartClient::CouponItemSearchResultsResponse](docs/CouponItemSearchResultsResponse.md)
|
685
|
+
- [UltracartClient::CouponMoreLoyaltyCashback](docs/CouponMoreLoyaltyCashback.md)
|
686
|
+
- [UltracartClient::CouponMoreLoyaltyPoints](docs/CouponMoreLoyaltyPoints.md)
|
682
687
|
- [UltracartClient::CouponMultipleAmountsOffItems](docs/CouponMultipleAmountsOffItems.md)
|
683
688
|
- [UltracartClient::CouponNoDiscount](docs/CouponNoDiscount.md)
|
689
|
+
- [UltracartClient::CouponPercentMoreLoyaltyCashback](docs/CouponPercentMoreLoyaltyCashback.md)
|
690
|
+
- [UltracartClient::CouponPercentMoreLoyaltyPoints](docs/CouponPercentMoreLoyaltyPoints.md)
|
684
691
|
- [UltracartClient::CouponPercentOffItemWithItemsQuantityPurchase](docs/CouponPercentOffItemWithItemsQuantityPurchase.md)
|
685
692
|
- [UltracartClient::CouponPercentOffItems](docs/CouponPercentOffItems.md)
|
686
693
|
- [UltracartClient::CouponPercentOffItemsAndFreeShipping](docs/CouponPercentOffItemsAndFreeShipping.md)
|
@@ -1260,6 +1267,8 @@ Not every change is committed to every SDK.
|
|
1260
1267
|
|
1261
1268
|
| Version | Date | Comments |
|
1262
1269
|
| --: | :-: | --- |
|
1270
|
+
| 3.10.86 | 12/27/2022 | additional loyalty related coupons |
|
1271
|
+
| 3.10.85 | 12/21/2022 | conversation development |
|
1263
1272
|
| 3.10.84 | 12/20/2022 | conversation engagement update |
|
1264
1273
|
| 3.10.83 | 12/20/2022 | conversation engagement update |
|
1265
1274
|
| 3.10.82 | 12/15/2022 | conversation search - added start date filtering |
|
data/docs/ConversationApi.md
CHANGED
@@ -4,6 +4,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
8
|
+
[**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
9
|
+
[**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
7
10
|
[**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
8
11
|
[**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
9
12
|
[**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
@@ -31,6 +34,153 @@ Method | HTTP request | Description
|
|
31
34
|
[**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
|
32
35
|
|
33
36
|
|
37
|
+
# **delete_conversation_canned_message**
|
38
|
+
> delete_conversation_canned_message(conversation_canned_message_oid)
|
39
|
+
|
40
|
+
Delete a conversation canned message
|
41
|
+
|
42
|
+
Delete a conversation canned message
|
43
|
+
|
44
|
+
### Example
|
45
|
+
```ruby
|
46
|
+
# load the gem
|
47
|
+
require 'ultracart_api'
|
48
|
+
|
49
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
50
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
51
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
52
|
+
|
53
|
+
|
54
|
+
conversation_canned_message_oid = 56 # Integer |
|
55
|
+
|
56
|
+
|
57
|
+
begin
|
58
|
+
#Delete a conversation canned message
|
59
|
+
api_instance.delete_conversation_canned_message(conversation_canned_message_oid)
|
60
|
+
rescue UltracartClient::ApiError => e
|
61
|
+
puts "Exception when calling ConversationApi->delete_conversation_canned_message: #{e}"
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
|
67
|
+
Name | Type | Description | Notes
|
68
|
+
------------- | ------------- | ------------- | -------------
|
69
|
+
**conversation_canned_message_oid** | **Integer**| |
|
70
|
+
|
71
|
+
### Return type
|
72
|
+
|
73
|
+
nil (empty response body)
|
74
|
+
|
75
|
+
### Authorization
|
76
|
+
|
77
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
78
|
+
|
79
|
+
### HTTP request headers
|
80
|
+
|
81
|
+
- **Content-Type**: application/json
|
82
|
+
- **Accept**: application/json
|
83
|
+
|
84
|
+
|
85
|
+
|
86
|
+
# **delete_department**
|
87
|
+
> delete_department(conversation_department_oid)
|
88
|
+
|
89
|
+
Delete a conversation department
|
90
|
+
|
91
|
+
Delete a conversation department
|
92
|
+
|
93
|
+
### Example
|
94
|
+
```ruby
|
95
|
+
# load the gem
|
96
|
+
require 'ultracart_api'
|
97
|
+
|
98
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
99
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
100
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
101
|
+
|
102
|
+
|
103
|
+
conversation_department_oid = 56 # Integer |
|
104
|
+
|
105
|
+
|
106
|
+
begin
|
107
|
+
#Delete a conversation department
|
108
|
+
api_instance.delete_department(conversation_department_oid)
|
109
|
+
rescue UltracartClient::ApiError => e
|
110
|
+
puts "Exception when calling ConversationApi->delete_department: #{e}"
|
111
|
+
end
|
112
|
+
```
|
113
|
+
|
114
|
+
### Parameters
|
115
|
+
|
116
|
+
Name | Type | Description | Notes
|
117
|
+
------------- | ------------- | ------------- | -------------
|
118
|
+
**conversation_department_oid** | **Integer**| |
|
119
|
+
|
120
|
+
### Return type
|
121
|
+
|
122
|
+
nil (empty response body)
|
123
|
+
|
124
|
+
### Authorization
|
125
|
+
|
126
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
127
|
+
|
128
|
+
### HTTP request headers
|
129
|
+
|
130
|
+
- **Content-Type**: application/json
|
131
|
+
- **Accept**: application/json
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
# **delete_engagement**
|
136
|
+
> delete_engagement(conversation_engagement_oid)
|
137
|
+
|
138
|
+
Delete a conversation engagement
|
139
|
+
|
140
|
+
Delete a conversation engagement
|
141
|
+
|
142
|
+
### Example
|
143
|
+
```ruby
|
144
|
+
# load the gem
|
145
|
+
require 'ultracart_api'
|
146
|
+
|
147
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
148
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
149
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
150
|
+
|
151
|
+
|
152
|
+
conversation_engagement_oid = 56 # Integer |
|
153
|
+
|
154
|
+
|
155
|
+
begin
|
156
|
+
#Delete a conversation engagement
|
157
|
+
api_instance.delete_engagement(conversation_engagement_oid)
|
158
|
+
rescue UltracartClient::ApiError => e
|
159
|
+
puts "Exception when calling ConversationApi->delete_engagement: #{e}"
|
160
|
+
end
|
161
|
+
```
|
162
|
+
|
163
|
+
### Parameters
|
164
|
+
|
165
|
+
Name | Type | Description | Notes
|
166
|
+
------------- | ------------- | ------------- | -------------
|
167
|
+
**conversation_engagement_oid** | **Integer**| |
|
168
|
+
|
169
|
+
### Return type
|
170
|
+
|
171
|
+
nil (empty response body)
|
172
|
+
|
173
|
+
### Authorization
|
174
|
+
|
175
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
176
|
+
|
177
|
+
### HTTP request headers
|
178
|
+
|
179
|
+
- **Content-Type**: application/json
|
180
|
+
- **Accept**: application/json
|
181
|
+
|
182
|
+
|
183
|
+
|
34
184
|
# **get_agent_keep_alive**
|
35
185
|
> get_agent_keep_alive
|
36
186
|
|
@@ -4,7 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**conversation_department_oid** | **Integer** | | [optional]
|
7
|
-
**delete_me** | **BOOLEAN** | | [optional]
|
8
7
|
**department_name** | **String** | | [optional]
|
9
8
|
**merchant_id** | **String** | | [optional]
|
10
9
|
**settings** | [**ConversationDepartmentSettings**](ConversationDepartmentSettings.md) | | [optional]
|
@@ -3,6 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**active** | **BOOLEAN** | | [optional]
|
6
7
|
**conversation_engagement_oid** | **Integer** | | [optional]
|
7
8
|
**customer_greeting** | **String** | | [optional]
|
8
9
|
**department_oids** | **Array<Integer>** | | [optional]
|
data/docs/Coupon.md
CHANGED
@@ -37,8 +37,12 @@ Name | Type | Description | Notes
|
|
37
37
|
**hide_from_customer** | **BOOLEAN** | Hide coupon from customer during checkout. Often used when coupons are automatic discounting mechanisms. | [optional]
|
38
38
|
**merchant_code** | **String** | Merchant code of coupon up to 20 characters. | [optional]
|
39
39
|
**merchant_notes** | **String** | Internal notes about this coupon. These are not visible to customer. | [optional]
|
40
|
+
**more_loyalty_cashback** | [**CouponMoreLoyaltyCashback**](CouponMoreLoyaltyCashback.md) | | [optional]
|
41
|
+
**more_loyalty_points** | [**CouponMoreLoyaltyPoints**](CouponMoreLoyaltyPoints.md) | | [optional]
|
40
42
|
**multiple_amounts_off_items** | [**CouponMultipleAmountsOffItems**](CouponMultipleAmountsOffItems.md) | | [optional]
|
41
43
|
**no_discount** | [**CouponNoDiscount**](CouponNoDiscount.md) | | [optional]
|
44
|
+
**percent_more_loyalty_cashback** | [**CouponPercentMoreLoyaltyCashback**](CouponPercentMoreLoyaltyCashback.md) | | [optional]
|
45
|
+
**percent_more_loyalty_points** | [**CouponPercentMoreLoyaltyPoints**](CouponPercentMoreLoyaltyPoints.md) | | [optional]
|
42
46
|
**percent_off_item_with_items_quantity_purchase** | [**CouponPercentOffItemWithItemsQuantityPurchase**](CouponPercentOffItemWithItemsQuantityPurchase.md) | | [optional]
|
43
47
|
**percent_off_items** | [**CouponPercentOffItems**](CouponPercentOffItems.md) | | [optional]
|
44
48
|
**percent_off_items_and_free_shipping** | [**CouponPercentOffItemsAndFreeShipping**](CouponPercentOffItemsAndFreeShipping.md) | | [optional]
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# UltracartClient::CouponPercentMoreLoyaltyCashback
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**percent_more_loyalty_cashback** | **Float** | The percentage of additional loyalty cashback | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# UltracartClient::CouponPercentMoreLoyaltyPoints
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**percent_more_loyalty_points** | **Float** | The percentage of additional loyalty points | [optional]
|
7
|
+
|
8
|
+
|
@@ -32,6 +32,168 @@ module UltracartClient
|
|
32
32
|
UltracartClient::ConversationApi.new(api_client)
|
33
33
|
end
|
34
34
|
|
35
|
+
# Delete a conversation canned message
|
36
|
+
# Delete a conversation canned message
|
37
|
+
# @param conversation_canned_message_oid
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [nil]
|
40
|
+
def delete_conversation_canned_message(conversation_canned_message_oid, opts = {})
|
41
|
+
delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts)
|
42
|
+
nil
|
43
|
+
end
|
44
|
+
|
45
|
+
# Delete a conversation canned message
|
46
|
+
# Delete a conversation canned message
|
47
|
+
# @param conversation_canned_message_oid
|
48
|
+
# @param [Hash] opts the optional parameters
|
49
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
50
|
+
def delete_conversation_canned_message_with_http_info(conversation_canned_message_oid, opts = {})
|
51
|
+
if @api_client.config.debugging
|
52
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_conversation_canned_message ...'
|
53
|
+
end
|
54
|
+
# verify the required parameter 'conversation_canned_message_oid' is set
|
55
|
+
if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
|
56
|
+
fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.delete_conversation_canned_message"
|
57
|
+
end
|
58
|
+
# resource path
|
59
|
+
local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_oid.to_s)
|
60
|
+
|
61
|
+
# query parameters
|
62
|
+
query_params = {}
|
63
|
+
|
64
|
+
# header parameters
|
65
|
+
header_params = {}
|
66
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
67
|
+
# HTTP header 'Accept' (if needed)
|
68
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
69
|
+
# HTTP header 'Content-Type'
|
70
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
71
|
+
|
72
|
+
# form parameters
|
73
|
+
form_params = {}
|
74
|
+
|
75
|
+
# http body (model)
|
76
|
+
post_body = nil
|
77
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
78
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
79
|
+
:header_params => header_params,
|
80
|
+
:query_params => query_params,
|
81
|
+
:form_params => form_params,
|
82
|
+
:body => post_body,
|
83
|
+
:auth_names => auth_names)
|
84
|
+
if @api_client.config.debugging
|
85
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
86
|
+
end
|
87
|
+
return data, status_code, headers
|
88
|
+
end
|
89
|
+
# Delete a conversation department
|
90
|
+
# Delete a conversation department
|
91
|
+
# @param conversation_department_oid
|
92
|
+
# @param [Hash] opts the optional parameters
|
93
|
+
# @return [nil]
|
94
|
+
def delete_department(conversation_department_oid, opts = {})
|
95
|
+
delete_department_with_http_info(conversation_department_oid, opts)
|
96
|
+
nil
|
97
|
+
end
|
98
|
+
|
99
|
+
# Delete a conversation department
|
100
|
+
# Delete a conversation department
|
101
|
+
# @param conversation_department_oid
|
102
|
+
# @param [Hash] opts the optional parameters
|
103
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
104
|
+
def delete_department_with_http_info(conversation_department_oid, opts = {})
|
105
|
+
if @api_client.config.debugging
|
106
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_department ...'
|
107
|
+
end
|
108
|
+
# verify the required parameter 'conversation_department_oid' is set
|
109
|
+
if @api_client.config.client_side_validation && conversation_department_oid.nil?
|
110
|
+
fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.delete_department"
|
111
|
+
end
|
112
|
+
# resource path
|
113
|
+
local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', conversation_department_oid.to_s)
|
114
|
+
|
115
|
+
# query parameters
|
116
|
+
query_params = {}
|
117
|
+
|
118
|
+
# header parameters
|
119
|
+
header_params = {}
|
120
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
121
|
+
# HTTP header 'Accept' (if needed)
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
123
|
+
# HTTP header 'Content-Type'
|
124
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
125
|
+
|
126
|
+
# form parameters
|
127
|
+
form_params = {}
|
128
|
+
|
129
|
+
# http body (model)
|
130
|
+
post_body = nil
|
131
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
132
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
133
|
+
:header_params => header_params,
|
134
|
+
:query_params => query_params,
|
135
|
+
:form_params => form_params,
|
136
|
+
:body => post_body,
|
137
|
+
:auth_names => auth_names)
|
138
|
+
if @api_client.config.debugging
|
139
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
140
|
+
end
|
141
|
+
return data, status_code, headers
|
142
|
+
end
|
143
|
+
# Delete a conversation engagement
|
144
|
+
# Delete a conversation engagement
|
145
|
+
# @param conversation_engagement_oid
|
146
|
+
# @param [Hash] opts the optional parameters
|
147
|
+
# @return [nil]
|
148
|
+
def delete_engagement(conversation_engagement_oid, opts = {})
|
149
|
+
delete_engagement_with_http_info(conversation_engagement_oid, opts)
|
150
|
+
nil
|
151
|
+
end
|
152
|
+
|
153
|
+
# Delete a conversation engagement
|
154
|
+
# Delete a conversation engagement
|
155
|
+
# @param conversation_engagement_oid
|
156
|
+
# @param [Hash] opts the optional parameters
|
157
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
158
|
+
def delete_engagement_with_http_info(conversation_engagement_oid, opts = {})
|
159
|
+
if @api_client.config.debugging
|
160
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_engagement ...'
|
161
|
+
end
|
162
|
+
# verify the required parameter 'conversation_engagement_oid' is set
|
163
|
+
if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
|
164
|
+
fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.delete_engagement"
|
165
|
+
end
|
166
|
+
# resource path
|
167
|
+
local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
|
168
|
+
|
169
|
+
# query parameters
|
170
|
+
query_params = {}
|
171
|
+
|
172
|
+
# header parameters
|
173
|
+
header_params = {}
|
174
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
175
|
+
# HTTP header 'Accept' (if needed)
|
176
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
177
|
+
# HTTP header 'Content-Type'
|
178
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
179
|
+
|
180
|
+
# form parameters
|
181
|
+
form_params = {}
|
182
|
+
|
183
|
+
# http body (model)
|
184
|
+
post_body = nil
|
185
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
186
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
187
|
+
:header_params => header_params,
|
188
|
+
:query_params => query_params,
|
189
|
+
:form_params => form_params,
|
190
|
+
:body => post_body,
|
191
|
+
:auth_names => auth_names)
|
192
|
+
if @api_client.config.debugging
|
193
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
194
|
+
end
|
195
|
+
return data, status_code, headers
|
196
|
+
end
|
35
197
|
# Agent keep alive
|
36
198
|
# Called periodically by the conversation API to keep the session alive.
|
37
199
|
# @param [Hash] opts the optional parameters
|
@@ -16,8 +16,6 @@ module UltracartClient
|
|
16
16
|
class ConversationDepartment
|
17
17
|
attr_accessor :conversation_department_oid
|
18
18
|
|
19
|
-
attr_accessor :delete_me
|
20
|
-
|
21
19
|
attr_accessor :department_name
|
22
20
|
|
23
21
|
attr_accessor :merchant_id
|
@@ -28,7 +26,6 @@ module UltracartClient
|
|
28
26
|
def self.attribute_map
|
29
27
|
{
|
30
28
|
:'conversation_department_oid' => :'conversation_department_oid',
|
31
|
-
:'delete_me' => :'delete_me',
|
32
29
|
:'department_name' => :'department_name',
|
33
30
|
:'merchant_id' => :'merchant_id',
|
34
31
|
:'settings' => :'settings'
|
@@ -39,7 +36,6 @@ module UltracartClient
|
|
39
36
|
def self.swagger_types
|
40
37
|
{
|
41
38
|
:'conversation_department_oid' => :'Integer',
|
42
|
-
:'delete_me' => :'BOOLEAN',
|
43
39
|
:'department_name' => :'String',
|
44
40
|
:'merchant_id' => :'String',
|
45
41
|
:'settings' => :'ConversationDepartmentSettings'
|
@@ -58,10 +54,6 @@ module UltracartClient
|
|
58
54
|
self.conversation_department_oid = attributes[:'conversation_department_oid']
|
59
55
|
end
|
60
56
|
|
61
|
-
if attributes.has_key?(:'delete_me')
|
62
|
-
self.delete_me = attributes[:'delete_me']
|
63
|
-
end
|
64
|
-
|
65
57
|
if attributes.has_key?(:'department_name')
|
66
58
|
self.department_name = attributes[:'department_name']
|
67
59
|
end
|
@@ -94,7 +86,6 @@ module UltracartClient
|
|
94
86
|
return true if self.equal?(o)
|
95
87
|
self.class == o.class &&
|
96
88
|
conversation_department_oid == o.conversation_department_oid &&
|
97
|
-
delete_me == o.delete_me &&
|
98
89
|
department_name == o.department_name &&
|
99
90
|
merchant_id == o.merchant_id &&
|
100
91
|
settings == o.settings
|
@@ -109,7 +100,7 @@ module UltracartClient
|
|
109
100
|
# Calculates hash code according to all attributes.
|
110
101
|
# @return [Fixnum] Hash code
|
111
102
|
def hash
|
112
|
-
[conversation_department_oid,
|
103
|
+
[conversation_department_oid, department_name, merchant_id, settings].hash
|
113
104
|
end
|
114
105
|
|
115
106
|
# Builds the object from hash
|
@@ -14,6 +14,8 @@ require 'date'
|
|
14
14
|
|
15
15
|
module UltracartClient
|
16
16
|
class ConversationEngagement
|
17
|
+
attr_accessor :active
|
18
|
+
|
17
19
|
attr_accessor :conversation_engagement_oid
|
18
20
|
|
19
21
|
attr_accessor :customer_greeting
|
@@ -54,6 +56,7 @@ module UltracartClient
|
|
54
56
|
# Attribute mapping from ruby-style variable name to JSON key.
|
55
57
|
def self.attribute_map
|
56
58
|
{
|
59
|
+
:'active' => :'active',
|
57
60
|
:'conversation_engagement_oid' => :'conversation_engagement_oid',
|
58
61
|
:'customer_greeting' => :'customer_greeting',
|
59
62
|
:'department_oids' => :'department_oids',
|
@@ -67,6 +70,7 @@ module UltracartClient
|
|
67
70
|
# Attribute type mapping.
|
68
71
|
def self.swagger_types
|
69
72
|
{
|
73
|
+
:'active' => :'BOOLEAN',
|
70
74
|
:'conversation_engagement_oid' => :'Integer',
|
71
75
|
:'customer_greeting' => :'String',
|
72
76
|
:'department_oids' => :'Array<Integer>',
|
@@ -85,6 +89,10 @@ module UltracartClient
|
|
85
89
|
# convert string to symbol for hash key
|
86
90
|
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
87
91
|
|
92
|
+
if attributes.has_key?(:'active')
|
93
|
+
self.active = attributes[:'active']
|
94
|
+
end
|
95
|
+
|
88
96
|
if attributes.has_key?(:'conversation_engagement_oid')
|
89
97
|
self.conversation_engagement_oid = attributes[:'conversation_engagement_oid']
|
90
98
|
end
|
@@ -146,6 +154,7 @@ module UltracartClient
|
|
146
154
|
def ==(o)
|
147
155
|
return true if self.equal?(o)
|
148
156
|
self.class == o.class &&
|
157
|
+
active == o.active &&
|
149
158
|
conversation_engagement_oid == o.conversation_engagement_oid &&
|
150
159
|
customer_greeting == o.customer_greeting &&
|
151
160
|
department_oids == o.department_oids &&
|
@@ -164,7 +173,7 @@ module UltracartClient
|
|
164
173
|
# Calculates hash code according to all attributes.
|
165
174
|
# @return [Fixnum] Hash code
|
166
175
|
def hash
|
167
|
-
[conversation_engagement_oid, customer_greeting, department_oids, engagement_name, equation, time_on_page, visitor_type].hash
|
176
|
+
[active, conversation_engagement_oid, customer_greeting, department_oids, engagement_name, equation, time_on_page, visitor_type].hash
|
168
177
|
end
|
169
178
|
|
170
179
|
# Builds the object from hash
|