ultracart_api 4.1.3 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3862728b643050ad70317e3c0a2e4c8ee10f4732cce25712e596b574fdd8e104
-  data.tar.gz: dbbd9ea72813c2fba6f3c94d772ad7dcaf8642f4848b5260c31cc3f63150655b
+  metadata.gz: 072052f4d9cffb084d1c14e700e1a912b9d07d0f5528d5bfb56afc397055cc34
+  data.tar.gz: 16dc833a02415b6218568966bf11c7ac3cc4c02cfb2d6f9f2954c30b2fb589c1
 SHA512:
-  metadata.gz: 338d7afdfdd47cd908c9a54ad18e8275802090f4e0f2098eac6f141aa3c3b3fae0d56d2c06be49e93432dee474c305aebaddba4ff65ba7925660a14bf53946cd
-  data.tar.gz: 9da725f887aa11e613cdf918355d33bdbb51e0b9d586f97d499410d20ec4a8c8fe742f3fb9495080c420ec10c4ed470028b8c06eab82869ecde0c271a3b51a30
+  metadata.gz: a26bfb1c9739bd9aaf0cd5dac305b5b2927fa09337b196a1796a7f2265512bc914ff083a02f0dc821e76fad615e024f8fb86be4490e316d1bf7769df75908348
+  data.tar.gz: 5f4957d6892dc48e4a214b90f9951fd3dad6c0ee782c567ae491aac5c5f5147c22638cb89836643cc4509da6e8a153a6e50192530c250ccf47e2fa297adc0d1d

data/README.md

@@ -1,89 +1,79 @@
-# ultracart_api
-
-UltracartClient - the Ruby gem for the UltraCart Rest API V2
+# UltraCart Ruby SDK
 
 UltraCart REST API Version 2
 
+Note: Every method has a sample for every language.  See https://github.com/UltraCart/sdk_samples
+
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.3
+- Package version: 4.1.5
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
-For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
+- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
 ## Installation
 
-### Build a gem
-
-To build the Ruby code into a gem:
+gemfile:
 
 ```shell
-gem build ultracart_api.gemspec
+gem 'ultracart_api', '4.1.5'
 ```
 
-Then either install the gem locally:
+install:
 
 ```shell
-gem install ./ultracart_api-4.1.3.gem
-```
-
-(for development, run `gem install --dev ./ultracart_api-4.1.3.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
-
-Finally add this to the Gemfile:
-
-    gem 'ultracart_api', '~> 4.1.3'
-
-### Install from Git
-
-If the Ruby gem is hosted at a git repository: https://github.com/UltraCart/rest_api_v2_sdk_ruby, then add the following in the Gemfile:
-
-    gem 'ultracart_api', :git => 'https://github.com/UltraCart/rest_api_v2_sdk_ruby.git'
-
-### Include the Ruby code directly
-
-Include the Ruby code directly using `-I` as follows:
-
-```shell
-ruby -Ilib script.rb
+gem install ultracart_api
 ```
 
 ## Getting Started
 
-Please follow the [installation](#installation) procedure and then run the following code:
-
 ```ruby
-# Load the gem
 require 'ultracart_api'
+require_relative '../constants'
 
-# Setup authorization
-UltracartClient.configure do |config|
-  # Configure OAuth2 access token for authorization: ultraCartOauth
-  config.access_token = 'YOUR ACCESS TOKEN'
+# OrderApi.getOrder() retrieves a single order for a given order_id.
+order_api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY)
 
-  # Configure API key authorization: ultraCartSimpleApiKey
-  config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
-end
+# The expansion variable instructs UltraCart how much information to return.  The order object is large and
+# while it's easily manageable for a single order, when querying thousands of orders, is useful to reduce
+# payload size.
+# see www.ultracart.com/api/ for all the expansion fields available (this list below may become stale)
+=begin
+Possible Order Expansions:
+affiliate           affiliate.ledger                    auto_order
+billing             channel_partner                     checkout
+coupon              customer_profile                    digital_order
+edi                 fraud_score                         gift
+gift_certificate    internal                            item
+linked_shipment     marketing                           payment
+payment.transaction quote                               salesforce
+shipping            shipping.tracking_number_details    summary
+taxes
+=end
+expansion = "item,summary,billing,shipping,shipping.tracking_number_details"
 
