ultracart_api 4.1.124 → 4.1.125
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: a71acd908c524b94f7e117ea4cec002493901b2171f8292407d536f20f6edd53
|
|
4
|
+
data.tar.gz: 0c466b1d4a0e3595efe0182e6fdc1e620eb370912827a8cded022bbbee3b360c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4743f2e25a72ba9aed40fd369c1c5af781105d792c3ad045495ef802c8d6c505d434bf9aa216e213d104dca464b18681a94b387450e852ee23108e4724ff18c9
|
|
7
|
+
data.tar.gz: a74c0b65fb892c24923dd7301438421198870eebe0ca09924a3055ce98109a183e8077115177821644f2d31817cf45028cb84c763ff7b12878559a2afacc2213
|
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.125
|
|
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.125'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -1834,6 +1834,7 @@ Not every change is committed to every SDK.
|
|
|
1834
1834
|
|
|
1835
1835
|
| Version | Date | Comments |
|
|
1836
1836
|
| --: | :-: | --- |
|
|
1837
|
+
| 4.1.125 | 08/06/2026 | order api - ability to query by bin and last 4 in unlimited scenarios for chargeback order association |
|
|
1837
1838
|
| 4.1.124 | 08/04/2026 | customer - method to remove customer profile from email suppression |
|
|
1838
1839
|
| 4.1.123 | 08/04/2026 | customer - method to remove customer profile from email suppression |
|
|
1839
1840
|
| 4.1.122 | 07/29/2026 | auto order api - new methods for payment information and rebill |
|
data/docs/OrderQuery.md
CHANGED
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **card_bin** | **String** | First six digits (BIN) of the credit card number. Must be specified together with card_last4 and a payment_date_begin/payment_date_end range. Requires query_target=cache. | [optional] |
|
|
8
|
+
| **card_last4** | **String** | Last four digits of the credit card number. Must be specified together with card_bin and a payment_date_begin/payment_date_end range. Always supply four digits, including for American Express. Requires query_target=cache. | [optional] |
|
|
7
9
|
| **cc_email** | **String** | CC Email | [optional] |
|
|
8
10
|
| **channel_partner_code** | **String** | The code of the channel partner | [optional] |
|
|
9
11
|
| **channel_partner_order_id** | **String** | The order ID assigned by the channel partner for this order | [optional] |
|
|
@@ -32,7 +34,7 @@
|
|
|
32
34
|
| **payment_date_begin** | **String** | Date/time that the order was successfully processed | [optional] |
|
|
33
35
|
| **payment_date_end** | **String** | Date/time that the order was successfully processed | [optional] |
|
|
34
36
|
| **payment_method** | **String** | Payment method | [optional] |
|
|
35
|
-
| **payment_transaction_filters** | [**Array<OrderQueryPaymentTransactionFilter>**](OrderQueryPaymentTransactionFilter.md) | Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache
|
|
37
|
+
| **payment_transaction_filters** | [**Array<OrderQueryPaymentTransactionFilter>**](OrderQueryPaymentTransactionFilter.md) | Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName. | [optional] |
|
|
36
38
|
| **phone** | **String** | Phone | [optional] |
|
|
37
39
|
| **postal_code** | **String** | Postal code | [optional] |
|
|
38
40
|
| **purchase_order_number** | **String** | Purchase order number | [optional] |
|
|
@@ -55,6 +57,8 @@
|
|
|
55
57
|
require 'ultracart_api'
|
|
56
58
|
|
|
57
59
|
instance = UltracartClient::OrderQuery.new(
|
|
60
|
+
card_bin: null,
|
|
61
|
+
card_last4: null,
|
|
58
62
|
cc_email: null,
|
|
59
63
|
channel_partner_code: null,
|
|
60
64
|
channel_partner_order_id: null,
|
|
@@ -139,7 +139,7 @@ module UltracartClient
|
|
|
139
139
|
# Check to see if the all the properties in the model are valid
|
|
140
140
|
# @return true if the model is valid
|
|
141
141
|
def valid?
|
|
142
|
-
provider_name_validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "Lyris", "LyrisHQ", "MailChimp"
|
|
142
|
+
provider_name_validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "Lyris", "LyrisHQ", "MailChimp"])
|
|
143
143
|
return false unless provider_name_validator.valid?(@provider_name)
|
|
144
144
|
true
|
|
145
145
|
end
|
|
@@ -147,7 +147,7 @@ module UltracartClient
|
|
|
147
147
|
# Custom attribute writer method checking allowed values (enum).
|
|
148
148
|
# @param [Object] provider_name Object to be assigned
|
|
149
149
|
def provider_name=(provider_name)
|
|
150
|
-
validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "Lyris", "LyrisHQ", "MailChimp"
|
|
150
|
+
validator = EnumAttributeValidator.new('String', ["ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "Lyris", "LyrisHQ", "MailChimp"])
|
|
151
151
|
unless validator.valid?(provider_name)
|
|
152
152
|
fail ArgumentError, "invalid value for \"provider_name\", must be one of #{validator.allowable_values}."
|
|
153
153
|
end
|
|
@@ -15,6 +15,12 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module UltracartClient
|
|
17
17
|
class OrderQuery
|
|
18
|
+
# First six digits (BIN) of the credit card number. Must be specified together with card_last4 and a payment_date_begin/payment_date_end range. Requires query_target=cache.
|
|
19
|
+
attr_accessor :card_bin
|
|
20
|
+
|
|
21
|
+
# Last four digits of the credit card number. Must be specified together with card_bin and a payment_date_begin/payment_date_end range. Always supply four digits, including for American Express. Requires query_target=cache.
|
|
22
|
+
attr_accessor :card_last4
|
|
23
|
+
|
|
18
24
|
# CC Email
|
|
19
25
|
attr_accessor :cc_email
|
|
20
26
|
|
|
@@ -99,7 +105,7 @@ module UltracartClient
|
|
|
99
105
|
# Payment method
|
|
100
106
|
attr_accessor :payment_method
|
|
101
107
|
|
|
102
|
-
# Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache
|
|
108
|
+
# Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
|
|
103
109
|
attr_accessor :payment_transaction_filters
|
|
104
110
|
|
|
105
111
|
# Phone
|
|
@@ -172,6 +178,8 @@ module UltracartClient
|
|
|
172
178
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
173
179
|
def self.attribute_map
|
|
174
180
|
{
|
|
181
|
+
:'card_bin' => :'card_bin',
|
|
182
|
+
:'card_last4' => :'card_last4',
|
|
175
183
|
:'cc_email' => :'cc_email',
|
|
176
184
|
:'channel_partner_code' => :'channel_partner_code',
|
|
177
185
|
:'channel_partner_order_id' => :'channel_partner_order_id',
|
|
@@ -227,6 +235,8 @@ module UltracartClient
|
|
|
227
235
|
# Attribute type mapping.
|
|
228
236
|
def self.openapi_types
|
|
229
237
|
{
|
|
238
|
+
:'card_bin' => :'String',
|
|
239
|
+
:'card_last4' => :'String',
|
|
230
240
|
:'cc_email' => :'String',
|
|
231
241
|
:'channel_partner_code' => :'String',
|
|
232
242
|
:'channel_partner_order_id' => :'String',
|
|
@@ -295,6 +305,14 @@ module UltracartClient
|
|
|
295
305
|
h[k.to_sym] = v
|
|
296
306
|
}
|
|
297
307
|
|
|
308
|
+
if attributes.key?(:'card_bin')
|
|
309
|
+
self.card_bin = attributes[:'card_bin']
|
|
310
|
+
end
|
|
311
|
+
|
|
312
|
+
if attributes.key?(:'card_last4')
|
|
313
|
+
self.card_last4 = attributes[:'card_last4']
|
|
314
|
+
end
|
|
315
|
+
|
|
298
316
|
if attributes.key?(:'cc_email')
|
|
299
317
|
self.cc_email = attributes[:'cc_email']
|
|
300
318
|
end
|
|
@@ -478,6 +496,14 @@ module UltracartClient
|
|
|
478
496
|
# @return Array for valid properties with the reasons
|
|
479
497
|
def list_invalid_properties
|
|
480
498
|
invalid_properties = Array.new
|
|
499
|
+
if !@card_bin.nil? && @card_bin.to_s.length > 6
|
|
500
|
+
invalid_properties.push('invalid value for "card_bin", the character length must be smaller than or equal to 6.')
|
|
501
|
+
end
|
|
502
|
+
|
|
503
|
+
if !@card_last4.nil? && @card_last4.to_s.length > 4
|
|
504
|
+
invalid_properties.push('invalid value for "card_last4", the character length must be smaller than or equal to 4.')
|
|
505
|
+
end
|
|
506
|
+
|
|
481
507
|
if !@cc_email.nil? && @cc_email.to_s.length > 100
|
|
482
508
|
invalid_properties.push('invalid value for "cc_email", the character length must be smaller than or equal to 100.')
|
|
483
509
|
end
|
|
@@ -532,6 +558,8 @@ module UltracartClient
|
|
|
532
558
|
# Check to see if the all the properties in the model are valid
|
|
533
559
|
# @return true if the model is valid
|
|
534
560
|
def valid?
|
|
561
|
+
return false if !@card_bin.nil? && @card_bin.to_s.length > 6
|
|
562
|
+
return false if !@card_last4.nil? && @card_last4.to_s.length > 4
|
|
535
563
|
return false if !@cc_email.nil? && @cc_email.to_s.length > 100
|
|
536
564
|
return false if !@city.nil? && @city.to_s.length > 32
|
|
537
565
|
return false if !@company.nil? && @company.to_s.length > 50
|
|
@@ -553,6 +581,26 @@ module UltracartClient
|
|
|
553
581
|
true
|
|
554
582
|
end
|
|
555
583
|
|
|
584
|
+
# Custom attribute writer method with validation
|
|
585
|
+
# @param [Object] card_bin Value to be assigned
|
|
586
|
+
def card_bin=(card_bin)
|
|
587
|
+
if !card_bin.nil? && card_bin.to_s.length > 6
|
|
588
|
+
fail ArgumentError, 'invalid value for "card_bin", the character length must be smaller than or equal to 6.'
|
|
589
|
+
end
|
|
590
|
+
|
|
591
|
+
@card_bin = card_bin
|
|
592
|
+
end
|
|
593
|
+
|
|
594
|
+
# Custom attribute writer method with validation
|
|
595
|
+
# @param [Object] card_last4 Value to be assigned
|
|
596
|
+
def card_last4=(card_last4)
|
|
597
|
+
if !card_last4.nil? && card_last4.to_s.length > 4
|
|
598
|
+
fail ArgumentError, 'invalid value for "card_last4", the character length must be smaller than or equal to 4.'
|
|
599
|
+
end
|
|
600
|
+
|
|
601
|
+
@card_last4 = card_last4
|
|
602
|
+
end
|
|
603
|
+
|
|
556
604
|
# Custom attribute writer method with validation
|
|
557
605
|
# @param [Object] cc_email Value to be assigned
|
|
558
606
|
def cc_email=(cc_email)
|
|
@@ -708,6 +756,8 @@ module UltracartClient
|
|
|
708
756
|
def ==(o)
|
|
709
757
|
return true if self.equal?(o)
|
|
710
758
|
self.class == o.class &&
|
|
759
|
+
card_bin == o.card_bin &&
|
|
760
|
+
card_last4 == o.card_last4 &&
|
|
711
761
|
cc_email == o.cc_email &&
|
|
712
762
|
channel_partner_code == o.channel_partner_code &&
|
|
713
763
|
channel_partner_order_id == o.channel_partner_order_id &&
|
|
@@ -763,7 +813,7 @@ module UltracartClient
|
|
|
763
813
|
# Calculates hash code according to all attributes.
|
|
764
814
|
# @return [Integer] Hash code
|
|
765
815
|
def hash
|
|
766
|
-
[cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, custom_field_1, custom_field_10, custom_field_2, custom_field_3, custom_field_4, custom_field_5, custom_field_6, custom_field_7, custom_field_8, custom_field_9, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, payment_transaction_filters, phone, postal_code, purchase_order_number, query_target, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, shipped_on_date_begin, shipped_on_date_end, state_region, storefront_host_name, total].hash
|
|
816
|
+
[card_bin, card_last4, cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, custom_field_1, custom_field_10, custom_field_2, custom_field_3, custom_field_4, custom_field_5, custom_field_6, custom_field_7, custom_field_8, custom_field_9, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, payment_transaction_filters, phone, postal_code, purchase_order_number, query_target, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, shipped_on_date_begin, shipped_on_date_end, state_region, storefront_host_name, total].hash
|
|
767
817
|
end
|
|
768
818
|
|
|
769
819
|
# 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.125
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-08-
|
|
11
|
+
date: 2026-08-06 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|