ultracart_api 3.10.117 → 3.10.119

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71b0716875e7af220fb4cc7c7947a56bb79b94ca73912d5cb4e54db849dc1e2e
-  data.tar.gz: 94b60f5189f9cbe2732a1dbf3c2898166f65ba6c1d2b3635fc5d639f426ccc5a
+  metadata.gz: 5b2632cb45c345d2423a388b3b6b937211914e8d4a96be721503d470ff857e0f
+  data.tar.gz: c9fb31bc8611b4774323653157a13bd436e120cf1c69e3c4a72cf156b915ad4b
 SHA512:
-  metadata.gz: 3e7d176a0218045ae99510053bc81dc45ae0e33d8e95eaa24a10e2b802fbd1a245527ba5d62b02a05c92df0fd08cdfccda6e07b2ccd9dfbef9546e0f16a94e82
-  data.tar.gz: eab6d75bf58443eeface15ef99037e5728a0cb6483363b43a63dbc08054369140db677085a5870f213939a05129a19cb9719dc444afc0ab14e90421b5ca7b264
+  metadata.gz: 852716c1539873a1c5fd40ea0c198d81daa3f9d8cc9597645e2e07ca4cc3b1ed700e495079dd80106f8a2b5f65c5820559e86c87b1b097d40d6e84e0f587ef0d
+  data.tar.gz: 7acd76691d0e603839147056319e1805adc9a33ed9d351270e2987c7faf4dfed38ce17237349f501ff2272fd1863e3ddf67ea846721dec89860dbb508f6600ae

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.117
+- Package version: 3.10.119
 - 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.117.gem
+gem install ./ultracart_api-3.10.119.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.10.117.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.10.119.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.117'
+    gem 'ultracart_api', '~> 3.10.119'
 
 ### Install from Git
 
@@ -159,6 +159,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
 *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 *UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
