ultracart_api 3.10.143 → 3.10.145

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc3a07390d1f0e93235e7435d1a8610695d1fffac8392e8dee971b34d7b74900
-  data.tar.gz: e16c57c8156648848e89d5919154796d38bc9c4865d619ac896f118e2aaac1b3
+  metadata.gz: 3b06cffbb7b72a2dc4ab064fc4172d2b9685ec14ffa732712ce24afeb52a8bea
+  data.tar.gz: ad3bf1082daa3968c3f664d06211fe5be02ed28a640ff038d84a84f866e869ed
 SHA512:
-  metadata.gz: 6e63c36d1e3b762b4c555af4d1f68ed6b054380cf4fac8492cbddd3cc962d55487ad19025d3f12f80ab060625c002a32538d959b6b71070d4ebb941a1d1fa5ec
-  data.tar.gz: 42c1d6ccf4a88ea9abcba88c548d23bf1aa894a9cea0ece39b11e00ef472204d842dbb6e84591e7a4f138152053e7b5a1fd47557e52984c94451f06d16f7af1d
+  metadata.gz: 37d7bfe526da0a428bca7f179e4694fc2a5d4f7fac97a6b8971de21ee489f3f281a782ac9debc591f8457f5146c4551f17be99a8b19e537bc4598bda2cda5521
+  data.tar.gz: 04bab7d92531600ca1225fa45ebf3e01518acd6c62a9718147c74ad802d81617611968c989b7d77485f8295a8798b101915f88485b6a25d7accacae62844856e

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.143
+- Package version: 3.10.145
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.10.143.gem
+gem install ./ultracart_api-3.10.145.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.143.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.145.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', '~> 3.10.143'
+    gem 'ultracart_api', '~> 3.10.145'
 
 ### Install from Git
 
@@ -1356,6 +1356,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.145 | 06/20/2023 | coupon add allowed values for usable_by and new OncePerNewCustomerForItem flag |
+| 3.10.144 | 06/15/2023 | add pickup_dts to order.shipping object |
 | 3.10.143 | 06/14/2023 | dw bi: add request_dts on the execute queries request and report data set objects |
 | 3.10.142 | 06/09/2023 | distribution center pickup times |
 | 3.10.141 | 06/08/2023 | customer profile qb tax exempt reason code field |

data/docs/OrderApi.md

@@ -86,7 +86,7 @@ Name | Type | Description  | Notes
 
 
 # **cancel_order**
-> BaseResponse cancel_order(order_id)
+> BaseResponse cancel_order(order_id, opts)
 
 Cancel an order
 
@@ -104,10 +104,14 @@ api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, fa
 
 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 "Exception when calling OrderApi->cancel_order: #{e}"
@@ -119,6 +123,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

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **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] 

data/lib/ultracart_api/api/order_api.rb

@@ -97,6 +97,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 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)
@@ -107,6 +109,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 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, Fixnum, Hash)>] BaseResponse data, response status code and response headers
     def cancel_order_with_http_info(order_id, opts = {})
       if @api_client.config.debugging
@@ -121,6 +125,8 @@ module UltracartClient
 
       # query parameters
       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 = {}

data/lib/ultracart_api/models/coupon.rb

@@ -165,6 +165,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
       {
@@ -627,6 +649,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
@@ -681,13 +705,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

@@ -59,6 +59,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
 
@@ -121,6 +124,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',
@@ -157,6 +161,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',
@@ -245,6 +250,10 @@ module UltracartClient
         self.lift_gate = attributes[:'lift_gate']
       end
 
+      if attributes.has_key?(:'pickup_dts')
+        self.pickup_dts = attributes[:'pickup_dts']
+      end
+
       if attributes.has_key?(:'postal_code')
         self.postal_code = attributes[:'postal_code']
       end
@@ -598,6 +607,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 &&
@@ -624,7 +634,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] 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 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.143'
+  VERSION = '3.10.145'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.143
+  version: 3.10.145
 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