ultracart_api 4.0.101.rc → 4.0.103.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 +213 -0
- data/docs/ConversationDepartment.md +0 -2
- data/docs/ConversationEngagement.md +2 -0
- data/docs/Coupon.md +8 -0
- data/docs/CouponMoreLoyaltyCashback.md +18 -0
- data/docs/CouponMoreLoyaltyPoints.md +18 -0
- data/docs/CouponPercentMoreLoyaltyCashback.md +18 -0
- data/docs/CouponPercentMoreLoyaltyPoints.md +18 -0
- data/lib/ultracart_api/api/conversation_api.rb +192 -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 +220 -0
- data/lib/ultracart_api/models/coupon_more_loyalty_points.rb +220 -0
- data/lib/ultracart_api/models/coupon_percent_more_loyalty_cashback.rb +220 -0
- data/lib/ultracart_api/models/coupon_percent_more_loyalty_points.rb +220 -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: 863c755bc404ed1ae18d8c3c38b32160ae1f4dd4d15c23fbcdd726fc840a27a0
|
4
|
+
data.tar.gz: 50ed92c2b89e35fd855428b123aec0ac7985fee17f8997f71be58c9ce3ded267
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 910c7d48bb30def245e60aea214d2da7b696339bccf53b9392d1359b242d98efb7fd07ddb1f2748bcf532ff3759cbaf0f5ddd458ca3d57bd51cf8543570e86f0
|
7
|
+
data.tar.gz: 271d69adb4e1d7c2638a1984685b90b6779e8a63fc8962d6c054f67520e6a3d89735e2919140b5e8d2c4edffd13ae59f6ae920ba2b6cb39caa2b03f91358d917
|
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.103.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.103.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.103.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.103.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -131,6 +131,9 @@ 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* | [**delete_conversation_canned_message**](docs/ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
135
|
+
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
136
|
+
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
134
137
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
135
138
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
136
139
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
@@ -684,8 +687,12 @@ Class | Method | HTTP request | Description
|
|
684
687
|
- [UltracartClient::CouponFreeShippingWithSubtotal](docs/CouponFreeShippingWithSubtotal.md)
|
685
688
|
- [UltracartClient::CouponItemSearchResult](docs/CouponItemSearchResult.md)
|
686
689
|
- [UltracartClient::CouponItemSearchResultsResponse](docs/CouponItemSearchResultsResponse.md)
|
690
|
+
- [UltracartClient::CouponMoreLoyaltyCashback](docs/CouponMoreLoyaltyCashback.md)
|
691
|
+
- [UltracartClient::CouponMoreLoyaltyPoints](docs/CouponMoreLoyaltyPoints.md)
|
687
692
|
- [UltracartClient::CouponMultipleAmountsOffItems](docs/CouponMultipleAmountsOffItems.md)
|
688
693
|
- [UltracartClient::CouponNoDiscount](docs/CouponNoDiscount.md)
|
694
|
+
- [UltracartClient::CouponPercentMoreLoyaltyCashback](docs/CouponPercentMoreLoyaltyCashback.md)
|
695
|
+
- [UltracartClient::CouponPercentMoreLoyaltyPoints](docs/CouponPercentMoreLoyaltyPoints.md)
|
689
696
|
- [UltracartClient::CouponPercentOffItemWithItemsQuantityPurchase](docs/CouponPercentOffItemWithItemsQuantityPurchase.md)
|
690
697
|
- [UltracartClient::CouponPercentOffItems](docs/CouponPercentOffItems.md)
|
691
698
|
- [UltracartClient::CouponPercentOffItemsAndFreeShipping](docs/CouponPercentOffItemsAndFreeShipping.md)
|
@@ -1268,6 +1275,8 @@ Not every change is committed to every SDK.
|
|
1268
1275
|
|
1269
1276
|
| Version | Date | Comments |
|
1270
1277
|
| --: | :-: | --- |
|
1278
|
+
| 4.0.103-RC | 12/27/2022 | additional loyalty related coupons |
|
1279
|
+
| 4.0.102-RC | 12/21/2022 | conversation development |
|
1271
1280
|
| 4.0.101-RC | 12/20/2022 | conversation engagement update |
|
1272
1281
|
| 4.0.100-RC | 12/20/2022 | conversation engagement update |
|
1273
1282
|
| 4.0.99-RC | 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,216 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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
|
+
|
39
|
+
> delete_conversation_canned_message(conversation_canned_message_oid)
|
40
|
+
|
41
|
+
Delete a conversation canned message
|
42
|
+
|
43
|
+
Delete a conversation canned message
|
44
|
+
|
45
|
+
### Examples
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
require 'time'
|
49
|
+
require 'ultracart_api'
|
50
|
+
require 'json'
|
51
|
+
require 'yaml'
|
52
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
53
|
+
|
54
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
55
|
+
# As such, this might not be the best way to use this object.
|
56
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
57
|
+
|
58
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
59
|
+
conversation_canned_message_oid = 56 # Integer |
|
60
|
+
|
61
|
+
begin
|
62
|
+
# Delete a conversation canned message
|
63
|
+
api_instance.delete_conversation_canned_message(conversation_canned_message_oid)
|
64
|
+
rescue UltracartClient::ApiError => e
|
65
|
+
puts "Error when calling ConversationApi->delete_conversation_canned_message: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
#### Using the delete_conversation_canned_message_with_http_info variant
|
70
|
+
|
71
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
72
|
+
|
73
|
+
> <Array(nil, Integer, Hash)> delete_conversation_canned_message_with_http_info(conversation_canned_message_oid)
|
74
|
+
|
75
|
+
```ruby
|
76
|
+
begin
|
77
|
+
# Delete a conversation canned message
|
78
|
+
data, status_code, headers = api_instance.delete_conversation_canned_message_with_http_info(conversation_canned_message_oid)
|
79
|
+
p status_code # => 2xx
|
80
|
+
p headers # => { ... }
|
81
|
+
p data # => nil
|
82
|
+
rescue UltracartClient::ApiError => e
|
83
|
+
puts "Error when calling ConversationApi->delete_conversation_canned_message_with_http_info: #{e}"
|
84
|
+
end
|
85
|
+
```
|
86
|
+
|
87
|
+
### Parameters
|
88
|
+
|
89
|
+
| Name | Type | Description | Notes |
|
90
|
+
| ---- | ---- | ----------- | ----- |
|
91
|
+
| **conversation_canned_message_oid** | **Integer** | | |
|
92
|
+
|
93
|
+
### Return type
|
94
|
+
|
95
|
+
nil (empty response body)
|
96
|
+
|
97
|
+
### Authorization
|
98
|
+
|
99
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
100
|
+
|
101
|
+
### HTTP request headers
|
102
|
+
|
103
|
+
- **Content-Type**: Not defined
|
104
|
+
- **Accept**: application/json
|
105
|
+
|
106
|
+
|
107
|
+
## delete_department
|
108
|
+
|
109
|
+
> delete_department(conversation_department_oid)
|
110
|
+
|
111
|
+
Delete a conversation department
|
112
|
+
|
113
|
+
Delete a conversation department
|
114
|
+
|
115
|
+
### Examples
|
116
|
+
|
117
|
+
```ruby
|
118
|
+
require 'time'
|
119
|
+
require 'ultracart_api'
|
120
|
+
require 'json'
|
121
|
+
require 'yaml'
|
122
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
123
|
+
|
124
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
125
|
+
# As such, this might not be the best way to use this object.
|
126
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
127
|
+
|
128
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
129
|
+
conversation_department_oid = 56 # Integer |
|
130
|
+
|
131
|
+
begin
|
132
|
+
# Delete a conversation department
|
133
|
+
api_instance.delete_department(conversation_department_oid)
|
134
|
+
rescue UltracartClient::ApiError => e
|
135
|
+
puts "Error when calling ConversationApi->delete_department: #{e}"
|
136
|
+
end
|
137
|
+
```
|
138
|
+
|
139
|
+
#### Using the delete_department_with_http_info variant
|
140
|
+
|
141
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
142
|
+
|
143
|
+
> <Array(nil, Integer, Hash)> delete_department_with_http_info(conversation_department_oid)
|
144
|
+
|
145
|
+
```ruby
|
146
|
+
begin
|
147
|
+
# Delete a conversation department
|
148
|
+
data, status_code, headers = api_instance.delete_department_with_http_info(conversation_department_oid)
|
149
|
+
p status_code # => 2xx
|
150
|
+
p headers # => { ... }
|
151
|
+
p data # => nil
|
152
|
+
rescue UltracartClient::ApiError => e
|
153
|
+
puts "Error when calling ConversationApi->delete_department_with_http_info: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
|
159
|
+
| Name | Type | Description | Notes |
|
160
|
+
| ---- | ---- | ----------- | ----- |
|
161
|
+
| **conversation_department_oid** | **Integer** | | |
|
162
|
+
|
163
|
+
### Return type
|
164
|
+
|
165
|
+
nil (empty response body)
|
166
|
+
|
167
|
+
### Authorization
|
168
|
+
|
169
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
170
|
+
|
171
|
+
### HTTP request headers
|
172
|
+
|
173
|
+
- **Content-Type**: Not defined
|
174
|
+
- **Accept**: application/json
|
175
|
+
|
176
|
+
|
177
|
+
## delete_engagement
|
178
|
+
|
179
|
+
> delete_engagement(conversation_engagement_oid)
|
180
|
+
|
181
|
+
Delete a conversation engagement
|
182
|
+
|
183
|
+
Delete a conversation engagement
|
184
|
+
|
185
|
+
### Examples
|
186
|
+
|
187
|
+
```ruby
|
188
|
+
require 'time'
|
189
|
+
require 'ultracart_api'
|
190
|
+
require 'json'
|
191
|
+
require 'yaml'
|
192
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
193
|
+
|
194
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
195
|
+
# As such, this might not be the best way to use this object.
|
196
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
197
|
+
|
198
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
199
|
+
conversation_engagement_oid = 56 # Integer |
|
200
|
+
|
201
|
+
begin
|
202
|
+
# Delete a conversation engagement
|
203
|
+
api_instance.delete_engagement(conversation_engagement_oid)
|
204
|
+
rescue UltracartClient::ApiError => e
|
205
|
+
puts "Error when calling ConversationApi->delete_engagement: #{e}"
|
206
|
+
end
|
207
|
+
```
|
208
|
+
|
209
|
+
#### Using the delete_engagement_with_http_info variant
|
210
|
+
|
211
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
212
|
+
|
213
|
+
> <Array(nil, Integer, Hash)> delete_engagement_with_http_info(conversation_engagement_oid)
|
214
|
+
|
215
|
+
```ruby
|
216
|
+
begin
|
217
|
+
# Delete a conversation engagement
|
218
|
+
data, status_code, headers = api_instance.delete_engagement_with_http_info(conversation_engagement_oid)
|
219
|
+
p status_code # => 2xx
|
220
|
+
p headers # => { ... }
|
221
|
+
p data # => nil
|
222
|
+
rescue UltracartClient::ApiError => e
|
223
|
+
puts "Error when calling ConversationApi->delete_engagement_with_http_info: #{e}"
|
224
|
+
end
|
225
|
+
```
|
226
|
+
|
227
|
+
### Parameters
|
228
|
+
|
229
|
+
| Name | Type | Description | Notes |
|
230
|
+
| ---- | ---- | ----------- | ----- |
|
231
|
+
| **conversation_engagement_oid** | **Integer** | | |
|
232
|
+
|
233
|
+
### Return type
|
234
|
+
|
235
|
+
nil (empty response body)
|
236
|
+
|
237
|
+
### Authorization
|
238
|
+
|
239
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
240
|
+
|
241
|
+
### HTTP request headers
|
242
|
+
|
243
|
+
- **Content-Type**: Not defined
|
244
|
+
- **Accept**: application/json
|
245
|
+
|
246
|
+
|
34
247
|
## get_agent_keep_alive
|
35
248
|
|
36
249
|
> get_agent_keep_alive
|
@@ -5,7 +5,6 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **conversation_department_oid** | **Integer** | | [optional] |
|
8
|
-
| **delete_me** | **Boolean** | | [optional] |
|
9
8
|
| **department_name** | **String** | | [optional] |
|
10
9
|
| **merchant_id** | **String** | | [optional] |
|
11
10
|
| **settings** | **Object** | | [optional] |
|
@@ -17,7 +16,6 @@ require 'ultracart_api'
|
|
17
16
|
|
18
17
|
instance = UltracartClient::ConversationDepartment.new(
|
19
18
|
conversation_department_oid: null,
|
20
|
-
delete_me: null,
|
21
19
|
department_name: null,
|
22
20
|
merchant_id: null,
|
23
21
|
settings: null
|
@@ -4,6 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **active** | **Boolean** | | [optional] |
|
7
8
|
| **conversation_engagement_oid** | **Integer** | | [optional] |
|
8
9
|
| **customer_greeting** | **String** | | [optional] |
|
9
10
|
| **department_oids** | **Array<Integer>** | | [optional] |
|
@@ -18,6 +19,7 @@
|
|
18
19
|
require 'ultracart_api'
|
19
20
|
|
20
21
|
instance = UltracartClient::ConversationEngagement.new(
|
22
|
+
active: null,
|
21
23
|
conversation_engagement_oid: null,
|
22
24
|
customer_greeting: null,
|
23
25
|
department_oids: null,
|
data/docs/Coupon.md
CHANGED
@@ -38,8 +38,12 @@
|
|
38
38
|
| **hide_from_customer** | **Boolean** | Hide coupon from customer during checkout. Often used when coupons are automatic discounting mechanisms. | [optional] |
|
39
39
|
| **merchant_code** | **String** | Merchant code of coupon up to 20 characters. | [optional] |
|
40
40
|
| **merchant_notes** | **String** | Internal notes about this coupon. These are not visible to customer. | [optional] |
|
41
|
+
| **more_loyalty_cashback** | [**CouponMoreLoyaltyCashback**](CouponMoreLoyaltyCashback.md) | | [optional] |
|
42
|
+
| **more_loyalty_points** | [**CouponMoreLoyaltyPoints**](CouponMoreLoyaltyPoints.md) | | [optional] |
|
41
43
|
| **multiple_amounts_off_items** | [**CouponMultipleAmountsOffItems**](CouponMultipleAmountsOffItems.md) | | [optional] |
|
42
44
|
| **no_discount** | [**CouponNoDiscount**](CouponNoDiscount.md) | | [optional] |
|
45
|
+
| **percent_more_loyalty_cashback** | [**CouponPercentMoreLoyaltyCashback**](CouponPercentMoreLoyaltyCashback.md) | | [optional] |
|
46
|
+
| **percent_more_loyalty_points** | [**CouponPercentMoreLoyaltyPoints**](CouponPercentMoreLoyaltyPoints.md) | | [optional] |
|
43
47
|
| **percent_off_item_with_items_quantity_purchase** | [**CouponPercentOffItemWithItemsQuantityPurchase**](CouponPercentOffItemWithItemsQuantityPurchase.md) | | [optional] |
|
44
48
|
| **percent_off_items** | [**CouponPercentOffItems**](CouponPercentOffItems.md) | | [optional] |
|
45
49
|
| **percent_off_items_and_free_shipping** | [**CouponPercentOffItemsAndFreeShipping**](CouponPercentOffItemsAndFreeShipping.md) | | [optional] |
|
@@ -106,8 +110,12 @@ instance = UltracartClient::Coupon.new(
|
|
106
110
|
hide_from_customer: null,
|
107
111
|
merchant_code: null,
|
108
112
|
merchant_notes: null,
|
113
|
+
more_loyalty_cashback: null,
|
114
|
+
more_loyalty_points: null,
|
109
115
|
multiple_amounts_off_items: null,
|
110
116
|
no_discount: null,
|
117
|
+
percent_more_loyalty_cashback: null,
|
118
|
+
percent_more_loyalty_points: null,
|
111
119
|
percent_off_item_with_items_quantity_purchase: null,
|
112
120
|
percent_off_items: null,
|
113
121
|
percent_off_items_and_free_shipping: null,
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UltracartClient::CouponMoreLoyaltyCashback
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **loyalty_cashback** | **Float** | The additional loyalty cashback | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ultracart_api'
|
13
|
+
|
14
|
+
instance = UltracartClient::CouponMoreLoyaltyCashback.new(
|
15
|
+
loyalty_cashback: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UltracartClient::CouponMoreLoyaltyPoints
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **loyalty_points** | **Float** | The additional loyalty points | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ultracart_api'
|
13
|
+
|
14
|
+
instance = UltracartClient::CouponMoreLoyaltyPoints.new(
|
15
|
+
loyalty_points: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UltracartClient::CouponPercentMoreLoyaltyCashback
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **percent_more_loyalty_cashback** | **Float** | The percentage of additional loyalty cashback | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ultracart_api'
|
13
|
+
|
14
|
+
instance = UltracartClient::CouponPercentMoreLoyaltyCashback.new(
|
15
|
+
percent_more_loyalty_cashback: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UltracartClient::CouponPercentMoreLoyaltyPoints
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **percent_more_loyalty_points** | **Float** | The percentage of additional loyalty points | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ultracart_api'
|
13
|
+
|
14
|
+
instance = UltracartClient::CouponPercentMoreLoyaltyPoints.new(
|
15
|
+
percent_more_loyalty_points: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -32,6 +32,198 @@ 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 [Integer]
|
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 [Integer]
|
48
|
+
# @param [Hash] opts the optional parameters
|
49
|
+
# @return [Array<(nil, Integer, 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' + '}', CGI.escape(conversation_canned_message_oid.to_s))
|
60
|
+
|
61
|
+
# query parameters
|
62
|
+
query_params = opts[:query_params] || {}
|
63
|
+
|
64
|
+
# header parameters
|
65
|
+
header_params = opts[: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
|
+
|
70
|
+
# form parameters
|
71
|
+
form_params = opts[:form_params] || {}
|
72
|
+
|
73
|
+
# http body (model)
|
74
|
+
post_body = opts[:debug_body]
|
75
|
+
|
76
|
+
# return_type
|
77
|
+
return_type = opts[:debug_return_type]
|
78
|
+
|
79
|
+
# auth_names
|
80
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
81
|
+
|
82
|
+
new_options = opts.merge(
|
83
|
+
:operation => :"ConversationApi.delete_conversation_canned_message",
|
84
|
+
:header_params => header_params,
|
85
|
+
:query_params => query_params,
|
86
|
+
:form_params => form_params,
|
87
|
+
:body => post_body,
|
88
|
+
:auth_names => auth_names,
|
89
|
+
:return_type => return_type
|
90
|
+
)
|
91
|
+
|
92
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
95
|
+
end
|
96
|
+
return data, status_code, headers
|
97
|
+
end
|
98
|
+
|
99
|
+
# Delete a conversation department
|
100
|
+
# Delete a conversation department
|
101
|
+
# @param conversation_department_oid [Integer]
|
102
|
+
# @param [Hash] opts the optional parameters
|
103
|
+
# @return [nil]
|
104
|
+
def delete_department(conversation_department_oid, opts = {})
|
105
|
+
delete_department_with_http_info(conversation_department_oid, opts)
|
106
|
+
nil
|
107
|
+
end
|
108
|
+
|
109
|
+
# Delete a conversation department
|
110
|
+
# Delete a conversation department
|
111
|
+
# @param conversation_department_oid [Integer]
|
112
|
+
# @param [Hash] opts the optional parameters
|
113
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
114
|
+
def delete_department_with_http_info(conversation_department_oid, opts = {})
|
115
|
+
if @api_client.config.debugging
|
116
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_department ...'
|
117
|
+
end
|
118
|
+
# verify the required parameter 'conversation_department_oid' is set
|
119
|
+
if @api_client.config.client_side_validation && conversation_department_oid.nil?
|
120
|
+
fail ArgumentError, "Missing the required parameter 'conversation_department_oid' when calling ConversationApi.delete_department"
|
121
|
+
end
|
122
|
+
# resource path
|
123
|
+
local_var_path = '/conversation/departments/{conversation_department_oid}'.sub('{' + 'conversation_department_oid' + '}', CGI.escape(conversation_department_oid.to_s))
|
124
|
+
|
125
|
+
# query parameters
|
126
|
+
query_params = opts[:query_params] || {}
|
127
|
+
|
128
|
+
# header parameters
|
129
|
+
header_params = opts[:header_params] || {}
|
130
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
131
|
+
# HTTP header 'Accept' (if needed)
|
132
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
133
|
+
|
134
|
+
# form parameters
|
135
|
+
form_params = opts[:form_params] || {}
|
136
|
+
|
137
|
+
# http body (model)
|
138
|
+
post_body = opts[:debug_body]
|
139
|
+
|
140
|
+
# return_type
|
141
|
+
return_type = opts[:debug_return_type]
|
142
|
+
|
143
|
+
# auth_names
|
144
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
145
|
+
|
146
|
+
new_options = opts.merge(
|
147
|
+
:operation => :"ConversationApi.delete_department",
|
148
|
+
:header_params => header_params,
|
149
|
+
:query_params => query_params,
|
150
|
+
:form_params => form_params,
|
151
|
+
:body => post_body,
|
152
|
+
:auth_names => auth_names,
|
153
|
+
:return_type => return_type
|
154
|
+
)
|
155
|
+
|
156
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
157
|
+
if @api_client.config.debugging
|
158
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_department\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
159
|
+
end
|
160
|
+
return data, status_code, headers
|
161
|
+
end
|
162
|
+
|
163
|
+
# Delete a conversation engagement
|
164
|
+
# Delete a conversation engagement
|
165
|
+
# @param conversation_engagement_oid [Integer]
|
166
|
+
# @param [Hash] opts the optional parameters
|
167
|
+
# @return [nil]
|
168
|
+
def delete_engagement(conversation_engagement_oid, opts = {})
|
169
|
+
delete_engagement_with_http_info(conversation_engagement_oid, opts)
|
170
|
+
nil
|
171
|
+
end
|
172
|
+
|
173
|
+
# Delete a conversation engagement
|
174
|
+
# Delete a conversation engagement
|
175
|
+
# @param conversation_engagement_oid [Integer]
|
176
|
+
# @param [Hash] opts the optional parameters
|
177
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
178
|
+
def delete_engagement_with_http_info(conversation_engagement_oid, opts = {})
|
179
|
+
if @api_client.config.debugging
|
180
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.delete_engagement ...'
|
181
|
+
end
|
182
|
+
# verify the required parameter 'conversation_engagement_oid' is set
|
183
|
+
if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
|
184
|
+
fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.delete_engagement"
|
185
|
+
end
|
186
|
+
# resource path
|
187
|
+
local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', CGI.escape(conversation_engagement_oid.to_s))
|
188
|
+
|
189
|
+
# query parameters
|
190
|
+
query_params = opts[:query_params] || {}
|
191
|
+
|
192
|
+
# header parameters
|
193
|
+
header_params = opts[:header_params] || {}
|
194
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
195
|
+
# HTTP header 'Accept' (if needed)
|
196
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
197
|
+
|
198
|
+
# form parameters
|
199
|
+
form_params = opts[:form_params] || {}
|
200
|
+
|
201
|
+
# http body (model)
|
202
|
+
post_body = opts[:debug_body]
|
203
|
+
|
204
|
+
# return_type
|
205
|
+
return_type = opts[:debug_return_type]
|
206
|
+
|
207
|
+
# auth_names
|
208
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
209
|
+
|
210
|
+
new_options = opts.merge(
|
211
|
+
:operation => :"ConversationApi.delete_engagement",
|
212
|
+
:header_params => header_params,
|
213
|
+
:query_params => query_params,
|
214
|
+
:form_params => form_params,
|
215
|
+
:body => post_body,
|
216
|
+
:auth_names => auth_names,
|
217
|
+
:return_type => return_type
|
218
|
+
)
|
219
|
+
|
220
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
221
|
+
if @api_client.config.debugging
|
222
|
+
@api_client.config.logger.debug "API called: ConversationApi#delete_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
223
|
+
end
|
224
|
+
return data, status_code, headers
|
225
|
+
end
|
226
|
+
|
35
227
|
# Agent keep alive
|
36
228
|
# Called periodically by the conversation API to keep the session alive.
|
37
229
|
# @param [Hash] opts the optional parameters
|