+*UltracartClient::ConversationApi* | [**sms_unsubscribe_conversation**](docs/ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
 *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 *UltracartClient::ConversationApi* | [**update_agent_profile**](docs/ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
 *UltracartClient::ConversationApi* | [**update_conversation_canned_message**](docs/ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
@@ -1085,6 +1086,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderQuery](docs/OrderQuery.md)
  - [UltracartClient::OrderQueryBatch](docs/OrderQueryBatch.md)
  - [UltracartClient::OrderQuote](docs/OrderQuote.md)
+ - [UltracartClient::OrderReason](docs/OrderReason.md)
  - [UltracartClient::OrderRefundableResponse](docs/OrderRefundableResponse.md)
  - [UltracartClient::OrderReplacement](docs/OrderReplacement.md)
  - [UltracartClient::OrderReplacementItem](docs/OrderReplacementItem.md)
@@ -1301,6 +1303,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.119 | 02/20/2023 | refund reasons |
+| 3.10.118 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
 | 3.10.117 | 02/15/2023 | added auto order sorting by next_shipment_dts |
 | 3.10.116 | 02/10/2023 | convo - add storefront_host_name to search request |
 | 3.10.115 | 02/07/2023 | convo - new event for when a customer joins a queue |

data/docs/ConversationApi.md

@@ -32,6 +32,7 @@ Method | HTTP request | Description
 [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
 [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
 [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
+[**sms_unsubscribe_conversation**](ConversationApi.md#sms_unsubscribe_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/sms_unsubscribe | Unsubscribe any SMS participants in this conversation
 [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
 [**update_agent_profile**](ConversationApi.md#update_agent_profile) | **PUT** /conversation/agent/profile | Update agent profile
 [**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
@@ -1405,6 +1406,55 @@ Name | Type | Description  | Notes
 
 
 
+# **sms_unsubscribe_conversation**
+> sms_unsubscribe_conversation(conversation_uuid)
+
+Unsubscribe any SMS participants in this conversation
+
+Unsubscribe any SMS participants in this conversation 
+
+### 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::ConversationApi.new_using_api_key(simple_key, false, false)
+
+
+conversation_uuid = 'conversation_uuid_example' # String | 
+
+
+begin
+  #Unsubscribe any SMS participants in this conversation
+  api_instance.sms_unsubscribe_conversation(conversation_uuid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->sms_unsubscribe_conversation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_uuid** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **start_conversation**
 > ConversationStartResponse start_conversation(start_request)
 

data/docs/Order.md

@@ -32,7 +32,9 @@ Name | Type | Description | Notes
 **properties** | [**Array<OrderProperty>**](OrderProperty.md) | Properties, available only through update, not through insert due to the nature of how properties are handled internally | [optional] 
 **quote** | [**OrderQuote**](OrderQuote.md) |  | [optional] 
 **refund_dts** | **String** | If the order was refunded, the date/time that the last refund occurred | [optional] 
+**refund_reason** | **String** | Refund reason code.  This can only be written during a refund operation otherwise this field is read only. | [optional] 
 **reject_dts** | **String** | If the order was rejected, the date/time that the rejection occurred | [optional] 
+**reject_reason** | **String** | Reject reason code.  This can only be written during a reject operation otherwise this field is read only. | [optional] 
 **salesforce** | [**OrderSalesforce**](OrderSalesforce.md) |  | [optional] 
 **shipping** | [**OrderShipping**](OrderShipping.md) |  | [optional] 
 **summary** | [**OrderSummary**](OrderSummary.md) |  | [optional] 

data/docs/OrderItem.md

@@ -46,6 +46,8 @@ Name | Type | Description | Notes
 **quantity** | **Float** | Quantity | [optional] 
 **quantity_refunded** | **Float** | Quantity refunded on this item (read only except refund operation) | [optional] 
 **quickbooks_class** | **String** | QuickBooks class | [optional] 
+**refund_reason** | **String** | Refund reason code.  This can only be written during a refund operation otherwise this field is read only. | [optional] 
+**return_reason** | **String** | Return reason code.  This can only be written during a refund operation otherwise this field is read only. | [optional] 
 **ship_separately** | **BOOLEAN** | True if this item ships in a separate box | [optional] 
 **shipped_by_user** | **String** | Shipped by user | [optional] 
 **shipped_dts** | **String** | Date/time that this item was marked shipped | [optional] 

data/docs/OrderReason.md

@@ -0,0 +1,10 @@
+# UltracartClient::OrderReason
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**default_reason** | **BOOLEAN** | Default reason | [optional] 
+**description** | **String** | Reason description.  This is the friendly description of the reason that should be displayed to the user. | [optional] 
+**value** | **String** | Reason value.  This is what should be submitted with a refund operation. | [optional] 
+
+

data/docs/OrderRefundableResponse.md

@@ -4,7 +4,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **error** | [**Error**](Error.md) |  | [optional] 
+**item_level_refund_reason_required** | **BOOLEAN** | True if the item level refund reason is required | [optional] 
+**item_level_refund_reasons** | [**Array<OrderReason>**](OrderReason.md) | Reason codes available at the item level. | [optional] 
+**item_level_return_reasons** | [**Array<OrderReason>**](OrderReason.md) | Return codes available at the item level. | [optional] 
 **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**order_level_refund_reason_required** | **BOOLEAN** | True if the order level refund reason is required | [optional] 
+**order_level_refund_reasons** | [**Array<OrderReason>**](OrderReason.md) | Reason codes available at the order level. | [optional] 
+**order_level_reject_reasons** | [**Array<OrderReason>**](OrderReason.md) | Reject codes available at the order level. | [optional] 
 **refundable** | **BOOLEAN** | Whether the order is refundable or not.  Null should be interpreted as false. | [optional] 
 **success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
 **warning** | [**Warning**](Warning.md) |  | [optional] 

data/lib/ultracart_api/api/conversation_api.rb

@@ -1525,6 +1525,60 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Unsubscribe any SMS participants in this conversation
+    # Unsubscribe any SMS participants in this conversation 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def sms_unsubscribe_conversation(conversation_uuid, opts = {})
+      sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts)
+      nil
+    end
+
+    # Unsubscribe any SMS participants in this conversation
+    # Unsubscribe any SMS participants in this conversation 
+    # @param conversation_uuid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def sms_unsubscribe_conversation_with_http_info(conversation_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.sms_unsubscribe_conversation ...'
+      end
+      # verify the required parameter 'conversation_uuid' is set
+      if @api_client.config.client_side_validation && conversation_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.sms_unsubscribe_conversation"
+      end
+      # resource path
+      local_var_path = '/conversation/conversations/{conversation_uuid}/sms_unsubscribe'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.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'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#sms_unsubscribe_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Start a conversation
     # Start a new conversation 
     # @param start_request Start request

data/lib/ultracart_api/models/order.rb

@@ -84,9 +84,15 @@ module UltracartClient
     # If the order was refunded, the date/time that the last refund occurred
     attr_accessor :refund_dts
 
+    # Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+    attr_accessor :refund_reason
+
     # If the order was rejected, the date/time that the rejection occurred
     attr_accessor :reject_dts
 
+    # Reject reason code.  This can only be written during a reject operation otherwise this field is read only.
+    attr_accessor :reject_reason
+
     attr_accessor :salesforce
 
     attr_accessor :shipping
@@ -155,7 +161,9 @@ module UltracartClient
         :'properties' => :'properties',
         :'quote' => :'quote',
         :'refund_dts' => :'refund_dts',
+        :'refund_reason' => :'refund_reason',
         :'reject_dts' => :'reject_dts',
+        :'reject_reason' => :'reject_reason',
         :'salesforce' => :'salesforce',
         :'shipping' => :'shipping',
         :'summary' => :'summary',
@@ -197,7 +205,9 @@ module UltracartClient
         :'properties' => :'Array<OrderProperty>',
         :'quote' => :'OrderQuote',
         :'refund_dts' => :'String',
+        :'refund_reason' => :'String',
         :'reject_dts' => :'String',
+        :'reject_reason' => :'String',
         :'salesforce' => :'OrderSalesforce',
         :'shipping' => :'OrderShipping',
         :'summary' => :'OrderSummary',
@@ -339,10 +349,18 @@ module UltracartClient
         self.refund_dts = attributes[:'refund_dts']
       end
 
+      if attributes.has_key?(:'refund_reason')
+        self.refund_reason = attributes[:'refund_reason']
+      end
+
       if attributes.has_key?(:'reject_dts')
         self.reject_dts = attributes[:'reject_dts']
       end
 
+      if attributes.has_key?(:'reject_reason')
+        self.reject_reason = attributes[:'reject_reason']
+      end
+
       if attributes.has_key?(:'salesforce')
         self.salesforce = attributes[:'salesforce']
       end
@@ -461,7 +479,9 @@ module UltracartClient
           properties == o.properties &&
           quote == o.quote &&
           refund_dts == o.refund_dts &&
+          refund_reason == o.refund_reason &&
           reject_dts == o.reject_dts &&
+          reject_reason == o.reject_reason &&
           salesforce == o.salesforce &&
           shipping == o.shipping &&
           summary == o.summary &&
@@ -479,7 +499,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, reject_dts, salesforce, shipping, summary, tags, taxes, utms].hash
+      [affiliates, auto_order, billing, buysafe, channel_partner, checkout, coupons, creation_dts, currency_code, current_stage, customer_profile, digital_order, edi, exchange_rate, fraud_score, gift, gift_certificate, internal, items, language_iso_code, linked_shipment, marketing, merchant_id, order_id, payment, point_of_sale, properties, quote, refund_dts, refund_reason, reject_dts, reject_reason, salesforce, shipping, summary, tags, taxes, utms].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_item.rb

@@ -136,6 +136,12 @@ module UltracartClient
     # QuickBooks class
     attr_accessor :quickbooks_class
 
+    # Refund reason code.  This can only be written during a refund operation otherwise this field is read only.
+    attr_accessor :refund_reason
+
+    # Return reason code.  This can only be written during a refund operation otherwise this field is read only.
+    attr_accessor :return_reason
+
     # True if this item ships in a separate box
     attr_accessor :ship_separately
 
@@ -246,6 +252,8 @@ module UltracartClient
         :'quantity' => :'quantity',
         :'quantity_refunded' => :'quantity_refunded',
         :'quickbooks_class' => :'quickbooks_class',
+        :'refund_reason' => :'refund_reason',
+        :'return_reason' => :'return_reason',
         :'ship_separately' => :'ship_separately',
         :'shipped_by_user' => :'shipped_by_user',
         :'shipped_dts' => :'shipped_dts',
@@ -311,6 +319,8 @@ module UltracartClient
         :'quantity' => :'Float',
         :'quantity_refunded' => :'Float',
         :'quickbooks_class' => :'String',
+        :'refund_reason' => :'String',
+        :'return_reason' => :'String',
         :'ship_separately' => :'BOOLEAN',
         :'shipped_by_user' => :'String',
         :'shipped_dts' => :'String',
@@ -516,6 +526,14 @@ module UltracartClient
         self.quickbooks_class = attributes[:'quickbooks_class']
       end
 
+      if attributes.has_key?(:'refund_reason')
+        self.refund_reason = attributes[:'refund_reason']
+      end
+
+      if attributes.has_key?(:'return_reason')
+        self.return_reason = attributes[:'return_reason']
+      end
+
       if attributes.has_key?(:'ship_separately')
         self.ship_separately = attributes[:'ship_separately']
       end
@@ -761,6 +779,8 @@ module UltracartClient
           quantity == o.quantity &&
           quantity_refunded == o.quantity_refunded &&
           quickbooks_class == o.quickbooks_class &&
+          refund_reason == o.refund_reason &&
+          return_reason == o.return_reason &&
           ship_separately == o.ship_separately &&
           shipped_by_user == o.shipped_by_user &&
           shipped_dts == o.shipped_dts &&
@@ -788,7 +808,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_index, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, parent_item_index, parent_merchant_item_id, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, ship_separately, shipped_by_user, shipped_dts, shipping_status, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
+      [accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_index, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, parent_item_index, parent_merchant_item_id, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, refund_reason, return_reason, ship_separately, shipped_by_user, shipped_dts, shipping_status, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/order_reason.rb

@@ -0,0 +1,205 @@
+=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 OrderReason
+    # Default reason
+    attr_accessor :default_reason
+
+    # Reason description.  This is the friendly description of the reason that should be displayed to the user.
+    attr_accessor :description
+
+    # Reason value.  This is what should be submitted with a refund operation.
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'default_reason' => :'default_reason',
+        :'description' => :'description',
+        :'value' => :'value'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'default_reason' => :'BOOLEAN',
+        :'description' => :'String',
+        :'value' => :'String'
+      }
+    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?(:'default_reason')
+        self.default_reason = attributes[:'default_reason']
+      end
+
+      if attributes.has_key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.has_key?(:'value')
+        self.value = attributes[:'value']
+      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 &&
+          default_reason == o.default_reason &&
+          description == o.description &&
+          value == o.value
+    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
+      [default_reason, description, value].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/models/order_refundable_response.rb

@@ -16,8 +16,26 @@ module UltracartClient
   class OrderRefundableResponse
     attr_accessor :error
 
+    # True if the item level refund reason is required
+    attr_accessor :item_level_refund_reason_required
+
+    # Reason codes available at the item level.
+    attr_accessor :item_level_refund_reasons
+
+    # Return codes available at the item level.
+    attr_accessor :item_level_return_reasons
+
     attr_accessor :metadata
 
+    # True if the order level refund reason is required
+    attr_accessor :order_level_refund_reason_required
+
+    # Reason codes available at the order level.
+    attr_accessor :order_level_refund_reasons
+
+    # Reject codes available at the order level.
+    attr_accessor :order_level_reject_reasons
+
     # Whether the order is refundable or not.  Null should be interpreted as false.
     attr_accessor :refundable
 
@@ -30,7 +48,13 @@ module UltracartClient
     def self.attribute_map
       {
         :'error' => :'error',
+        :'item_level_refund_reason_required' => :'item_level_refund_reason_required',
+        :'item_level_refund_reasons' => :'item_level_refund_reasons',
+        :'item_level_return_reasons' => :'item_level_return_reasons',
         :'metadata' => :'metadata',
+        :'order_level_refund_reason_required' => :'order_level_refund_reason_required',
+        :'order_level_refund_reasons' => :'order_level_refund_reasons',
+        :'order_level_reject_reasons' => :'order_level_reject_reasons',
         :'refundable' => :'refundable',
         :'success' => :'success',
         :'warning' => :'warning'
@@ -41,7 +65,13 @@ module UltracartClient
     def self.swagger_types
       {
         :'error' => :'Error',
+        :'item_level_refund_reason_required' => :'BOOLEAN',
+        :'item_level_refund_reasons' => :'Array<OrderReason>',
+        :'item_level_return_reasons' => :'Array<OrderReason>',
         :'metadata' => :'ResponseMetadata',
+        :'order_level_refund_reason_required' => :'BOOLEAN',
+        :'order_level_refund_reasons' => :'Array<OrderReason>',
+        :'order_level_reject_reasons' => :'Array<OrderReason>',
         :'refundable' => :'BOOLEAN',
         :'success' => :'BOOLEAN',
         :'warning' => :'Warning'
@@ -60,10 +90,42 @@ module UltracartClient
         self.error = attributes[:'error']
       end
 
+      if attributes.has_key?(:'item_level_refund_reason_required')
+        self.item_level_refund_reason_required = attributes[:'item_level_refund_reason_required']
+      end
+
+      if attributes.has_key?(:'item_level_refund_reasons')
+        if (value = attributes[:'item_level_refund_reasons']).is_a?(Array)
+          self.item_level_refund_reasons = value
+        end
+      end
+
+      if attributes.has_key?(:'item_level_return_reasons')
+        if (value = attributes[:'item_level_return_reasons']).is_a?(Array)
+          self.item_level_return_reasons = value
+        end
+      end
+
       if attributes.has_key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.has_key?(:'order_level_refund_reason_required')
+        self.order_level_refund_reason_required = attributes[:'order_level_refund_reason_required']
+      end
+
+      if attributes.has_key?(:'order_level_refund_reasons')
+        if (value = attributes[:'order_level_refund_reasons']).is_a?(Array)
+          self.order_level_refund_reasons = value
+        end
+      end
+
+      if attributes.has_key?(:'order_level_reject_reasons')
+        if (value = attributes[:'order_level_reject_reasons']).is_a?(Array)
+          self.order_level_reject_reasons = value
+        end
+      end
+
       if attributes.has_key?(:'refundable')
         self.refundable = attributes[:'refundable']
       end
@@ -96,7 +158,13 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           error == o.error &&
+          item_level_refund_reason_required == o.item_level_refund_reason_required &&
+          item_level_refund_reasons == o.item_level_refund_reasons &&
+          item_level_return_reasons == o.item_level_return_reasons &&
           metadata == o.metadata &&
+          order_level_refund_reason_required == o.order_level_refund_reason_required &&
+          order_level_refund_reasons == o.order_level_refund_reasons &&
+          order_level_reject_reasons == o.order_level_reject_reasons &&
           refundable == o.refundable &&
           success == o.success &&
           warning == o.warning
@@ -111,7 +179,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [error, metadata, refundable, success, warning].hash
+      [error, item_level_refund_reason_required, item_level_refund_reasons, item_level_return_reasons, metadata, order_level_refund_reason_required, order_level_refund_reasons, order_level_reject_reasons, refundable, success, warning].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.117'
+  VERSION = '3.10.119'
 end

data/lib/ultracart_api.rb

@@ -610,6 +610,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_reason'
 require 'ultracart_api/models/order_refundable_response'
 require 'ultracart_api/models/order_replacement'
 require 'ultracart_api/models/order_replacement_item'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.10.117
+  version: 3.10.119
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -828,6 +828,7 @@ files:
 - docs/OrderQuery.md
 - docs/OrderQueryBatch.md
 - docs/OrderQuote.md
+- docs/OrderReason.md
 - docs/OrderRefundableResponse.md
 - docs/OrderReplacement.md
 - docs/OrderReplacementItem.md
@@ -1596,6 +1597,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_reason.rb
 - lib/ultracart_api/models/order_refundable_response.rb
 - lib/ultracart_api/models/order_replacement.rb
 - lib/ultracart_api/models/order_replacement_item.rb