ultracart_api 3.10.64 → 3.10.65

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e74b7dd569e12d9dc2fa15dab34cc3c7a51e0def27215ae4db499b3ded4d449f
-  data.tar.gz: f25d0248fbbc32b8f176d02bd6ab7c903e79b59e8c2bd21dd21a6701ae85d952
+  metadata.gz: c40eeee0e52a4048d5da0be9aa0bf8e3ed8081125900ef7c548e1f3b7f85a76d
+  data.tar.gz: 13968b964e8cbbca5846a9aacda47607c4d2fde6d2b84885686275fb480bdaa8
 SHA512:
-  metadata.gz: 8b5cc4db4e89400fd95e036f4aad16c948fdc953715cca0dce887b29d9abffad7cf5a108587b60a34d5b86172110fb685fbd6f4de6be69b3b72869df2514c379
-  data.tar.gz: a362be05c9cb761584cac40b19d872b9931b9309c91f1a65443db277d6a6903e3247c700130a140e18b70d5bc50453be91cf5a90b5b22b01c0425211ba9aac2c
+  metadata.gz: a1d8a223749f59285baef7781831359d02247c9d29fcf08b66698658c61be51c52da8b66ff8444108c823ee52b0d0aa460d2993c27b0529bfe1eb4fd07ac3ffd
+  data.tar.gz: 347be067a1bab1af80f91b120e5f7c9e569170643458b66e5b8661c629096e772d91676f3d3b9ae574ef6d12b60369d0458cca3e4c3c82c6a48bfff2773b077f

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.64
+- Package version: 3.10.65
 - 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.64.gem
+gem install ./ultracart_api-3.10.65.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.64.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.65.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.64'
+    gem 'ultracart_api', '~> 3.10.65'
 
 ### Install from Git
 
@@ -227,6 +227,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
@@ -1003,6 +1004,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)
@@ -1213,6 +1215,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.65 | 11/15/2022 | order api new method is order refundable |
 | 3.10.64 | 11/15/2022 | increase order property length to 10k char |
 | 3.10.63 | 11/14/2022 | conversations - add allowed values for update agent status |
 | 3.10.62 | 11/09/2022 | conversations - add an enum of event typing |

data/docs/OrderApi.md

@@ -20,6 +20,7 @@ Method | HTTP request | Description
 [**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
@@ -926,6 +927,56 @@ Name | Type | Description  | Notes
 
 
 
+# **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 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+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 "Exception when calling OrderApi->is_refundable_order: #{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**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **process_payment**
 > OrderProcessPaymentResponse process_payment(order_id, process_payment_request)
 

data/docs/OrderRefundableResponse.md

@@ -0,0 +1,12 @@
+# 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] 
+
+

data/lib/ultracart_api/api/order_api.rb

@@ -1037,6 +1037,61 @@ module UltracartClient
       end
       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 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 The order id to check for refundable order.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderRefundableResponse, Fixnum, 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' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrderRefundableResponse')
+      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 The order id to process payment on

data/lib/ultracart_api/models/order_refundable_response.rb

@@ -0,0 +1,222 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+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
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'refundable' => :'BOOLEAN',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'refundable')
+        self.refundable = attributes[:'refundable']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_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 [Fixnum] 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 build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.10.64'
+  VERSION = '3.10.65'
 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: 3.10.64
+  version: 3.10.65
 platform: ruby
 authors:
 - UltraCart
@@ -777,6 +777,7 @@ files:
 - docs/OrderQuery.md
 - docs/OrderQueryBatch.md
 - docs/OrderQuote.md
+- docs/OrderRefundableResponse.md
 - docs/OrderReplacement.md
 - docs/OrderReplacementItem.md
 - docs/OrderReplacementResponse.md
@@ -1488,6 +1489,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