ultracart_api 4.0.160 → 4.0.162

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f45606430c58ef6679714d20c35600fc53b3149fb612400b9c67f994a9581ea
-  data.tar.gz: ceee466218b3cae7b4e2485e6736d0f0fb6c10bc7e0cb683a9473bd824a330e4
+  metadata.gz: 4edfbbc263a0b6f8b853a70d46ca9cacf88f4952b6b23263f93c438a84e39e48
+  data.tar.gz: 4633d63b98a6b6b36049d822a0a359e7b249c6a26fe3406e102ae0ffe84c8a2b
 SHA512:
-  metadata.gz: 44940d61428dd6b759f90d1a23bb8e8b53d53c64f77487f1647595ade727d797f1230c490029d2079a55e3c1c22f31178171f7f1a405be44f8ad27622bc2f079
-  data.tar.gz: 9d1ec78fc7270f567f1420bdce4928fec44cd626baf1916af327e66e747c9b2f7582642bd70d8429b9c15329508539662c2cc44157269669b4460053f2e8a23a
+  metadata.gz: d1c69e1d5766cb7a9fd7957eb2b29a366fabcd4ff2146f36877b0948c76b5bcc9e9162b0281d234555374982b32a8f5e0f95c0925205cddfbedd27e209102491
+  data.tar.gz: 89f74cdf55ffcb5cba3be20f5a3848d8a95e0c8337e5e1f4ef55a100498e401d237e7f1018f891d5fb5f032cbbbfb1e4e9a019045b10d437bcd28785eb08b14c

data/README.md

@@ -7,7 +7,7 @@ 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.0.160
+- Package version: 4.0.162
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.160.gem
+gem install ./ultracart_api-4.0.162.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.160.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.162.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.0.160'
+    gem 'ultracart_api', '~> 4.0.162'
 
 ### Install from Git
 
@@ -1364,6 +1364,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.162 | 06/20/2023 | coupon add allowed values for usable_by and new OncePerNewCustomerForItem flag |
+| 4.0.161 | 06/15/2023 | add pickup_dts to order.shipping object |
 | 4.0.160 | 06/14/2023 | dw bi: add request_dts on the execute queries request and report data set objects |
 | 4.0.159 | 06/09/2023 | distribution center pickup times |
 | 4.0.158 | 06/08/2023 | customer profile qb tax exempt reason code field |

data/docs/OrderApi.md

@@ -107,7 +107,7 @@ end
 
 ## cancel_order
 
-> <BaseResponse> cancel_order(order_id)
+> <BaseResponse> cancel_order(order_id, opts)
 
 Cancel an order
 
@@ -128,10 +128,14 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
 
 api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
 order_id = 'order_id_example' # String | The order id to cancel.
+opts = {
+  lock_self_ship_orders: true, # Boolean | Flag to prevent a order shipping during a refund process
+  skip_refund_and_hold: true # Boolean | Skip refund and move order to Held Orders department
+}
 
 begin
   # Cancel an order
-  result = api_instance.cancel_order(order_id)
+  result = api_instance.cancel_order(order_id, opts)
   p result
 rescue UltracartClient::ApiError => e
   puts "Error when calling OrderApi->cancel_order: #{e}"
