ultracart_api 4.0.161 → 4.0.163

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 494685de448ca7be3aeae8552443e99e60c95ed59103f10e3f75634e068c194d
-  data.tar.gz: 316c79bbdb1518f0ba06543313161ac8e9b01858017a9df219c6c01f9e2a0a6f
+  metadata.gz: 37ac8ecdffea2efc58a7cfed3a3d781196784bce4eb054c1a001aa7e7655889d
+  data.tar.gz: 8c9d4c4c7a5bfc7e3feba016623ae064c05496c628e141714a1ab8a3db868363
 SHA512:
-  metadata.gz: 2d49bac71f6d41b7d1935099ab7f3c3a3cc570348e01b17ce6652d10fd54ef085c41d18c8375492dba1ad69476b71b6a405c7a521a03d42dd19507bd19b05008
-  data.tar.gz: b02ca8e6ba175690c783739b762a9cef6d93982c4ac8a7190b47aa11aa1158bb6d4157f4e9519f1240ca05692308dd163ba9f7f877535fbd3e6fc450d80b48b5
+  metadata.gz: e1cf1043b630a8c1dcddac1c5c3e20905c4bd8e16b4f45c149d311adb3f8d06a4e95376a55ec5d95e5acd27909859dc6f15ccd311e5d9320b92c3c7094173573
+  data.tar.gz: fd803f9f023bbd201108cb7c690bb77d946df4e64e81e43493a5a3961a37d2e17b442ef45fd798a5c27447553491cc02c8d2146eb4c3eb3f6dc6dd3b51b8eea6

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.161
+- Package version: 4.0.163
 - 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.161.gem
+gem install ./ultracart_api-4.0.163.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.161.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.163.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.161'
+    gem 'ultracart_api', '~> 4.0.163'
 
 ### Install from Git
 
@@ -94,6 +94,7 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *UltracartClient::AffiliateApi* | [**get_clicks_by_query**](docs/AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks
 *UltracartClient::AffiliateApi* | [**get_ledgers_by_query**](docs/AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries
+*UltracartClient::AutoOrderApi* | [**establish_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id
 *UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
 *UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
 *UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
@@ -1364,6 +1365,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.163 | 06/20/2023 | auto order - establishAutoOrderByReferenceOrderId method added |
+| 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 |

data/docs/AutoOrderApi.md

@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**establish_auto_order_by_reference_order_id**](AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id |
 | [**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid |
 | [**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code |
 | [**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id |
@@ -14,6 +15,81 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders |
 
 
+## establish_auto_order_by_reference_order_id
+
+> <AutoOrderResponse> establish_auto_order_by_reference_order_id(reference_order_id, opts)
+
+Establish an auto order by referencing a regular order id
+
+Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment. 
+
+### 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)
+reference_order_id = 'reference_order_id_example' # String | The order id to attach this auto order to
+opts = {
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
+}
+
+begin
+  # Establish an auto order by referencing a regular order id
+  result = api_instance.establish_auto_order_by_reference_order_id(reference_order_id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AutoOrderApi->establish_auto_order_by_reference_order_id: #{e}"
+end
+```
+
+#### Using the establish_auto_order_by_reference_order_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AutoOrderResponse>, Integer, Hash)> establish_auto_order_by_reference_order_id_with_http_info(reference_order_id, opts)
+
+```ruby
+begin
+  # Establish an auto order by referencing a regular order id
+  data, status_code, headers = api_instance.establish_auto_order_by_reference_order_id_with_http_info(reference_order_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AutoOrderResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling AutoOrderApi->establish_auto_order_by_reference_order_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reference_order_id** | **String** | The order id to attach this auto order to |  |
+| **_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**: Not defined
+- **Accept**: application/json
+
+
 ## get_auto_order
 
 > <AutoOrderResponse> get_auto_order(auto_order_oid, opts)

data/lib/ultracart_api/api/auto_order_api.rb

@@ -32,6 +32,73 @@ module UltracartClient
       UltracartClient::AutoOrderApi.new(api_client)
     end
 
+    # Establish an auto order by referencing a regular order id
+    # Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment. 
+    # @param reference_order_id [String] The order id to attach this auto order to
+    # @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 establish_auto_order_by_reference_order_id(reference_order_id, opts = {})
+      data, _status_code, _headers = establish_auto_order_by_reference_order_id_with_http_info(reference_order_id, opts)
+      data
+    end
+
+    # Establish an auto order by referencing a regular order id
+    # Establish an auto order by referencing a regular order id.  The result will be an auto order without any items.  You should add the items and perform an update call.  Orders must be less than 60 days old and use a credit card payment. 
+    # @param reference_order_id [String] The order id to attach this auto order to
+    # @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 establish_auto_order_by_reference_order_id_with_http_info(reference_order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutoOrderApi.establish_auto_order_by_reference_order_id ...'
+      end
+      # verify the required parameter 'reference_order_id' is set
+      if @api_client.config.client_side_validation && reference_order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'reference_order_id' when calling AutoOrderApi.establish_auto_order_by_reference_order_id"
+      end
+      # resource path
+      local_var_path = '/auto_order/auto_orders/reference_order_id/{reference_order_id}'.sub('{' + 'reference_order_id' + '}', CGI.escape(reference_order_id.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # 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.establish_auto_order_by_reference_order_id",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutoOrderApi#establish_auto_order_by_reference_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve an auto order by oid
     # Retrieves a single auto order using the specified auto order oid. 
     # @param auto_order_oid [Integer] The auto order oid to retrieve.

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/version.rb

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

metadata

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