ultracart_api 4.1.21 → 4.1.22
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 +3 -2
- data/docs/Customer.md +2 -0
- data/docs/ItemShippingMethod.md +2 -0
- data/docs/ReplaceOrderItemIdRequest.md +1 -1
- data/lib/ultracart_api/models/customer.rb +26 -1
- data/lib/ultracart_api/models/item_shipping_method.rb +11 -1
- data/lib/ultracart_api/models/order_payment.rb +2 -2
- data/lib/ultracart_api/models/replace_order_item_id_request.rb +1 -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: e89e148b93ef845b28da355d959a528ac286d3ad1cba0b6278e43b0d367a7373
|
4
|
+
data.tar.gz: ec287a01a538909856614f4029a4117f97bbabd0c8d654bb08e7e9952fee96f7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d182c2d80f5d002227f0a13fb824f94ab482ad60f9c79943047255b86c0e7b6f2b38144060f13268078191fd80d858865246148001e3b1f17fddd5fd1c041f66
|
7
|
+
data.tar.gz: 0e78e95588d1924ea446d334c05c6ff51636487dd86f444609e7694908a253071c11a9691cf73608c60ec47be1c9f09481679a92b9f367fdf6af331a4568f621
|
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.22
|
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.22'
|
20
20
|
```
|
21
21
|
|
22
22
|
install:
|
@@ -1575,6 +1575,7 @@ Not every change is committed to every SDK.
|
|
1575
1575
|
|
1576
1576
|
| Version | Date | Comments |
|
1577
1577
|
| --: | :-: | --- |
|
1578
|
+
| 4.1.22 | 10/06/2025 | added Customer.fax back into object model |
|
1578
1579
|
| 4.1.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
1579
1580
|
| 4.1.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
|
1580
1581
|
| 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
|
data/docs/Customer.md
CHANGED
@@ -27,6 +27,7 @@
|
|
27
27
|
| **edi** | [**CustomerEDI**](CustomerEDI.md) | | [optional] |
|
28
28
|
| **email** | **String** | Email address of this customer profile | [optional] |
|
29
29
|
| **exempt_shipping_handling_charge** | **Boolean** | Exempt shipping handling charge | [optional] |
|
30
|
+
| **fax** | **String** | Fax Number | [optional] |
|
30
31
|
| **fedex_account_number** | **String** | FedEx account number | [optional] |
|
31
32
|
| **free_shipping** | **Boolean** | This customer always receives free shipping | [optional] |
|
32
33
|
| **free_shipping_minimum** | **Float** | If free_shipping is true, this is the minimum subtotal required for free shipping | [optional] |
|
@@ -98,6 +99,7 @@ instance = UltracartClient::Customer.new(
|
|
98
99
|
edi: null,
|
99
100
|
email: null,
|
100
101
|
exempt_shipping_handling_charge: null,
|
102
|
+
fax: null,
|
101
103
|
fedex_account_number: null,
|
102
104
|
free_shipping: null,
|
103
105
|
free_shipping_minimum: null,
|
data/docs/ItemShippingMethod.md
CHANGED
@@ -18,6 +18,7 @@
|
|
18
18
|
| **shipping_method** | **String** | Shipping method name | [optional] |
|
19
19
|
| **shipping_method_oid** | **Integer** | Shipping method object identifier | [optional] |
|
20
20
|
| **shipping_method_validity** | **String** | Shipping method validity | [optional] |
|
21
|
+
| **ships_separately** | **Boolean** | Ships separately | [optional] |
|
21
22
|
| **signature_required** | **Boolean** | Signature required | [optional] |
|
22
23
|
|
23
24
|
## Example
|
@@ -40,6 +41,7 @@ instance = UltracartClient::ItemShippingMethod.new(
|
|
40
41
|
shipping_method: null,
|
41
42
|
shipping_method_oid: null,
|
42
43
|
shipping_method_validity: null,
|
44
|
+
ships_separately: null,
|
43
45
|
signature_required: null
|
44
46
|
)
|
45
47
|
```
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **item_index** | **Integer** | Index of the item on the order
|
7
|
+
| **item_index** | **Integer** | Index of the item on the order. Must match order.items[].item_index | [optional] |
|
8
8
|
| **merchant_item_id** | **String** | Item ID | [optional] |
|
9
9
|
| **order_id** | **String** | Order ID | [optional] |
|
10
10
|
| **replacement_merchant_item_id** | **String** | Replacement Item ID | [optional] |
|
@@ -82,6 +82,9 @@ module UltracartClient
|
|
82
82
|
# Exempt shipping handling charge
|
83
83
|
attr_accessor :exempt_shipping_handling_charge
|
84
84
|
|
85
|
+
# Fax Number
|
86
|
+
attr_accessor :fax
|
87
|
+
|
85
88
|
# FedEx account number
|
86
89
|
attr_accessor :fedex_account_number
|
87
90
|
|
@@ -225,6 +228,7 @@ module UltracartClient
|
|
225
228
|
:'edi' => :'edi',
|
226
229
|
:'email' => :'email',
|
227
230
|
:'exempt_shipping_handling_charge' => :'exempt_shipping_handling_charge',
|
231
|
+
:'fax' => :'fax',
|
228
232
|
:'fedex_account_number' => :'fedex_account_number',
|
229
233
|
:'free_shipping' => :'free_shipping',
|
230
234
|
:'free_shipping_minimum' => :'free_shipping_minimum',
|
@@ -300,6 +304,7 @@ module UltracartClient
|
|
300
304
|
:'edi' => :'CustomerEDI',
|
301
305
|
:'email' => :'String',
|
302
306
|
:'exempt_shipping_handling_charge' => :'Boolean',
|
307
|
+
:'fax' => :'String',
|
303
308
|
:'fedex_account_number' => :'String',
|
304
309
|
:'free_shipping' => :'Boolean',
|
305
310
|
:'free_shipping_minimum' => :'Float',
|
@@ -465,6 +470,10 @@ module UltracartClient
|
|
465
470
|
self.exempt_shipping_handling_charge = attributes[:'exempt_shipping_handling_charge']
|
466
471
|
end
|
467
472
|
|
473
|
+
if attributes.key?(:'fax')
|
474
|
+
self.fax = attributes[:'fax']
|
475
|
+
end
|
476
|
+
|
468
477
|
if attributes.key?(:'fedex_account_number')
|
469
478
|
self.fedex_account_number = attributes[:'fedex_account_number']
|
470
479
|
end
|
@@ -660,6 +669,10 @@ module UltracartClient
|
|
660
669
|
invalid_properties.push('invalid value for "dhl_duty_account_number", the character length must be smaller than or equal to 20.')
|
661
670
|
end
|
662
671
|
|
672
|
+
if !@fax.nil? && @fax.to_s.length > 32
|
673
|
+
invalid_properties.push('invalid value for "fax", the character length must be smaller than or equal to 32.')
|
674
|
+
end
|
675
|
+
|
663
676
|
if !@fedex_account_number.nil? && @fedex_account_number.to_s.length > 20
|
664
677
|
invalid_properties.push('invalid value for "fedex_account_number", the character length must be smaller than or equal to 20.')
|
665
678
|
end
|
@@ -701,6 +714,7 @@ module UltracartClient
|
|
701
714
|
return false if !@business_notes.nil? && @business_notes.to_s.length > 2000
|
702
715
|
return false if !@dhl_account_number.nil? && @dhl_account_number.to_s.length > 20
|
703
716
|
return false if !@dhl_duty_account_number.nil? && @dhl_duty_account_number.to_s.length > 20
|
717
|
+
return false if !@fax.nil? && @fax.to_s.length > 32
|
704
718
|
return false if !@fedex_account_number.nil? && @fedex_account_number.to_s.length > 20
|
705
719
|
return false if !@last_modified_by.nil? && @last_modified_by.to_s.length > 100
|
706
720
|
return false if !@password.nil? && @password.to_s.length > 30
|
@@ -742,6 +756,16 @@ module UltracartClient
|
|
742
756
|
@dhl_duty_account_number = dhl_duty_account_number
|
743
757
|
end
|
744
758
|
|
759
|
+
# Custom attribute writer method with validation
|
760
|
+
# @param [Object] fax Value to be assigned
|
761
|
+
def fax=(fax)
|
762
|
+
if !fax.nil? && fax.to_s.length > 32
|
763
|
+
fail ArgumentError, 'invalid value for "fax", the character length must be smaller than or equal to 32.'
|
764
|
+
end
|
765
|
+
|
766
|
+
@fax = fax
|
767
|
+
end
|
768
|
+
|
745
769
|
# Custom attribute writer method with validation
|
746
770
|
# @param [Object] fedex_account_number Value to be assigned
|
747
771
|
def fedex_account_number=(fedex_account_number)
|
@@ -850,6 +874,7 @@ module UltracartClient
|
|
850
874
|
edi == o.edi &&
|
851
875
|
email == o.email &&
|
852
876
|
exempt_shipping_handling_charge == o.exempt_shipping_handling_charge &&
|
877
|
+
fax == o.fax &&
|
853
878
|
fedex_account_number == o.fedex_account_number &&
|
854
879
|
free_shipping == o.free_shipping &&
|
855
880
|
free_shipping_minimum == o.free_shipping_minimum &&
|
@@ -902,7 +927,7 @@ module UltracartClient
|
|
902
927
|
# Calculates hash code according to all attributes.
|
903
928
|
# @return [Integer] Hash code
|
904
929
|
def hash
|
905
|
-
[activity, affiliate_oid, allow_3rd_party_billing, allow_cod, allow_drop_shipping, allow_purchase_order, allow_quote_request, allow_selection_of_address_type, attachments, auto_approve_cod, auto_approve_purchase_order, automatic_merchant_notes, billing, business_notes, cards, cc_emails, customer_profile_oid, dhl_account_number, dhl_duty_account_number, do_not_send_mail, edi, email, exempt_shipping_handling_charge, fedex_account_number, free_shipping, free_shipping_minimum, last_modified_by, last_modified_dts, loyalty, maximum_item_count, merchant_id, minimum_item_count, minimum_subtotal, no_coupons, no_free_shipping, no_realtime_charge, orders, orders_summary, password, pricing_tiers, privacy, properties, qb_class, qb_code, qb_tax_exemption_reason_code, quotes, quotes_summary, referral_source, reviewer, sales_rep_code, send_signup_notification, shipping, signup_dts, software_entitlements, suppress_buysafe, tags, tax_codes, tax_exempt, tax_id, terms, track_separately, unapproved, ups_account_number, website_url].hash
|
930
|
+
[activity, affiliate_oid, allow_3rd_party_billing, allow_cod, allow_drop_shipping, allow_purchase_order, allow_quote_request, allow_selection_of_address_type, attachments, auto_approve_cod, auto_approve_purchase_order, automatic_merchant_notes, billing, business_notes, cards, cc_emails, customer_profile_oid, dhl_account_number, dhl_duty_account_number, do_not_send_mail, edi, email, exempt_shipping_handling_charge, fax, fedex_account_number, free_shipping, free_shipping_minimum, last_modified_by, last_modified_dts, loyalty, maximum_item_count, merchant_id, minimum_item_count, minimum_subtotal, no_coupons, no_free_shipping, no_realtime_charge, orders, orders_summary, password, pricing_tiers, privacy, properties, qb_class, qb_code, qb_tax_exemption_reason_code, quotes, quotes_summary, referral_source, reviewer, sales_rep_code, send_signup_notification, shipping, signup_dts, software_entitlements, suppress_buysafe, tags, tax_codes, tax_exempt, tax_id, terms, track_separately, unapproved, ups_account_number, website_url].hash
|
906
931
|
end
|
907
932
|
|
908
933
|
# Builds the object from hash
|
@@ -57,6 +57,9 @@ module UltracartClient
|
|
57
57
|
# Shipping method validity
|
58
58
|
attr_accessor :shipping_method_validity
|
59
59
|
|
60
|
+
# Ships separately
|
61
|
+
attr_accessor :ships_separately
|
62
|
+
|
60
63
|
# Signature required
|
61
64
|
attr_accessor :signature_required
|
62
65
|
|
@@ -99,6 +102,7 @@ module UltracartClient
|
|
99
102
|
:'shipping_method' => :'shipping_method',
|
100
103
|
:'shipping_method_oid' => :'shipping_method_oid',
|
101
104
|
:'shipping_method_validity' => :'shipping_method_validity',
|
105
|
+
:'ships_separately' => :'ships_separately',
|
102
106
|
:'signature_required' => :'signature_required'
|
103
107
|
}
|
104
108
|
end
|
@@ -125,6 +129,7 @@ module UltracartClient
|
|
125
129
|
:'shipping_method' => :'String',
|
126
130
|
:'shipping_method_oid' => :'Integer',
|
127
131
|
:'shipping_method_validity' => :'String',
|
132
|
+
:'ships_separately' => :'Boolean',
|
128
133
|
:'signature_required' => :'Boolean'
|
129
134
|
}
|
130
135
|
end
|
@@ -206,6 +211,10 @@ module UltracartClient
|
|
206
211
|
self.shipping_method_validity = attributes[:'shipping_method_validity']
|
207
212
|
end
|
208
213
|
|
214
|
+
if attributes.key?(:'ships_separately')
|
215
|
+
self.ships_separately = attributes[:'ships_separately']
|
216
|
+
end
|
217
|
+
|
209
218
|
if attributes.key?(:'signature_required')
|
210
219
|
self.signature_required = attributes[:'signature_required']
|
211
220
|
end
|
@@ -255,6 +264,7 @@ module UltracartClient
|
|
255
264
|
shipping_method == o.shipping_method &&
|
256
265
|
shipping_method_oid == o.shipping_method_oid &&
|
257
266
|
shipping_method_validity == o.shipping_method_validity &&
|
267
|
+
ships_separately == o.ships_separately &&
|
258
268
|
signature_required == o.signature_required
|
259
269
|
end
|
260
270
|
|
@@ -267,7 +277,7 @@ module UltracartClient
|
|
267
277
|
# Calculates hash code according to all attributes.
|
268
278
|
# @return [Integer] Hash code
|
269
279
|
def hash
|
270
|
-
[cost, each_additional_item_markup, filter_to_if_available, first_item_markup, fixed_shipping_cost, flat_fee_markup, free_shipping, per_item_fee_markup, percentage_markup, percentage_of_item_markup, relax_restrictions_on_upsell, shipping_method, shipping_method_oid, shipping_method_validity, signature_required].hash
|
280
|
+
[cost, each_additional_item_markup, filter_to_if_available, first_item_markup, fixed_shipping_cost, flat_fee_markup, free_shipping, per_item_fee_markup, percentage_markup, percentage_of_item_markup, relax_restrictions_on_upsell, shipping_method, shipping_method_oid, shipping_method_validity, ships_separately, signature_required].hash
|
271
281
|
end
|
272
282
|
|
273
283
|
# Builds the object from hash
|
@@ -260,7 +260,7 @@ module UltracartClient
|
|
260
260
|
# Check to see if the all the properties in the model are valid
|
261
261
|
# @return true if the model is valid
|
262
262
|
def valid?
|
263
|
-
payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane"])
|
263
|
+
payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "Crypto", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane"])
|
264
264
|
return false unless payment_method_validator.valid?(@payment_method)
|
265
265
|
payment_status_validator = EnumAttributeValidator.new('String', ["Unprocessed", "Authorized", "Capture Failed", "Processed", "Declined", "Voided", "Refunded", "Skipped"])
|
266
266
|
return false unless payment_status_validator.valid?(@payment_status)
|
@@ -270,7 +270,7 @@ module UltracartClient
|
|
270
270
|
# Custom attribute writer method checking allowed values (enum).
|
271
271
|
# @param [Object] payment_method Object to be assigned
|
272
272
|
def payment_method=(payment_method)
|
273
|
-
validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane"])
|
273
|
+
validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "Crypto", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane"])
|
274
274
|
unless validator.valid?(payment_method)
|
275
275
|
fail ArgumentError, "invalid value for \"payment_method\", must be one of #{validator.allowable_values}."
|
276
276
|
end
|
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.22
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-
|
11
|
+
date: 2025-10-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|