-api_instance = UltracartClient::AffiliateApi.new
-click_query = UltracartClient::AffiliateClickQuery.new # AffiliateClickQuery | Click query
+order_id = 'DEMO-0009104390'
 opts = {
-  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 10000)
-  _offset: 56, # Integer | Pagination of the record set.  Offset is a zero based index.
-  _expand: '_expand_example' # String | The object expansion to perform on the result.  Only option is link.
+  '_expand' => expansion
 }
 
 begin
-  #Retrieve clicks
-  result = api_instance.get_clicks_by_query(click_query, opts)
-  p result
-rescue UltracartClient::ApiError => e
-  puts "Exception when calling AffiliateApi->get_clicks_by_query: #{e}"
-end
+  api_response = order_api.get_order(order_id, opts)
+
+  # Check for errors
+  if api_response.error
+    puts "Developer Message: #{api_response.error.developer_message}"
+    puts "User Message: #{api_response.error.user_message}"
+    exit
+  end
 
+  order = api_response.order
+
+  # Using inspect instead of var_dump for Ruby-style object representation
+  puts order.inspect
+rescue StandardError => e
+  puts "An error occurred: #{e.message}"
+end
 ```
 
 ## Documentation for API Endpoints
@@ -1526,6 +1516,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.5 | 03/28/2025 | added paypal fastlane constants for payments |
+| 4.1.4 | 03/07/2025 | updated github readme.md |
 | 4.1.3 | 03/07/2025 | updated github readme.md files |
 | 4.1.2 | 03/05/2025 | added ChannelPartnerOrder.use_prior_payment_information_from_order_id |
 | 4.1.1 | 02/28/2025 | auto order pause method |

data/lib/ultracart_api/models/channel_partner_order.rb

@@ -1103,7 +1103,7 @@ module UltracartClient
       return false if !@email.nil? && @email.to_s.length > 100
       return false if !@gift_email.nil? && @gift_email.to_s.length > 100
       return false if !@gift_message.nil? && @gift_message.to_s.length > 10000
-      payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer"])
+      payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer", "PayPal Fastlane"])
       return false unless payment_method_validator.valid?(@payment_method)
       return false if !@screen_branding_theme_code.nil? && @screen_branding_theme_code.to_s.length > 10
       return false if !@shipto_address1.nil? && @shipto_address1.to_s.length > 50
@@ -1375,7 +1375,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_method Object to be assigned
     def payment_method=(payment_method)
-      validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer"])
+      validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer", "PayPal Fastlane"])
       unless validator.valid?(payment_method)
         fail ArgumentError, "invalid value for \"payment_method\", must be one of #{validator.allowable_values}."
       end

data/lib/ultracart_api/models/order_payment.rb

@@ -260,7 +260,7 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "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"])
+      payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "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"])
       return false unless payment_method_validator.valid?(@payment_method)
       payment_status_validator = EnumAttributeValidator.new('String', ["Unprocessed", "Authorized", "Capture Failed", "Processed", "Declined", "Voided", "Refunded", "Skipped"])
       return false unless payment_status_validator.valid?(@payment_status)
@@ -270,7 +270,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_method Object to be assigned
     def payment_method=(payment_method)
-      validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "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"])
+      validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eBay", "eCheck", "Google Shopping", "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"])
       unless validator.valid?(payment_method)
         fail ArgumentError, "invalid value for \"payment_method\", must be one of #{validator.allowable_values}."
       end

data/lib/ultracart_api/models/order_query.rb

@@ -530,7 +530,7 @@ module UltracartClient
       return false if !@email.nil? && @email.to_s.length > 100
       return false if !@first_name.nil? && @first_name.to_s.length > 30
       return false if !@last_name.nil? && @last_name.to_s.length > 30
-      payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Venmo", "Apple Pay", " Google Pay"])
+      payment_method_validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Venmo", "Apple Pay", " Google Pay", "PayPal Fastlane"])
       return false unless payment_method_validator.valid?(@payment_method)
       return false if !@phone.nil? && @phone.to_s.length > 25
       return false if !@postal_code.nil? && @postal_code.to_s.length > 20
@@ -625,7 +625,7 @@ module UltracartClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_method Object to be assigned
     def payment_method=(payment_method)
-      validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Venmo", "Apple Pay", " Google Pay"])
+      validator = EnumAttributeValidator.new('String', ["Affirm", "Amazon", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Venmo", "Apple Pay", " Google Pay", "PayPal Fastlane"])
       unless validator.valid?(payment_method)
         fail ArgumentError, "invalid value for \"payment_method\", must be one of #{validator.allowable_values}."
       end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.3'
+  VERSION = '4.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.1.5
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus