ultracart_api 4.1.0 → 4.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d46dfb7ff0455ff0df2aa20ff1e7ff78864bc77f1c62ec6c0fb16aa81bdd86b
-  data.tar.gz: fa003a82c58cf2c1019b358d865389a743044a72ef7073d8f6c8dbcb4a6f4ce9
+  metadata.gz: 2f29e7b81e1b11b67649b35a62e03ccc8f696424ba196d2e57fbded622d45705
+  data.tar.gz: 28d9ac84cb9ee7247598f0dbe1ce76f2d7ba91fa2e141da5784552bc880bd299
 SHA512:
-  metadata.gz: 839904a8688f6a5507831a95a25a16aa83d0b179013a5978e8c85fe5b6cce49f2f20e1e3d451b3afe7808a97f537876c8532d47b14f1246c9100961241b66110
-  data.tar.gz: f5b917a3b63c48d6f42751da7ca55790282c7fc43cdf743e125dfc54511e2328ede5f4d44dd731a343a4ae064cf940015960d609d25f210515e724542cf7881e
+  metadata.gz: e4d72b503dda511e26bc329a76828c9685c0ca0d2876a92370085fe68cacea2aeeceb2de34dbf21ed61ce9301f42e630ec920ddb3297d6cda9ff22370a9e5d29
+  data.tar.gz: 5aaf20d870e64457bbf589e773259bb9999df86b1e56e47c55ffed5fd761c994df39ad2d11036c055b9b29a0000a4d92a3bc7af9a12da8d3c5b253fcf18a1915

data/README.md

@@ -7,9 +7,9 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.0
+- Package version: 4.1.2
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
-For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
+For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
 ## Installation
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.1.0.gem
+gem install ./ultracart_api-4.1.2.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.1.0.gem` to install the development dependencies)
+(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.0'
+    gem 'ultracart_api', '~> 4.1.2'
 
 ### Install from Git
 
@@ -102,6 +102,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::AutoOrderApi* | [**get_auto_orders**](docs/AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
 *UltracartClient::AutoOrderApi* | [**get_auto_orders_batch**](docs/AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
 *UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
+*UltracartClient::AutoOrderApi* | [**pause_auto_order**](docs/AutoOrderApi.md#pause_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid}/pause | Pause auto order
 *UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
 *UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
 *UltracartClient::ChannelPartnerApi* | [**cancel_order_by_channel_partner_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
@@ -1525,6 +1526,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 4.0.245 | 02/20/2025 | automation fix |
 | 4.0.244 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |

data/docs/AutoOrderApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_auto_orders**](AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders |
 | [**get_auto_orders_batch**](AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch |
 | [**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query |
+| [**pause_auto_order**](AutoOrderApi.md#pause_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid}/pause | Pause auto order |
 | [**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order |
 | [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders |
 
@@ -666,6 +667,83 @@ end
 - **Accept**: application/json
 
 
+## pause_auto_order
+
+> <AutoOrderResponse> pause_auto_order(auto_order_oid, auto_order, opts)
+
+Pause auto order
+
+Completely pause an auto order 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+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
+opts = {
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
+}
+
+begin
+  # Pause auto order
+  result = api_instance.pause_auto_order(auto_order_oid, auto_order, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AutoOrderApi->pause_auto_order: #{e}"
+end
+```
+
+#### Using the pause_auto_order_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AutoOrderResponse>, Integer, Hash)> pause_auto_order_with_http_info(auto_order_oid, auto_order, opts)
+
+```ruby
+begin
+  # Pause auto order
+  data, status_code, headers = api_instance.pause_auto_order_with_http_info(auto_order_oid, auto_order, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AutoOrderResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AutoOrderApi->pause_auto_order_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_order_oid** | **Integer** | The auto order oid to pause. |  |
+| **auto_order** | [**AutoOrder**](AutoOrder.md) | Auto orders to pause |  |
+| **_expand** | **String** | The object expansion to perform on the result.  See documentation for examples | [optional] |
+
+### Return type
+
+[**AutoOrderResponse**](AutoOrderResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+
+
 ## update_auto_order
 
 > <AutoOrderResponse> update_auto_order(auto_order_oid, auto_order, opts)

data/docs/ChannelPartnerOrder.md

@@ -96,6 +96,7 @@
 | **tax_exempt** | **Boolean** | If true this order is marked as being tax exempt | [optional] |
 | **transaction** | [**ChannelPartnerOrderTransaction**](ChannelPartnerOrderTransaction.md) |  | [optional] |
 | **treat_warnings_as_errors** | **Boolean** | If true all warnings are considered errors, this is true by default | [optional] |
+| **use_prior_payment_information_from_order_id** | **String** | An Order Id from a prior purchase of this customer which is used to retrieve vaulted payment information in order to pay for this current order. | [optional] |
 
 ## Example
 
@@ -194,7 +195,8 @@ instance = UltracartClient::ChannelPartnerOrder.new(
   tax_county: null,
   tax_exempt: null,
   transaction: null,
-  treat_warnings_as_errors: null
+  treat_warnings_as_errors: null,
+  use_prior_payment_information_from_order_id: null
 )
 ```
 

