ultracart_api 4.0.104.rc → 4.0.106.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.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6c7e1e8dc6f14cd6ea284ce13fb79a28c2bcdeae19f9f39faf937b3d9a722b6b
|
4
|
+
data.tar.gz: 6fa2ab4064947a210a24804b300153de8ef198abf3e25ce44bea2613aa5fcc91
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ecfea51c6e26ea7ee78506de223a3af0e94112af67a67141a902b6c74b17f7ca26572690d7ec9bb57d0cc4fa722bcbe656a0b036f468baaffe4bcb94aecf875f
|
7
|
+
data.tar.gz: df0ace2bc2e025453836a3afbe99ff62d573d1eda7890a55ce0f8c4551b2cc6b6cf39e20726accd3c44c75527902dd2f6dd08a95d42f5bb082dd92e0d459b5c2
|
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.106.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.106.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.106.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.106.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -1279,6 +1279,8 @@ Not every change is committed to every SDK.
|
|
1279
1279
|
|
1280
1280
|
| Version | Date | Comments |
|
1281
1281
|
| --: | :-: | --- |
|
1282
|
+
| 4.0.106-RC | 01/05/2023 | communications - added maximum_enrolled flag on flow object |
|
1283
|
+
| 4.0.105-RC | 01/03/2023 | conversation events for party leave and join |
|
1282
1284
|
| 4.0.104-RC | 01/03/2023 | order point of sale details |
|
1283
1285
|
| 4.0.103-RC | 12/27/2022 | additional loyalty related coupons |
|
1284
1286
|
| 4.0.102-RC | 12/21/2022 | conversation development |
|
@@ -10,6 +10,10 @@
|
|
10
10
|
| **event_conversation_closed** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
|
11
11
|
| **event_new_conversation** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
|
12
12
|
| **event_new_message** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
|
13
|
+
| **event_participant_join** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
|
14
|
+
| **event_participant_join_participant** | [**ConversationParticipant**](ConversationParticipant.md) | | [optional] |
|
15
|
+
| **event_participant_left** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
|
16
|
+
| **event_participant_left_participant** | [**ConversationParticipant**](ConversationParticipant.md) | | [optional] |
|
13
17
|
| **event_participant_update** | [**ConversationSummary**](ConversationSummary.md) | | [optional] |
|
14
18
|
| **event_queue_position** | [**ConversationEventQueuePosition**](ConversationEventQueuePosition.md) | | [optional] |
|
15
19
|
| **event_queue_status_update** | [**ConversationWebchatQueueStatus**](ConversationWebchatQueueStatus.md) | | [optional] |
|
@@ -34,6 +38,10 @@ instance = UltracartClient::ConversationWebsocketMessage.new(
|
|
34
38
|
event_conversation_closed: null,
|
35
39
|
event_new_conversation: null,
|
36
40
|
event_new_message: null,
|
41
|
+
event_participant_join: null,
|
42
|
+
event_participant_join_participant: null,
|
43
|
+
event_participant_left: null,
|
44
|
+
event_participant_left_participant: null,
|
37
45
|
event_participant_update: null,
|
38
46
|
event_queue_position: null,
|
39
47
|
event_queue_status_update: null,
|
data/docs/EmailFlow.md
CHANGED
@@ -20,6 +20,7 @@
|
|
20
20
|
| **esp_friendly_name** | **String** | Friendly name of the sending email | [optional] |
|
21
21
|
| **filter_profile_equation_json** | **String** | File profile equation json | [optional] |
|
22
22
|
| **library_item_oid** | **Integer** | If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated. | [optional] |
|
23
|
+
| **maximum_enrolled** | **Boolean** | The number of maximum customers for the plan are currently enrolled in this flow. | [optional] |
|
23
24
|
| **merchant_id** | **String** | Merchant ID | [optional] |
|
24
25
|
| **name** | **String** | Name of email flow | [optional] |
|
25
26
|
| **open_rate_formatted** | **String** | Open rate of emails, formatted | [optional] |
|
@@ -57,6 +58,7 @@ instance = UltracartClient::EmailFlow.new(
|
|
57
58
|
esp_friendly_name: null,
|
58
59
|
filter_profile_equation_json: null,
|
59
60
|
library_item_oid: null,
|
61
|
+
maximum_enrolled: null,
|
60
62
|
merchant_id: null,
|
61
63
|
name: null,
|
62
64
|
open_rate_formatted: null,
|
@@ -28,6 +28,14 @@ module UltracartClient
|
|
28
28
|
|
29
29
|
attr_accessor :event_new_message
|
30
30
|
|
31
|
+
attr_accessor :event_participant_join
|
32
|
+
|
33
|
+
attr_accessor :event_participant_join_participant
|
34
|
+
|
35
|
+
attr_accessor :event_participant_left
|
36
|
+
|
37
|
+
attr_accessor :event_participant_left_participant
|
38
|
+
|
31
39
|
attr_accessor :event_participant_update
|
32
40
|
|
33
41
|
attr_accessor :event_queue_position
|
@@ -83,6 +91,10 @@ module UltracartClient
|
|
83
91
|
:'event_conversation_closed' => :'event_conversation_closed',
|
84
92
|
:'event_new_conversation' => :'event_new_conversation',
|
85
93
|
:'event_new_message' => :'event_new_message',
|
94
|
+
:'event_participant_join' => :'event_participant_join',
|
95
|
+
:'event_participant_join_participant' => :'event_participant_join_participant',
|
96
|
+
:'event_participant_left' => :'event_participant_left',
|
97
|
+
:'event_participant_left_participant' => :'event_participant_left_participant',
|
86
98
|
:'event_participant_update' => :'event_participant_update',
|
87
99
|
:'event_queue_position' => :'event_queue_position',
|
88
100
|
:'event_queue_status_update' => :'event_queue_status_update',
|
@@ -111,6 +123,10 @@ module UltracartClient
|
|
111
123
|
:'event_conversation_closed' => :'ConversationSummary',
|
112
124
|
:'event_new_conversation' => :'ConversationSummary',
|
113
125
|
:'event_new_message' => :'ConversationSummary',
|
126
|
+
:'event_participant_join' => :'ConversationSummary',
|
127
|
+
:'event_participant_join_participant' => :'ConversationParticipant',
|
128
|
+
:'event_participant_left' => :'ConversationSummary',
|
129
|
+
:'event_participant_left_participant' => :'ConversationParticipant',
|
114
130
|
:'event_participant_update' => :'ConversationSummary',
|
115
131
|
:'event_queue_position' => :'ConversationEventQueuePosition',
|
116
132
|
:'event_queue_status_update' => :'ConversationWebchatQueueStatus',
|
@@ -170,6 +186,22 @@ module UltracartClient
|
|
170
186
|
self.event_new_message = attributes[:'event_new_message']
|
171
187
|
end
|
172
188
|
|
189
|
+
if attributes.key?(:'event_participant_join')
|
190
|
+
self.event_participant_join = attributes[:'event_participant_join']
|
191
|
+
end
|
192
|
+
|
193
|
+
if attributes.key?(:'event_participant_join_participant')
|
194
|
+
self.event_participant_join_participant = attributes[:'event_participant_join_participant']
|
195
|
+
end
|
196
|
+
|
197
|
+
if attributes.key?(:'event_participant_left')
|
198
|
+
self.event_participant_left = attributes[:'event_participant_left']
|
199
|
+
end
|
200
|
+
|
201
|
+
if attributes.key?(:'event_participant_left_participant')
|
202
|
+
self.event_participant_left_participant = attributes[:'event_participant_left_participant']
|
203
|
+
end
|
204
|
+
|
173
205
|
if attributes.key?(:'event_participant_update')
|
174
206
|
self.event_participant_update = attributes[:'event_participant_update']
|
175
207
|
end
|
@@ -225,7 +257,7 @@ module UltracartClient
|
|
225
257
|
# Check to see if the all the properties in the model are valid
|
226
258
|
# @return true if the model is valid
|
227
259
|
def valid?
|
228
|
-
event_type_validator = EnumAttributeValidator.new('String', ["queue position", "webchat start conversation", "conversation closed", "new conversation", "new message", "updated message", "queue status update", "rrweb", "participant update", "read message", "typing", "add coupon", "add item", "webchat context"])
|
260
|
+
event_type_validator = EnumAttributeValidator.new('String', ["queue position", "webchat start conversation", "conversation closed", "new conversation", "new message", "updated message", "queue status update", "rrweb", "participant update", "participant join", "participant leave", "read message", "typing", "add coupon", "add item", "webchat context"])
|
229
261
|
return false unless event_type_validator.valid?(@event_type)
|
230
262
|
type_validator = EnumAttributeValidator.new('String', ["message", "event", "ping", "check queue position"])
|
231
263
|
return false unless type_validator.valid?(@type)
|
@@ -235,7 +267,7 @@ module UltracartClient
|
|
235
267
|
# Custom attribute writer method checking allowed values (enum).
|
236
268
|
# @param [Object] event_type Object to be assigned
|
237
269
|
def event_type=(event_type)
|
238
|
-
validator = EnumAttributeValidator.new('String', ["queue position", "webchat start conversation", "conversation closed", "new conversation", "new message", "updated message", "queue status update", "rrweb", "participant update", "read message", "typing", "add coupon", "add item", "webchat context"])
|
270
|
+
validator = EnumAttributeValidator.new('String', ["queue position", "webchat start conversation", "conversation closed", "new conversation", "new message", "updated message", "queue status update", "rrweb", "participant update", "participant join", "participant leave", "read message", "typing", "add coupon", "add item", "webchat context"])
|
239
271
|
unless validator.valid?(event_type)
|
240
272
|
fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
|
241
273
|
end
|
@@ -263,6 +295,10 @@ module UltracartClient
|
|
263
295
|
event_conversation_closed == o.event_conversation_closed &&
|
264
296
|
event_new_conversation == o.event_new_conversation &&
|
265
297
|
event_new_message == o.event_new_message &&
|
298
|
+
event_participant_join == o.event_participant_join &&
|
299
|
+
event_participant_join_participant == o.event_participant_join_participant &&
|
300
|
+
event_participant_left == o.event_participant_left &&
|
301
|
+
event_participant_left_participant == o.event_participant_left_participant &&
|
266
302
|
event_participant_update == o.event_participant_update &&
|
267
303
|
event_queue_position == o.event_queue_position &&
|
268
304
|
event_queue_status_update == o.event_queue_status_update &&
|
@@ -285,7 +321,7 @@ module UltracartClient
|
|
285
321
|
# Calculates hash code according to all attributes.
|
286
322
|
# @return [Integer] Hash code
|
287
323
|
def hash
|
288
|
-
[conversation_uuid, event_add_coupon, event_add_item, event_conversation_closed, event_new_conversation, event_new_message, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, event_webchat_context, message, type].hash
|
324
|
+
[conversation_uuid, event_add_coupon, event_add_item, event_conversation_closed, event_new_conversation, event_new_message, event_participant_join, event_participant_join_participant, event_participant_left, event_participant_left_participant, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, event_webchat_context, message, type].hash
|
289
325
|
end
|
290
326
|
|
291
327
|
# Builds the object from hash
|
@@ -63,6 +63,9 @@ module UltracartClient
|
|
63
63
|
# If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.
|
64
64
|
attr_accessor :library_item_oid
|
65
65
|
|
66
|
+
# The number of maximum customers for the plan are currently enrolled in this flow.
|
67
|
+
attr_accessor :maximum_enrolled
|
68
|
+
|
66
69
|
# Merchant ID
|
67
70
|
attr_accessor :merchant_id
|
68
71
|
|
@@ -124,6 +127,7 @@ module UltracartClient
|
|
124
127
|
:'esp_friendly_name' => :'esp_friendly_name',
|
125
128
|
:'filter_profile_equation_json' => :'filter_profile_equation_json',
|
126
129
|
:'library_item_oid' => :'library_item_oid',
|
130
|
+
:'maximum_enrolled' => :'maximum_enrolled',
|
127
131
|
:'merchant_id' => :'merchant_id',
|
128
132
|
:'name' => :'name',
|
129
133
|
:'open_rate_formatted' => :'open_rate_formatted',
|
@@ -165,6 +169,7 @@ module UltracartClient
|
|
165
169
|
:'esp_friendly_name' => :'String',
|
166
170
|
:'filter_profile_equation_json' => :'String',
|
167
171
|
:'library_item_oid' => :'Integer',
|
172
|
+
:'maximum_enrolled' => :'Boolean',
|
168
173
|
:'merchant_id' => :'String',
|
169
174
|
:'name' => :'String',
|
170
175
|
:'open_rate_formatted' => :'String',
|
@@ -267,6 +272,10 @@ module UltracartClient
|
|
267
272
|
self.library_item_oid = attributes[:'library_item_oid']
|
268
273
|
end
|
269
274
|
|
275
|
+
if attributes.key?(:'maximum_enrolled')
|
276
|
+
self.maximum_enrolled = attributes[:'maximum_enrolled']
|
277
|
+
end
|
278
|
+
|
270
279
|
if attributes.key?(:'merchant_id')
|
271
280
|
self.merchant_id = attributes[:'merchant_id']
|
272
281
|
end
|
@@ -373,6 +382,7 @@ module UltracartClient
|
|
373
382
|
esp_friendly_name == o.esp_friendly_name &&
|
374
383
|
filter_profile_equation_json == o.filter_profile_equation_json &&
|
375
384
|
library_item_oid == o.library_item_oid &&
|
385
|
+
maximum_enrolled == o.maximum_enrolled &&
|
376
386
|
merchant_id == o.merchant_id &&
|
377
387
|
name == o.name &&
|
378
388
|
open_rate_formatted == o.open_rate_formatted &&
|
@@ -398,7 +408,7 @@ module UltracartClient
|
|
398
408
|
# Calculates hash code according to all attributes.
|
399
409
|
# @return [Integer] Hash code
|
400
410
|
def hash
|
401
|
-
[allow_multiple_concurrent_enrollments, back_populating, click_rate_formatted, created_dts, deleted, email_communication_sequence_uuid, email_flow_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, enrolled_customers, esp_domain_user, esp_domain_uuid, esp_flow_folder_uuid, esp_friendly_name, filter_profile_equation_json, library_item_oid, merchant_id, name, open_rate_formatted, revenue_formatted, revenue_per_customer_formatted, screenshot_large_full_url, sms_esp_twilio_uuid, sms_phone_number, status, status_dts, storefront_oid, trigger_parameter, trigger_parameter_name, trigger_type].hash
|
411
|
+
[allow_multiple_concurrent_enrollments, back_populating, click_rate_formatted, created_dts, deleted, email_communication_sequence_uuid, email_flow_uuid, end_once_customer_purchases, end_once_customer_purchases_anywhere, enrolled_customers, esp_domain_user, esp_domain_uuid, esp_flow_folder_uuid, esp_friendly_name, filter_profile_equation_json, library_item_oid, maximum_enrolled, merchant_id, name, open_rate_formatted, revenue_formatted, revenue_per_customer_formatted, screenshot_large_full_url, sms_esp_twilio_uuid, sms_phone_number, status, status_dts, storefront_oid, trigger_parameter, trigger_parameter_name, trigger_type].hash
|
402
412
|
end
|
403
413
|
|
404
414
|
# Builds the object from hash
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ultracart_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.0.
|
4
|
+
version: 4.0.106.rc
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-01-
|
11
|
+
date: 2023-01-05 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|