ultracart_api 4.1.171 → 4.1.173
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 +4 -4
- data/README.md +4 -2
- data/docs/EmailFlow.md +4 -0
- data/lib/ultracart_api/models/email_flow.rb +55 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2aeb2e89d1ebf3b88d3293482b05284291353d9988ab78ff85b323fd3c6923e0
|
|
4
|
+
data.tar.gz: 0ce36918495fa1a848eaf7f594411238573880e1dc0f2c9e27d22b25a8a7deaa
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d58cc42de7a0da2675e6fe074593dab26574413805a88cfd9a17d5a34c9e149e2d45e14eb1f28afb900728a22066fcf8c40e19bcf5b2a87a02040c5fee3e0d20
|
|
7
|
+
data.tar.gz: 21642e086dd128d0567ae2440c8017892acb109f0a7e4305b422b8b97526c6290901f81e53903851778dcfba5363a053a59063694fd9d59edb72fffe34b15499
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
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.1.
|
|
10
|
+
- Package version: 4.1.173
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.173'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -2066,6 +2066,8 @@ Not every change is committed to every SDK.
|
|
|
2066
2066
|
|
|
2067
2067
|
| Version | Date | Comments |
|
|
2068
2068
|
| --: | :-: | --- |
|
|
2069
|
+
| 4.1.173 | 09/24/2026 | storefront communications flow re-entry setting |
|
|
2070
|
+
| 4.1.172 | 09/24/2026 | storefront communications flow re-entry setting |
|
|
2069
2071
|
| 4.1.171 | 09/23/2026 | sfvb internal testing |
|
|
2070
2072
|
| 4.1.170 | 09/22/2026 | sfvb internal testing |
|
|
2071
2073
|
| 4.1.169 | 09/22/2026 | sfvb builder |
|
data/docs/EmailFlow.md
CHANGED
|
@@ -24,6 +24,8 @@
|
|
|
24
24
|
| **merchant_id** | **String** | Merchant ID | [optional] |
|
|
25
25
|
| **name** | **String** | Name of email flow | [optional] |
|
|
26
26
|
| **open_rate_formatted** | **String** | Open rate of emails, formatted | [optional] |
|
|
27
|
+
| **reentry_delay_days** | **Integer** | Number of days after the last enrollment before a customer may enter this flow again. Only used when reentry_policy is after_days. Maximum 1095. | [optional] |
|
|
28
|
+
| **reentry_policy** | **String** | Whether a customer may enter this flow again after a previous enrollment. anytime (default), after_days (see reentry_delay_days), or never. Enrollment history is kept for 3 years, so never means not within 3 years of the last enrollment. | [optional] |
|
|
27
29
|
| **revenue_formatted** | **String** | Revenue, formatted | [optional] |
|
|
28
30
|
| **revenue_per_customer_formatted** | **String** | Revenue per customer, formatted | [optional] |
|
|
29
31
|
| **screenshot_large_full_url** | **String** | URL to a large full length screenshot | [optional] |
|
|
@@ -62,6 +64,8 @@ instance = UltracartClient::EmailFlow.new(
|
|
|
62
64
|
merchant_id: null,
|
|
63
65
|
name: null,
|
|
64
66
|
open_rate_formatted: null,
|
|
67
|
+
reentry_delay_days: null,
|
|
68
|
+
reentry_policy: null,
|
|
65
69
|
revenue_formatted: null,
|
|
66
70
|
revenue_per_customer_formatted: null,
|
|
67
71
|
screenshot_large_full_url: null,
|
|
@@ -75,6 +75,12 @@ module UltracartClient
|
|
|
75
75
|
# Open rate of emails, formatted
|
|
76
76
|
attr_accessor :open_rate_formatted
|
|
77
77
|
|
|
78
|
+
# Number of days after the last enrollment before a customer may enter this flow again. Only used when reentry_policy is after_days. Maximum 1095.
|
|
79
|
+
attr_accessor :reentry_delay_days
|
|
80
|
+
|
|
81
|
+
# Whether a customer may enter this flow again after a previous enrollment. anytime (default), after_days (see reentry_delay_days), or never. Enrollment history is kept for 3 years, so never means not within 3 years of the last enrollment.
|
|
82
|
+
attr_accessor :reentry_policy
|
|
83
|
+
|
|
78
84
|
# Revenue, formatted
|
|
79
85
|
attr_accessor :revenue_formatted
|
|
80
86
|
|
|
@@ -108,6 +114,28 @@ module UltracartClient
|
|
|
108
114
|
# Trigger type
|
|
109
115
|
attr_accessor :trigger_type
|
|
110
116
|
|
|
117
|
+
class EnumAttributeValidator
|
|
118
|
+
attr_reader :datatype
|
|
119
|
+
attr_reader :allowable_values
|
|
120
|
+
|
|
121
|
+
def initialize(datatype, allowable_values)
|
|
122
|
+
@allowable_values = allowable_values.map do |value|
|
|
123
|
+
case datatype.to_s
|
|
124
|
+
when /Integer/i
|
|
125
|
+
value.to_i
|
|
126
|
+
when /Float/i
|
|
127
|
+
value.to_f
|
|
128
|
+
else
|
|
129
|
+
value
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
def valid?(value)
|
|
135
|
+
!value || allowable_values.include?(value)
|
|
136
|
+
end
|
|
137
|
+
end
|
|
138
|
+
|
|
111
139
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
112
140
|
def self.attribute_map
|
|
113
141
|
{
|
|
@@ -131,6 +159,8 @@ module UltracartClient
|
|
|
131
159
|
:'merchant_id' => :'merchant_id',
|
|
132
160
|
:'name' => :'name',
|
|
133
161
|
:'open_rate_formatted' => :'open_rate_formatted',
|
|
162
|
+
:'reentry_delay_days' => :'reentry_delay_days',
|
|
163
|
+
:'reentry_policy' => :'reentry_policy',
|
|
134
164
|
:'revenue_formatted' => :'revenue_formatted',
|
|
135
165
|
:'revenue_per_customer_formatted' => :'revenue_per_customer_formatted',
|
|
136
166
|
:'screenshot_large_full_url' => :'screenshot_large_full_url',
|
|
@@ -173,6 +203,8 @@ module UltracartClient
|
|
|
173
203
|
:'merchant_id' => :'String',
|
|
174
204
|
:'name' => :'String',
|
|
175
205
|
:'open_rate_formatted' => :'String',
|
|
206
|
+
:'reentry_delay_days' => :'Integer',
|
|
207
|
+
:'reentry_policy' => :'String',
|
|
176
208
|
:'revenue_formatted' => :'String',
|
|
177
209
|
:'revenue_per_customer_formatted' => :'String',
|
|
178
210
|
:'screenshot_large_full_url' => :'String',
|
|
@@ -288,6 +320,14 @@ module UltracartClient
|
|
|
288
320
|
self.open_rate_formatted = attributes[:'open_rate_formatted']
|
|
289
321
|
end
|
|
290
322
|
|
|
323
|
+
if attributes.key?(:'reentry_delay_days')
|
|
324
|
+
self.reentry_delay_days = attributes[:'reentry_delay_days']
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
if attributes.key?(:'reentry_policy')
|
|
328
|
+
self.reentry_policy = attributes[:'reentry_policy']
|
|
329
|
+
end
|
|
330
|
+
|
|
291
331
|
if attributes.key?(:'revenue_formatted')
|
|
292
332
|
self.revenue_formatted = attributes[:'revenue_formatted']
|
|
293
333
|
end
|
|
@@ -348,6 +388,8 @@ module UltracartClient
|
|
|
348
388
|
# @return true if the model is valid
|
|
349
389
|
def valid?
|
|
350
390
|
return false if !@name.nil? && @name.to_s.length > 250
|
|
391
|
+
reentry_policy_validator = EnumAttributeValidator.new('String', ["anytime", "after_days", "never"])
|
|
392
|
+
return false unless reentry_policy_validator.valid?(@reentry_policy)
|
|
351
393
|
true
|
|
352
394
|
end
|
|
353
395
|
|
|
@@ -361,6 +403,16 @@ module UltracartClient
|
|
|
361
403
|
@name = name
|
|
362
404
|
end
|
|
363
405
|
|
|
406
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
407
|
+
# @param [Object] reentry_policy Object to be assigned
|
|
408
|
+
def reentry_policy=(reentry_policy)
|
|
409
|
+
validator = EnumAttributeValidator.new('String', ["anytime", "after_days", "never"])
|
|
410
|
+
unless validator.valid?(reentry_policy)
|
|
411
|
+
fail ArgumentError, "invalid value for \"reentry_policy\", must be one of #{validator.allowable_values}."
|
|
412
|
+
end
|
|
413
|
+
@reentry_policy = reentry_policy
|
|
414
|
+
end
|
|
415
|
+
|
|
364
416
|
# Checks equality by comparing each attribute.
|
|
365
417
|
# @param [Object] Object to be compared
|
|
366
418
|
def ==(o)
|
|
@@ -386,6 +438,8 @@ module UltracartClient
|
|
|
386
438
|
merchant_id == o.merchant_id &&
|
|
387
439
|
name == o.name &&
|
|
388
440
|
open_rate_formatted == o.open_rate_formatted &&
|
|
441
|
+
reentry_delay_days == o.reentry_delay_days &&
|
|
442
|
+
reentry_policy == o.reentry_policy &&
|
|
389
443
|
revenue_formatted == o.revenue_formatted &&
|
|
390
444
|
revenue_per_customer_formatted == o.revenue_per_customer_formatted &&
|
|
391
445
|
screenshot_large_full_url == o.screenshot_large_full_url &&
|
|
@@ -408,7 +462,7 @@ module UltracartClient
|
|
|
408
462
|
# Calculates hash code according to all attributes.
|
|
409
463
|
# @return [Integer] Hash code
|
|
410
464
|
def 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
|
|
465
|
+
[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, reentry_delay_days, reentry_policy, 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
|
|
412
466
|
end
|
|
413
467
|
|
|
414
468
|
# 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.1.
|
|
4
|
+
version: 4.1.173
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-09-
|
|
11
|
+
date: 2026-09-24 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|