data/docs/ItemPaymentProcessing.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **block_prepaid** | **Boolean** | True if prepaid cards should be blocked from buying this item | [optional] |
-| **block_refunds** | **Boolean** | True if this item should block any refund attempts | [optional] |
+| **block_refunds** | **Boolean** | True if this item should block any refund attempts, set to false otherwise, null value will not update the field | [optional] |
 | **credit_card_transaction_type** | **String** | Credit card transaction type | [optional] |
 | **no_realtime_charge** | **Boolean** | True if no real-time charge should be performed on this item. | [optional] |
 | **payment_method_validity** | **Array<String>** | Payment method validity | [optional] |

data/docs/OrderCoupon.md

@@ -8,7 +8,7 @@
 | **automatically_applied** | **Boolean** | Whether or not the coupon was automatically applied to the order | [optional] |
 | **base_coupon_code** | **String** | Coupon code configured by the merchant.  Will differ if the customer used a one time coupon code generated off this base coupon | [optional] |
 | **coupon_code** | **String** | Coupon code entered by the customer | [optional] |
-| **hdie_from_customer** | **Boolean** | True if this coupon is hidde from the customer | [optional] |
+| **hdie_from_customer** | **Boolean** | True if this coupon is hide from the customer | [optional] |
 
 ## Example
 

data/lib/ultracart_api/api/auto_order_api.rb

@@ -658,6 +658,84 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # 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 [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [AutoOrderResponse]
+    def pause_auto_order(auto_order_oid, auto_order, opts = {})
+      data, _status_code, _headers = pause_auto_order_with_http_info(auto_order_oid, auto_order, opts)
+      data
+    end
+
+    # 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 [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
+    def pause_auto_order_with_http_info(auto_order_oid, auto_order, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutoOrderApi.pause_auto_order ...'
+      end
+      # verify the required parameter 'auto_order_oid' is set
+      if @api_client.config.client_side_validation && auto_order_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.pause_auto_order"
+      end
+      # verify the required parameter 'auto_order' is set
+      if @api_client.config.client_side_validation && auto_order.nil?
+        fail ArgumentError, "Missing the required parameter 'auto_order' when calling AutoOrderApi.pause_auto_order"
+      end
+      # resource path
+      local_var_path = '/auto_order/auto_orders/{auto_order_oid}/pause'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(auto_order)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AutoOrderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"AutoOrderApi.pause_auto_order",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutoOrderApi#pause_auto_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update an auto order
     # Update an auto order on the UltraCart account. 
     # @param auto_order_oid [Integer] The auto order oid to update.

data/lib/ultracart_api/models/channel_partner_order.rb

@@ -290,6 +290,9 @@ module UltracartClient
     # If true all warnings are considered errors, this is true by default
     attr_accessor :treat_warnings_as_errors
 
+    # An Order Id from a prior purchase of this customer which is used to retrieve vaulted payment information in order to pay for this current order.
+    attr_accessor :use_prior_payment_information_from_order_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -406,7 +409,8 @@ module UltracartClient
         :'tax_county' => :'tax_county',
         :'tax_exempt' => :'tax_exempt',
         :'transaction' => :'transaction',
-        :'treat_warnings_as_errors' => :'treat_warnings_as_errors'
+        :'treat_warnings_as_errors' => :'treat_warnings_as_errors',
+        :'use_prior_payment_information_from_order_id' => :'use_prior_payment_information_from_order_id'
       }
     end
 