@@ -142,12 +146,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<BaseResponse>, Integer, Hash)> cancel_order_with_http_info(order_id)
+> <Array(<BaseResponse>, Integer, Hash)> cancel_order_with_http_info(order_id, opts)
 
 ```ruby
 begin
   # Cancel an order
-  data, status_code, headers = api_instance.cancel_order_with_http_info(order_id)
+  data, status_code, headers = api_instance.cancel_order_with_http_info(order_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <BaseResponse>
@@ -161,6 +165,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **order_id** | **String** | The order id to cancel. |  |
+| **lock_self_ship_orders** | **Boolean** | Flag to prevent a order shipping during a refund process | [optional] |
+| **skip_refund_and_hold** | **Boolean** | Skip refund and move order to Held Orders department | [optional] |
 
 ### Return type
 

data/docs/OrderShipping.md

@@ -19,6 +19,7 @@
 | **least_cost_route** | **Boolean** | If true, instructs UltraCart to apply the cheapest shipping method to this order.  Used only for channel partner order inserts. | [optional] |
 | **least_cost_route_shipping_methods** | **Array<String>** | List of shipping methods to consider if least_code_route is true. Used only for channel parter order inserts. | [optional] |
 | **lift_gate** | **Boolean** | Lift gate requested (LTL shipping methods only) | [optional] |
+| **pickup_dts** | **String** | Date/time the order should be picked up locally. | [optional] |
 | **postal_code** | **String** | Postal code | [optional] |
 | **rma** | **String** | RMA number | [optional] |
 | **ship_on_date** | **String** | Date the customer is requesting that the order ship on.  Typically used for perishable product delivery. | [optional] |
@@ -56,6 +57,7 @@ instance = UltracartClient::OrderShipping.new(
   least_cost_route: null,
   least_cost_route_shipping_methods: null,
   lift_gate: null,
+  pickup_dts: null,
   postal_code: null,
   rma: null,
   ship_on_date: null,

data/lib/ultracart_api/api/order_api.rb

@@ -106,6 +106,8 @@ module UltracartClient
     # Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed. 
     # @param order_id [String] The order id to cancel.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :lock_self_ship_orders Flag to prevent a order shipping during a refund process
+    # @option opts [Boolean] :skip_refund_and_hold Skip refund and move order to Held Orders department
     # @return [BaseResponse]
     def cancel_order(order_id, opts = {})
       data, _status_code, _headers = cancel_order_with_http_info(order_id, opts)
@@ -116,6 +118,8 @@ module UltracartClient
     # Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed. 
     # @param order_id [String] The order id to cancel.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :lock_self_ship_orders Flag to prevent a order shipping during a refund process
+    # @option opts [Boolean] :skip_refund_and_hold Skip refund and move order to Held Orders department
     # @return [Array<(BaseResponse, Integer, Hash)>] BaseResponse data, response status code and response headers
     def cancel_order_with_http_info(order_id, opts = {})
       if @api_client.config.debugging
@@ -130,6 +134,8 @@ module UltracartClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'lock_self_ship_orders'] = opts[:'lock_self_ship_orders'] if !opts[:'lock_self_ship_orders'].nil?
+      query_params[:'skip_refund_and_hold'] = opts[:'skip_refund_and_hold'] if !opts[:'skip_refund_and_hold'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/ultracart_api/models/coupon.rb

@@ -166,6 +166,28 @@ module UltracartClient
     # Who may use this coupon.
     attr_accessor :usable_by
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -646,6 +668,8 @@ module UltracartClient
       return false if !@merchant_code.nil? && @merchant_code.to_s.length > 20
       return false if !@merchant_notes.nil? && @merchant_notes.to_s.length > 250
       return false if !@quickbooks_code.nil? && @quickbooks_code.to_s.length > 20
+      usable_by_validator = EnumAttributeValidator.new('String', ["Anyone", "UniqueCode", "OncePerCustomer", "OncePerNewCustomer", "OncePerNewCustomerForItem"])
+      return false unless usable_by_validator.valid?(@usable_by)
       return false if !@usable_by.nil? && @usable_by.to_s.length > 50
       true
     end
@@ -700,13 +724,13 @@ module UltracartClient
       @quickbooks_code = quickbooks_code
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] usable_by Value to be assigned
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] usable_by Object to be assigned
     def usable_by=(usable_by)
-      if !usable_by.nil? && usable_by.to_s.length > 50
-        fail ArgumentError, 'invalid value for "usable_by", the character length must be smaller than or equal to 50.'
+      validator = EnumAttributeValidator.new('String', ["Anyone", "UniqueCode", "OncePerCustomer", "OncePerNewCustomer", "OncePerNewCustomerForItem"])
+      unless validator.valid?(usable_by)
+        fail ArgumentError, "invalid value for \"usable_by\", must be one of #{validator.allowable_values}."
       end
-
       @usable_by = usable_by
     end
 

data/lib/ultracart_api/models/order_shipping.rb

@@ -60,6 +60,9 @@ module UltracartClient
     # Lift gate requested (LTL shipping methods only)
     attr_accessor :lift_gate
 
+    # Date/time the order should be picked up locally.
+    attr_accessor :pickup_dts
+
     # Postal code
     attr_accessor :postal_code
 
@@ -122,6 +125,7 @@ module UltracartClient
         :'least_cost_route' => :'least_cost_route',
         :'least_cost_route_shipping_methods' => :'least_cost_route_shipping_methods',
         :'lift_gate' => :'lift_gate',
+        :'pickup_dts' => :'pickup_dts',
         :'postal_code' => :'postal_code',
         :'rma' => :'rma',
         :'ship_on_date' => :'ship_on_date',
@@ -163,6 +167,7 @@ module UltracartClient
         :'least_cost_route' => :'Boolean',
         :'least_cost_route_shipping_methods' => :'Array<String>',
         :'lift_gate' => :'Boolean',
+        :'pickup_dts' => :'String',
         :'postal_code' => :'String',
         :'rma' => :'String',
         :'ship_on_date' => :'String',
@@ -264,6 +269,10 @@ module UltracartClient
         self.lift_gate = attributes[:'lift_gate']
       end
 
+      if attributes.key?(:'pickup_dts')
+        self.pickup_dts = attributes[:'pickup_dts']
+      end
+
       if attributes.key?(:'postal_code')
         self.postal_code = attributes[:'postal_code']
       end
@@ -617,6 +626,7 @@ module UltracartClient
           least_cost_route == o.least_cost_route &&
           least_cost_route_shipping_methods == o.least_cost_route_shipping_methods &&
           lift_gate == o.lift_gate &&
+          pickup_dts == o.pickup_dts &&
           postal_code == o.postal_code &&
           rma == o.rma &&
           ship_on_date == o.ship_on_date &&
@@ -643,7 +653,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [address1, address2, city, company, country_code, day_phone, day_phone_e164, delivery_date, evening_phone, evening_phone_e164, first_name, last_name, least_cost_route, least_cost_route_shipping_methods, lift_gate, postal_code, rma, ship_on_date, ship_to_residential, shipping_3rd_party_account_number, shipping_date, shipping_department_status, shipping_method, shipping_method_accounting_code, special_instructions, state_region, title, tracking_number_details, tracking_numbers, weight].hash
+      [address1, address2, city, company, country_code, day_phone, day_phone_e164, delivery_date, evening_phone, evening_phone_e164, first_name, last_name, least_cost_route, least_cost_route_shipping_methods, lift_gate, pickup_dts, postal_code, rma, ship_on_date, ship_to_residential, shipping_3rd_party_account_number, shipping_date, shipping_department_status, shipping_method, shipping_method_accounting_code, special_instructions, state_region, title, tracking_number_details, tracking_numbers, weight].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.160
+  version: 4.0.162
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus