ultracart_api 3.11.21 → 3.11.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 +5 -4
- data/docs/Customer.md +1 -0
- data/docs/ItemShippingMethod.md +1 -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: 8c73a4700cafb82284bcd2bcc98eaf19b1148a6b84509284916ef5036f3e7198
|
4
|
+
data.tar.gz: 9baa355ee2c2f7a944cb62d96ab6968241aab6d4a066c123408fe69d254227a3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2fb1990cf0bbb95333403dd8b60d099d7d1aff7d76a3ebef1fd8ad01161836b936210d3b843f25b424ed49ee50ef045abf8ed734e49c6c4b4cb4fc407b317325
|
7
|
+
data.tar.gz: bcf51fb85a13fd8f19fd9674e1c308cb40d49ca98404e74e957c4ddf180c4848d3111edbad1ac13c75ecc61d045a5635dbeabe23b1078b37b2ee5376b0428aa5
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.11.
|
10
|
+
- Package version: 3.11.22
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.11.
|
27
|
+
gem install ./ultracart_api-3.11.22.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.11.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.11.22.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.11.
|
35
|
+
gem 'ultracart_api', '~> 3.11.22'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -1577,6 +1577,7 @@ Not every change is committed to every SDK.
|
|
1577
1577
|
|
1578
1578
|
| Version | Date | Comments |
|
1579
1579
|
| --: | :-: | --- |
|
1580
|
+
| 3.11.22 | 10/06/2025 | added Customer.fax back into object model |
|
1580
1581
|
| 3.11.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
1581
1582
|
| 3.11.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
|
1582
1583
|
| 3.11.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
|
data/docs/Customer.md
CHANGED
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
|
26
26
|
**edi** | [**CustomerEDI**](CustomerEDI.md) | | [optional]
|
27
27
|
**email** | **String** | Email address of this customer profile | [optional]
|
28
28
|
**exempt_shipping_handling_charge** | **BOOLEAN** | Exempt shipping handling charge | [optional]
|
29
|
+
**fax** | **String** | Fax Number | [optional]
|
29
30
|
**fedex_account_number** | **String** | FedEx account number | [optional]
|
30
31
|
**free_shipping** | **BOOLEAN** | This customer always receives free shipping | [optional]
|
31
32
|
**free_shipping_minimum** | **Float** | If free_shipping is true, this is the minimum subtotal required for free shipping | [optional]
|
data/docs/ItemShippingMethod.md
CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
|
|
17
17
|
**shipping_method** | **String** | Shipping method name | [optional]
|
18
18
|
**shipping_method_oid** | **Integer** | Shipping method object identifier | [optional]
|
19
19
|
**shipping_method_validity** | **String** | Shipping method validity | [optional]
|
20
|
+
**ships_separately** | **BOOLEAN** | Ships separately | [optional]
|
20
21
|
**signature_required** | **BOOLEAN** | Signature required | [optional]
|
21
22
|
|
22
23
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**item_index** | **Integer** | Index of the item on the order
|
6
|
+
**item_index** | **Integer** | Index of the item on the order. Must match order.items[].item_index | [optional]
|
7
7
|
**merchant_item_id** | **String** | Item ID | [optional]
|
8
8
|
**order_id** | **String** | Order ID | [optional]
|
9
9
|
**replacement_merchant_item_id** | **String** | Replacement Item ID | [optional]
|
@@ -81,6 +81,9 @@ module UltracartClient
|
|
81
81
|
# Exempt shipping handling charge
|
82
82
|
attr_accessor :exempt_shipping_handling_charge
|
83
83
|
|
84
|
+
# Fax Number
|
85
|
+
attr_accessor :fax
|
86
|
+
|
84
87
|
# FedEx account number
|
85
88
|
attr_accessor :fedex_account_number
|
86
89
|
|
@@ -224,6 +227,7 @@ module UltracartClient
|
|
224
227
|
:'edi' => :'edi',
|
225
228
|
:'email' => :'email',
|
226
229
|
:'exempt_shipping_handling_charge' => :'exempt_shipping_handling_charge',
|
230
|
+
:'fax' => :'fax',
|
227
231
|
:'fedex_account_number' => :'fedex_account_number',
|
228
232
|
:'free_shipping' => :'free_shipping',
|
229
233
|
:'free_shipping_minimum' => :'free_shipping_minimum',
|
@@ -294,6 +298,7 @@ module UltracartClient
|
|
294
298
|
:'edi' => :'CustomerEDI',
|
295
299
|
:'email' => :'String',
|
296
300
|
:'exempt_shipping_handling_charge' => :'BOOLEAN',
|
301
|
+
:'fax' => :'String',
|
297
302
|
:'fedex_account_number' => :'String',
|
298
303
|
:'free_shipping' => :'BOOLEAN',
|
299
304
|
:'free_shipping_minimum' => :'Float',
|
@@ -446,6 +451,10 @@ module UltracartClient
|
|
446
451
|
self.exempt_shipping_handling_charge = attributes[:'exempt_shipping_handling_charge']
|
447
452
|
end
|
448
453
|
|
454
|
+
if attributes.has_key?(:'fax')
|
455
|
+
self.fax = attributes[:'fax']
|
456
|
+
end
|
457
|
+
|
449
458
|
if attributes.has_key?(:'fedex_account_number')
|
450
459
|
self.fedex_account_number = attributes[:'fedex_account_number']
|
451
460
|
end
|
@@ -641,6 +650,10 @@ module UltracartClient
|
|
641
650
|
invalid_properties.push('invalid value for "dhl_duty_account_number", the character length must be smaller than or equal to 20.')
|
642
651
|
end
|
643
652
|
|
653
|
+
if !@fax.nil? && @fax.to_s.length > 32
|
654
|
+
invalid_properties.push('invalid value for "fax", the character length must be smaller than or equal to 32.')
|
655
|
+
end
|
656
|
+
|
644
657
|
if !@fedex_account_number.nil? && @fedex_account_number.to_s.length > 20
|
645
658
|
invalid_properties.push('invalid value for "fedex_account_number", the character length must be smaller than or equal to 20.')
|
646
659
|
end
|
@@ -682,6 +695,7 @@ module UltracartClient
|
|
682
695
|
return false if !@business_notes.nil? && @business_notes.to_s.length > 2000
|
683
696
|
return false if !@dhl_account_number.nil? && @dhl_account_number.to_s.length > 20
|
684
697
|
return false if !@dhl_duty_account_number.nil? && @dhl_duty_account_number.to_s.length > 20
|
698
|
+
return false if !@fax.nil? && @fax.to_s.length > 32
|
685
699
|
return false if !@fedex_account_number.nil? && @fedex_account_number.to_s.length > 20
|
686
700
|
return false if !@last_modified_by.nil? && @last_modified_by.to_s.length > 100
|
687
701
|
return false if !@password.nil? && @password.to_s.length > 30
|
@@ -723,6 +737,16 @@ module UltracartClient
|
|
723
737
|
@dhl_duty_account_number = dhl_duty_account_number
|
724
738
|
end
|
725
739
|
|
740
|
+
# Custom attribute writer method with validation
|
741
|
+
# @param [Object] fax Value to be assigned
|
742
|
+
def fax=(fax)
|
743
|
+
if !fax.nil? && fax.to_s.length > 32
|
744
|
+
fail ArgumentError, 'invalid value for "fax", the character length must be smaller than or equal to 32.'
|
745
|
+
end
|
746
|
+
|
747
|
+
@fax = fax
|
748
|
+
end
|
749
|
+
|
726
750
|
# Custom attribute writer method with validation
|
727
751
|
# @param [Object] fedex_account_number Value to be assigned
|
728
752
|
def fedex_account_number=(fedex_account_number)
|
@@ -831,6 +855,7 @@ module UltracartClient
|
|
831
855
|
edi == o.edi &&
|
832
856
|
email == o.email &&
|
833
857
|
exempt_shipping_handling_charge == o.exempt_shipping_handling_charge &&
|
858
|
+
fax == o.fax &&
|
834
859
|
fedex_account_number == o.fedex_account_number &&
|
835
860
|
free_shipping == o.free_shipping &&
|
836
861
|
free_shipping_minimum == o.free_shipping_minimum &&
|
@@ -883,7 +908,7 @@ module UltracartClient
|
|
883
908
|
# Calculates hash code according to all attributes.
|
884
909
|
# @return [Fixnum] Hash code
|
885
910
|
def hash
|
886
|
-
[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
|
911
|
+
[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
|
887
912
|
end
|
888
913
|
|
889
914
|
# Builds the object from hash
|
@@ -56,6 +56,9 @@ module UltracartClient
|
|
56
56
|
# Shipping method validity
|
57
57
|
attr_accessor :shipping_method_validity
|
58
58
|
|
59
|
+
# Ships separately
|
60
|
+
attr_accessor :ships_separately
|
61
|
+
|
59
62
|
# Signature required
|
60
63
|
attr_accessor :signature_required
|
61
64
|
|
@@ -98,6 +101,7 @@ module UltracartClient
|
|
98
101
|
:'shipping_method' => :'shipping_method',
|
99
102
|
:'shipping_method_oid' => :'shipping_method_oid',
|
100
103
|
:'shipping_method_validity' => :'shipping_method_validity',
|
104
|
+
:'ships_separately' => :'ships_separately',
|
101
105
|
:'signature_required' => :'signature_required'
|
102
106
|
}
|
103
107
|
end
|
@@ -119,6 +123,7 @@ module UltracartClient
|
|
119
123
|
:'shipping_method' => :'String',
|
120
124
|
:'shipping_method_oid' => :'Integer',
|
121
125
|
:'shipping_method_validity' => :'String',
|
126
|
+
:'ships_separately' => :'BOOLEAN',
|
122
127
|
:'signature_required' => :'BOOLEAN'
|
123
128
|
}
|
124
129
|
end
|
@@ -187,6 +192,10 @@ module UltracartClient
|
|
187
192
|
self.shipping_method_validity = attributes[:'shipping_method_validity']
|
188
193
|
end
|
189
194
|
|
195
|
+
if attributes.has_key?(:'ships_separately')
|
196
|
+
self.ships_separately = attributes[:'ships_separately']
|
197
|
+
end
|
198
|
+
|
190
199
|
if attributes.has_key?(:'signature_required')
|
191
200
|
self.signature_required = attributes[:'signature_required']
|
192
201
|
end
|
@@ -236,6 +245,7 @@ module UltracartClient
|
|
236
245
|
shipping_method == o.shipping_method &&
|
237
246
|
shipping_method_oid == o.shipping_method_oid &&
|
238
247
|
shipping_method_validity == o.shipping_method_validity &&
|
248
|
+
ships_separately == o.ships_separately &&
|
239
249
|
signature_required == o.signature_required
|
240
250
|
end
|
241
251
|
|
@@ -248,7 +258,7 @@ module UltracartClient
|
|
248
258
|
# Calculates hash code according to all attributes.
|
249
259
|
# @return [Fixnum] Hash code
|
250
260
|
def hash
|
251
|
-
[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
|
261
|
+
[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
|
252
262
|
end
|
253
263
|
|
254
264
|
# Builds the object from hash
|
@@ -241,7 +241,7 @@ module UltracartClient
|
|
241
241
|
# Check to see if the all the properties in the model are valid
|
242
242
|
# @return true if the model is valid
|
243
243
|
def valid?
|
244
|
-
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'])
|
244
|
+
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'])
|
245
245
|
return false unless payment_method_validator.valid?(@payment_method)
|
246
246
|
payment_status_validator = EnumAttributeValidator.new('String', ['Unprocessed', 'Authorized', 'Capture Failed', 'Processed', 'Declined', 'Voided', 'Refunded', 'Skipped'])
|
247
247
|
return false unless payment_status_validator.valid?(@payment_status)
|
@@ -251,7 +251,7 @@ module UltracartClient
|
|
251
251
|
# Custom attribute writer method checking allowed values (enum).
|
252
252
|
# @param [Object] payment_method Object to be assigned
|
253
253
|
def payment_method=(payment_method)
|
254
|
-
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'])
|
254
|
+
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'])
|
255
255
|
unless validator.valid?(payment_method)
|
256
256
|
fail ArgumentError, 'invalid value for "payment_method", must be one of #{validator.allowable_values}.'
|
257
257
|
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: 3.11.
|
4
|
+
version: 3.11.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
|