@@ -509,7 +513,8 @@ module UltracartClient
         :'tax_county' => :'String',
         :'tax_exempt' => :'Boolean',
         :'transaction' => :'ChannelPartnerOrderTransaction',
-        :'treat_warnings_as_errors' => :'Boolean'
+        :'treat_warnings_as_errors' => :'Boolean',
+        :'use_prior_payment_information_from_order_id' => :'String'
       }
     end
 
@@ -907,6 +912,10 @@ module UltracartClient
       if attributes.key?(:'treat_warnings_as_errors')
         self.treat_warnings_as_errors = attributes[:'treat_warnings_as_errors']
       end
+
+      if attributes.key?(:'use_prior_payment_information_from_order_id')
+        self.use_prior_payment_information_from_order_id = attributes[:'use_prior_payment_information_from_order_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -1609,7 +1618,8 @@ module UltracartClient
           tax_county == o.tax_county &&
           tax_exempt == o.tax_exempt &&
           transaction == o.transaction &&
-          treat_warnings_as_errors == o.treat_warnings_as_errors
+          treat_warnings_as_errors == o.treat_warnings_as_errors &&
+          use_prior_payment_information_from_order_id == o.use_prior_payment_information_from_order_id
     end
 
     # @see the `==` method
@@ -1621,7 +1631,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, echeck_bank_aba_code, echeck_bank_account_name, echeck_bank_account_number, echeck_bank_account_type, echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, storefront_host_name, tax_county, tax_exempt, transaction, treat_warnings_as_errors].hash
+      [advertising_source, affiliate_id, affiliate_sub_id, arbitrary_shipping_handling_total, arbitrary_tax, arbitrary_tax_rate, arbitrary_taxable_subtotal, associate_with_customer_profile_if_present, auto_approve_purchase_order, billto_address1, billto_address2, billto_city, billto_company, billto_country_code, billto_day_phone, billto_evening_phone, billto_first_name, billto_last_name, billto_postal_code, billto_state_region, billto_title, cc_email, channel_partner_order_id, consider_recurring, coupons, credit_card_authorization_amount, credit_card_authorization_dts, credit_card_authorization_number, credit_card_expiration_month, credit_card_expiration_year, credit_card_type, custom_field1, custom_field2, custom_field3, custom_field4, custom_field5, custom_field6, custom_field7, delivery_date, echeck_bank_aba_code, echeck_bank_account_name, echeck_bank_account_number, echeck_bank_account_type, echeck_bank_name, echeck_bank_owner_type, echeck_customer_tax_id, echeck_drivers_license_dob, echeck_drivers_license_number, echeck_drivers_license_state, email, gift, gift_email, gift_message, hosted_fields_card_token, hosted_fields_cvv_token, insurance_application_id, insurance_claim_id, ip_address, items, least_cost_route, least_cost_route_shipping_methods, mailing_list_opt_in, no_realtime_payment_processing, payment_method, purchase_order_number, rotating_transaction_gateway_code, sales_rep_code, screen_branding_theme_code, ship_on_date, ship_to_residential, shipping_method, shipto_address1, shipto_address2, shipto_city, shipto_company, shipto_country_code, shipto_day_phone, shipto_evening_phone, shipto_first_name, shipto_last_name, shipto_postal_code, shipto_state_region, shipto_title, skip_payment_processing, special_instructions, store_completed, store_if_payment_declines, storefront_host_name, tax_county, tax_exempt, transaction, treat_warnings_as_errors, use_prior_payment_information_from_order_id].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/item_payment_processing.rb

@@ -18,7 +18,7 @@ module UltracartClient
     # True if prepaid cards should be blocked from buying this item
     attr_accessor :block_prepaid
 
-    # True if this item should block any refund attempts
+    # True if this item should block any refund attempts, set to false otherwise, null value will not update the field
     attr_accessor :block_refunds
 
     # Credit card transaction type

data/lib/ultracart_api/models/order_coupon.rb

@@ -27,7 +27,7 @@ module UltracartClient
     # Coupon code entered by the customer
     attr_accessor :coupon_code
 
-    # True if this coupon is hidde from the customer
+    # True if this coupon is hide from the customer
     attr_accessor :hdie_from_customer
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/ultracart_api/version.rb

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

metadata

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