ultracart_api 4.1.2 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f29e7b81e1b11b67649b35a62e03ccc8f696424ba196d2e57fbded622d45705
-  data.tar.gz: 28d9ac84cb9ee7247598f0dbe1ce76f2d7ba91fa2e141da5784552bc880bd299
+  metadata.gz: 7f73cdbb14f7434757e125f441e7177359ed026f60e7289828d3140794743701
+  data.tar.gz: 6749494d14fd1bce606f95c178229622137981d48b2448ea2db11c044a7adb43
 SHA512:
-  metadata.gz: e4d72b503dda511e26bc329a76828c9685c0ca0d2876a92370085fe68cacea2aeeceb2de34dbf21ed61ce9301f42e630ec920ddb3297d6cda9ff22370a9e5d29
-  data.tar.gz: 5aaf20d870e64457bbf589e773259bb9999df86b1e56e47c55ffed5fd761c994df39ad2d11036c055b9b29a0000a4d92a3bc7af9a12da8d3c5b253fcf18a1915
+  metadata.gz: a35199b5568393b6f8e69353771dbc1cc9fbfbe300b1bf281106c7b36636a48b38f97f3f7e1582a57b501bfd16ede57f85ba8b6cdbc0907df3f6298a2573d1e6
+  data.tar.gz: 8603ec97f9a44dc3e15f5d2442e46f734b65785be3d3eea59685ca4cdb1e140034b3345b640c11ddbed7c2a16626aa36d29f2f334b4fd00f8cd874426e9af4da

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.2
+- Package version: 4.1.4
 - 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.4'
 ```
 
-Then either install the gem locally:
+install:
 
 ```shell
-gem install ./ultracart_api-4.1.2.gem
-```
-
-(for development, run `gem install --dev ./ultracart_api-4.1.2.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.2'
-
-### 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.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 |
 | 4.1.0 | 02/21/2025 | ItemApi.getInventorySnapshot had bad nickname causing bad sdk method name |

data/docs/AutoOrderApi.md

@@ -690,7 +690,7 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
 
 api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
 auto_order_oid = 56 # Integer | The auto order oid to pause.
-auto_order = UltracartClient::AutoOrder.new # AutoOrder | Auto orders to pause
+auto_order = UltracartClient::AutoOrder.new # AutoOrder | Auto order to pause
 opts = {
   _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
 }
@@ -727,7 +727,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **auto_order_oid** | **Integer** | The auto order oid to pause. |  |
-| **auto_order** | [**AutoOrder**](AutoOrder.md) | Auto orders to pause |  |
+| **auto_order** | [**AutoOrder**](AutoOrder.md) | Auto order to pause |  |
 | **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
 
 ### Return type

data/lib/ultracart_api/api/auto_order_api.rb

@@ -661,7 +661,7 @@ module UltracartClient
     # Pause auto order
     # Completely pause an auto order 
     # @param auto_order_oid [Integer] The auto order oid to pause.
-    # @param auto_order [AutoOrder] Auto orders to pause
+    # @param auto_order [AutoOrder] Auto order to pause
     # @param [Hash] opts the optional parameters
     # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
     # @return [AutoOrderResponse]
@@ -673,7 +673,7 @@ module UltracartClient
     # Pause auto order
     # Completely pause an auto order 
     # @param auto_order_oid [Integer] The auto order oid to pause.
-    # @param auto_order [AutoOrder] Auto orders to pause
+    # @param auto_order [AutoOrder] Auto order to pause
     # @param [Hash] opts the optional parameters
     # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
     # @return [Array<(AutoOrderResponse, Integer, Hash)>] AutoOrderResponse data, response status code and response headers

data/lib/ultracart_api/version.rb

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

metadata

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