ultracart_api 4.0.81.rc → 4.0.82.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0106ff3c40b622a61a22a557c044729aa07aa82fa9d5a96e3ae3f0ebd8fc383
-  data.tar.gz: 25818287b327abf1f7346ea5e665c07285167a88b22e1c7edd51ba9db1cf4161
+  metadata.gz: 4603d18781a538d380b6f59b637aacb9c0e296572050e353fbf2da40a020ea5f
+  data.tar.gz: 1e9415dbe9f78ec22cba8719ce07e19818cd430fafe656ea4aa12d2a38bc90d9
 SHA512:
-  metadata.gz: d0f0916fb5621b603d6184c9ce4644a29f4617489647de7df2471c115bb4c8ca892f079e3e2d0838ebc0eb124050f004cb32616605746c5ece357feaf2421d19
-  data.tar.gz: e0f8f2f2c525b91485e44453a10aba86b5f7f2dd33bf022ee4a796cee6e1166d09b8c15f22b27a93b65c0bc70e11672876166b1d0ae484ccf02e52ee0b9062d4
+  metadata.gz: a7561e75a1d8b0acf91aa8764efd3992517f30e8c18fce379a7d3e7f454371580c5b087c593c8c43de7bdcf420dfc5141607aa358b5928c19a7213f43f95dc31
+  data.tar.gz: 9c5df587e925a0cc15d8a1ecf9ed82116de0f334cb2db761058f9b0d1355b01a0d19d163f885de9229608c8994b995300d6b0c6fb989dd65638ee8aab9ff3658

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.81.rc
+- Package version: 4.0.82.rc
 - 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.81.rc.gem
+gem install ./ultracart_api-4.0.82.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.81.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.82.rc.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.81.rc'
+    gem 'ultracart_api', '~> 4.0.82.rc'
 
 ### Install from Git
 
@@ -233,6 +233,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
 *UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
 *UltracartClient::OrderApi* | [**insert_order**](docs/OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
+*UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
 *UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
 *UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
 *UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
@@ -1009,6 +1010,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderQuery](docs/OrderQuery.md)
  - [UltracartClient::OrderQueryBatch](docs/OrderQueryBatch.md)
  - [UltracartClient::OrderQuote](docs/OrderQuote.md)
+ - [UltracartClient::OrderRefundableResponse](docs/OrderRefundableResponse.md)
  - [UltracartClient::OrderReplacement](docs/OrderReplacement.md)
  - [UltracartClient::OrderReplacementItem](docs/OrderReplacementItem.md)
  - [UltracartClient::OrderReplacementResponse](docs/OrderReplacementResponse.md)
@@ -1222,6 +1224,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.82-RC | 11/15/2022 | order api new method is order refundable |
 | 4.0.81-RC | 11/15/2022 | increase order property length to 10k char |
 | 4.0.80-RC | 11/14/2022 | conversations - add allowed values for update agent status |
 | 4.0.79-RC | 11/09/2022 | conversations - add an enum of event typing |

data/docs/OrderApi.md

@@ -20,6 +20,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch |
 | [**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query |
 | [**insert_order**](OrderApi.md#insert_order) | **POST** /order/orders | Insert an order |
+| [**is_refundable_order**](OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded |
 | [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment |
 | [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order |
 | [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order |
@@ -1263,6 +1264,77 @@ end
 - **Accept**: application/json
 
 
+## is_refundable_order
+
+> <OrderRefundableResponse> is_refundable_order(order_id)
+
+Determine if an order can be refunded
+
+Determine if an order can be refunded based upon payment method and age 
+
+### 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::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+order_id = 'order_id_example' # String | The order id to check for refundable order.
+
+begin
+  # Determine if an order can be refunded
+  result = api_instance.is_refundable_order(order_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->is_refundable_order: #{e}"
+end
+```
+
+#### Using the is_refundable_order_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrderRefundableResponse>, Integer, Hash)> is_refundable_order_with_http_info(order_id)
+
+```ruby
+begin
+  # Determine if an order can be refunded
+  data, status_code, headers = api_instance.is_refundable_order_with_http_info(order_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrderRefundableResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->is_refundable_order_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | The order id to check for refundable order. |  |
+
+### Return type
+
+[**OrderRefundableResponse**](OrderRefundableResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## process_payment
 
 > <OrderProcessPaymentResponse> process_payment(order_id, process_payment_request)

data/docs/OrderRefundableResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::OrderRefundableResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **refundable** | **Boolean** | Whether the order is refundable or not. | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderRefundableResponse.new(
+  error: null,
+  metadata: null,
+  refundable: null,
+  success: null,
+  warning: null
+)
+```
+

data/lib/ultracart_api/api/order_api.rb

@@ -1207,6 +1207,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Determine if an order can be refunded
+    # Determine if an order can be refunded based upon payment method and age 
+    # @param order_id [String] The order id to check for refundable order.
+    # @param [Hash] opts the optional parameters
+    # @return [OrderRefundableResponse]
+    def is_refundable_order(order_id, opts = {})
+      data, _status_code, _headers = is_refundable_order_with_http_info(order_id, opts)
+      data
+    end
+
+    # Determine if an order can be refunded
+    # Determine if an order can be refunded based upon payment method and age 
+    # @param order_id [String] The order id to check for refundable order.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderRefundableResponse, Integer, Hash)>] OrderRefundableResponse data, response status code and response headers
+    def is_refundable_order_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.is_refundable_order ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.is_refundable_order"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/refundable'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || 'OrderRefundableResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.is_refundable_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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#is_refundable_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Process payment
     # Process payment on order 
     # @param order_id [String] The order id to process payment on

data/lib/ultracart_api/models/order_refundable_response.rb

@@ -0,0 +1,257 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class OrderRefundableResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Whether the order is refundable or not.
+    attr_accessor :refundable
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'refundable' => :'refundable',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'refundable' => :'Boolean',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::OrderRefundableResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::OrderRefundableResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'refundable')
+        self.refundable = attributes[:'refundable']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          error == o.error &&
+          metadata == o.metadata &&
+          refundable == o.refundable &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [error, metadata, refundable, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.81.rc'
+  VERSION = '4.0.82.rc'
 end

data/lib/ultracart_api.rb

@@ -559,6 +559,7 @@ require 'ultracart_api/models/order_property'
 require 'ultracart_api/models/order_query'
 require 'ultracart_api/models/order_query_batch'
 require 'ultracart_api/models/order_quote'
+require 'ultracart_api/models/order_refundable_response'
 require 'ultracart_api/models/order_replacement'
 require 'ultracart_api/models/order_replacement_item'
 require 'ultracart_api/models/order_replacement_response'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.81.rc
+  version: 4.0.82.rc
 platform: ruby
 authors:
 - UltraCart
@@ -617,6 +617,7 @@ files:
 - docs/OrderQuery.md
 - docs/OrderQueryBatch.md
 - docs/OrderQuote.md
+- docs/OrderRefundableResponse.md
 - docs/OrderReplacement.md
 - docs/OrderReplacementItem.md
 - docs/OrderReplacementResponse.md
@@ -1328,6 +1329,7 @@ files:
 - lib/ultracart_api/models/order_query.rb
 - lib/ultracart_api/models/order_query_batch.rb
 - lib/ultracart_api/models/order_quote.rb
+- lib/ultracart_api/models/order_refundable_response.rb
 - lib/ultracart_api/models/order_replacement.rb
 - lib/ultracart_api/models/order_replacement_item.rb
 - lib/ultracart_api/models/order_replacement_response.rb