ultracart_api 4.0.159 → 4.0.161

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32c10e8031092db9146e98e27f1f5b7ac613f8afb13eb8f7d21e99a6cede8a50
-  data.tar.gz: 6afe8f3708df8311b1dc3fb9f8086d0d7282f90f776f96dacb93e4dd2f3c0070
+  metadata.gz: 494685de448ca7be3aeae8552443e99e60c95ed59103f10e3f75634e068c194d
+  data.tar.gz: 316c79bbdb1518f0ba06543313161ac8e9b01858017a9df219c6c01f9e2a0a6f
 SHA512:
-  metadata.gz: 5d76074d28e87d85923f27c428885ca34545d670a69943cac5c219d5aca46e5d439c9a0d42dfab672055e2fd758e0e98e2bc658a009774c7e67fb59776411e3d
-  data.tar.gz: d866107834e43a6e10a57c3b65ea5747f700b41620729e63781d8fc9d612d6f9da3a9285377ec8c9678aba65324fdc5d69365802c7d3262e5375e2cfd05d3513
+  metadata.gz: 2d49bac71f6d41b7d1935099ab7f3c3a3cc570348e01b17ce6652d10fd54ef085c41d18c8375492dba1ad69476b71b6a405c7a521a03d42dd19507bd19b05008
+  data.tar.gz: b02ca8e6ba175690c783739b762a9cef6d93982c4ac8a7190b47aa11aa1158bb6d4157f4e9519f1240ca05692308dd163ba9f7f877535fbd3e6fc450d80b48b5

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.159
+- Package version: 4.0.161
 - 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.159.gem
+gem install ./ultracart_api-4.0.161.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.159.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.161.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.159'
+    gem 'ultracart_api', '~> 4.0.161'
 
 ### Install from Git
 
@@ -1364,6 +1364,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 4.0.157 | 06/06/2023 | auto order add_ons |

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/docs/ReportDataSet.md

@@ -16,6 +16,7 @@
 | **merchant_id** | **String** | Merchant that owns this data set | [optional] |
 | **page_count** | **Integer** | The total number of pages in the result set | [optional] |
 | **page_size** | **Integer** | The size of the pages | [optional] |
+| **request_dts** | **String** | Date/Time of the client submitted the request.  Can be used to resolve out of order query completion results | [optional] |
 | **schema** | [**Array<ReportDataSetSchema>**](ReportDataSetSchema.md) | The schema associated with the data set. | [optional] |
 | **security_level** | **String** | Security level this dataset was read from. | [optional] |
 | **timezone** | **String** |  | [optional] |
@@ -39,6 +40,7 @@ instance = UltracartClient::ReportDataSet.new(
   merchant_id: null,
   page_count: null,
   page_size: null,
+  request_dts: null,
   schema: null,
   security_level: null,
   timezone: null,

data/docs/ReportExecuteQueriesRequest.md

@@ -10,6 +10,7 @@
 | **default_project_id** | **String** |  | [optional] |
 | **merchant_id** | **String** |  | [optional] |
 | **queries** | [**Array<ReportDataSetQuery>**](ReportDataSetQuery.md) | An array of queries that we want the lambda function to execute. | [optional] |
+| **request_dts** | **String** | Date/Time of the client submitted the request.  Can be used to resolve out of order query completion results | [optional] |
 | **security_level** | **String** | Security level to execute report under | [optional] |
 
 ## Example
@@ -24,6 +25,7 @@ instance = UltracartClient::ReportExecuteQueriesRequest.new(
   default_project_id: null,
   merchant_id: null,
   queries: null,
+  request_dts: null,
   security_level: 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/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/models/report_data_set.rb

@@ -50,6 +50,9 @@ module UltracartClient
     # The size of the pages
     attr_accessor :page_size
 
+    # Date/Time of the client submitted the request.  Can be used to resolve out of order query completion results
+    attr_accessor :request_dts
+
     # The schema associated with the data set.
     attr_accessor :schema
 
@@ -98,6 +101,7 @@ module UltracartClient
         :'merchant_id' => :'merchant_id',
         :'page_count' => :'page_count',
         :'page_size' => :'page_size',
+        :'request_dts' => :'request_dts',
         :'schema' => :'schema',
         :'security_level' => :'security_level',
         :'timezone' => :'timezone',
@@ -125,6 +129,7 @@ module UltracartClient
         :'merchant_id' => :'String',
         :'page_count' => :'Integer',
         :'page_size' => :'Integer',
+        :'request_dts' => :'String',
         :'schema' => :'Array<ReportDataSetSchema>',
         :'security_level' => :'String',
         :'timezone' => :'String',
@@ -203,6 +208,10 @@ module UltracartClient
         self.page_size = attributes[:'page_size']
       end
 
+      if attributes.key?(:'request_dts')
+        self.request_dts = attributes[:'request_dts']
+      end
+
       if attributes.key?(:'schema')
         if (value = attributes[:'schema']).is_a?(Array)
           self.schema = value
@@ -264,6 +273,7 @@ module UltracartClient
           merchant_id == o.merchant_id &&
           page_count == o.page_count &&
           page_size == o.page_size &&
+          request_dts == o.request_dts &&
           schema == o.schema &&
           security_level == o.security_level &&
           timezone == o.timezone &&
@@ -279,7 +289,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [data_set_query_uuid, data_set_uuid, destination_table_id, error_message, executed_sql, for_object_id, for_object_type, initial_pages, max_results, merchant_id, page_count, page_size, schema, security_level, timezone, user_data].hash
+      [data_set_query_uuid, data_set_uuid, destination_table_id, error_message, executed_sql, for_object_id, for_object_type, initial_pages, max_results, merchant_id, page_count, page_size, request_dts, schema, security_level, timezone, user_data].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/report_execute_queries_request.rb

@@ -30,6 +30,9 @@ module UltracartClient
     # An array of queries that we want the lambda function to execute.
     attr_accessor :queries
 
+    # Date/Time of the client submitted the request.  Can be used to resolve out of order query completion results
+    attr_accessor :request_dts
+
     # Security level to execute report under
     attr_accessor :security_level
 
@@ -64,6 +67,7 @@ module UltracartClient
         :'default_project_id' => :'default_project_id',
         :'merchant_id' => :'merchant_id',
         :'queries' => :'queries',
+        :'request_dts' => :'request_dts',
         :'security_level' => :'security_level'
       }
     end
@@ -82,6 +86,7 @@ module UltracartClient
         :'default_project_id' => :'String',
         :'merchant_id' => :'String',
         :'queries' => :'Array<ReportDataSetQuery>',
+        :'request_dts' => :'String',
         :'security_level' => :'String'
       }
     end
@@ -133,6 +138,10 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'request_dts')
+        self.request_dts = attributes[:'request_dts']
+      end
+
       if attributes.key?(:'security_level')
         self.security_level = attributes[:'security_level']
       end
@@ -174,6 +183,7 @@ module UltracartClient
           default_project_id == o.default_project_id &&
           merchant_id == o.merchant_id &&
           queries == o.queries &&
+          request_dts == o.request_dts &&
           security_level == o.security_level
     end
 
@@ -186,7 +196,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [client_uuid, connection_id, default_dataset_id, default_project_id, merchant_id, queries, security_level].hash
+      [client_uuid, connection_id, default_dataset_id, default_project_id, merchant_id, queries, request_dts, security_level].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.159'
+  VERSION = '4.0.161'
 end

metadata

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