ultracart_api 4.0.134 → 4.0.136

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c33c30bbb3cea460a12eb5c0167c32f8d367e69680ee7264c49045d03787cdae
-  data.tar.gz: 95f7b040b08ddb0de71590f33a3786cee2dfdd96aaea936192e28f0996061de2
+  metadata.gz: 4e0b1c8207b56878997ef2951b9e99fa9640b12d4bf71a7620940f131eceedb8
+  data.tar.gz: a3ea07efffdc1c617cbcee9a6f0508a408c05def0cc97c20169cc91f242551e5
 SHA512:
-  metadata.gz: ef89abdb620d7c3bc286b5f4e37d4bcab5ac3d50662ddbf867facaad07223fa4568f007d65cc355f3c5f9f065ba301bbb15ce2b3bd221e16cff28181e42b4277
-  data.tar.gz: 2c85560b053dc45986acd4eaf05dd9cfa5e85684bb9bdbf88aa7e26d253738697cafbfc4f3ab3c7bebd324a94c2cc3e614f79425cb3eedc24306982590618d74
+  metadata.gz: 16679dec7f81f930d30f1613e527e42074e81df3eada5ca41bfc5d5a721747bb83e9e526f3dbbe29bee9720f66ab96af6adc312758287d792932fa7c5f9adbbc
+  data.tar.gz: 5af8da953873bfa9a1f997483223f5cf719f8b3506c94e3bd2e112c7885ba0a36b6374ce094be91ccec3221a011c31f897c52cb303e5e8276d1239582780d16c

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.134
+- Package version: 4.0.136
 - 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.134.gem
+gem install ./ultracart_api-4.0.136.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.134.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.136.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.134'
+    gem 'ultracart_api', '~> 4.0.136'
 
 ### Install from Git
 
@@ -165,6 +165,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
@@ -1090,6 +1091,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)
@@ -1309,6 +1311,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.136 | 02/20/2023 | refund reasons |
+| 4.0.135 | 02/17/2023 | convo api - smsUnsubscribeConversation method |
 | 4.0.134 | 02/15/2023 | added auto order sorting by next_shipment_dts |
 | 4.0.133 | 02/10/2023 | convo - add storefront_host_name to search request |
 | 4.0.132 | 02/07/2023 | convo - new event for when a customer joins a queue |

data/docs/ConversationApi.md

@@ -32,6 +32,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
@@ -2013,6 +2014,76 @@ end
 - **Accept**: application/json
 
 
+## sms_unsubscribe_conversation
+
+> sms_unsubscribe_conversation(conversation_uuid)
+
+Unsubscribe any SMS participants in this conversation
+
+Unsubscribe any SMS participants in this conversation 
+
+### 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::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+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 "Error when calling ConversationApi->sms_unsubscribe_conversation: #{e}"
+end
+```
+
+#### Using the sms_unsubscribe_conversation_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> sms_unsubscribe_conversation_with_http_info(conversation_uuid)
+
+```ruby
+begin
+  # Unsubscribe any SMS participants in this conversation
+  data, status_code, headers = api_instance.sms_unsubscribe_conversation_with_http_info(conversation_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling ConversationApi->sms_unsubscribe_conversation_with_http_info: #{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**: Not defined
+- **Accept**: application/json
+
+
 ## start_conversation
 
 > <ConversationStartResponse> start_conversation(start_request)

data/docs/Order.md

@@ -33,7 +33,9 @@
 | **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] |
@@ -76,7 +78,9 @@ instance = UltracartClient::Order.new(
   properties: null,
   quote: null,
   refund_dts: null,
+  refund_reason: null,
   reject_dts: null,
+  reject_reason: null,
   salesforce: null,
   shipping: null,
   summary: null,

data/docs/OrderItem.md

@@ -47,6 +47,8 @@
 | **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] |
@@ -113,6 +115,8 @@ instance = UltracartClient::OrderItem.new(
   quantity: null,
   quantity_refunded: null,
   quickbooks_class: null,
+  refund_reason: null,
+  return_reason: null,
   ship_separately: null,
   shipped_by_user: null,
   shipped_dts: null,

data/docs/OrderReason.md

@@ -0,0 +1,22 @@
+# 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] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::OrderReason.new(
+  default_reason: null,
+  description: null,
+  value: null
+)
+```
+

data/docs/OrderRefundableResponse.md

@@ -5,7 +5,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] |
@@ -17,7 +23,13 @@ require 'ultracart_api'
 
 instance = UltracartClient::OrderRefundableResponse.new(
   error: null,
+  item_level_refund_reason_required: null,
+  item_level_refund_reasons: null,
+  item_level_return_reasons: null,
   metadata: null,
+  order_level_refund_reason_required: null,
+  order_level_refund_reasons: null,
+  order_level_reject_reasons: null,
   refundable: null,
   success: null,
   warning: null

data/lib/ultracart_api/api/conversation_api.rb

@@ -1819,6 +1819,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Unsubscribe any SMS participants in this conversation
+    # Unsubscribe any SMS participants in this conversation 
+    # @param conversation_uuid [String] 
+    # @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 [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, 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' + '}', CGI.escape(conversation_uuid.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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.sms_unsubscribe_conversation",
+        :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(:PUT, local_var_path, new_options)
+      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 [ConversationStartRequest] Start request

data/lib/ultracart_api/models/order.rb

@@ -85,9 +85,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
@@ -156,7 +162,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',
@@ -203,7 +211,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',
@@ -358,10 +368,18 @@ module UltracartClient
         self.refund_dts = attributes[:'refund_dts']
       end
 
+      if attributes.key?(:'refund_reason')
+        self.refund_reason = attributes[:'refund_reason']
+      end
+
       if attributes.key?(:'reject_dts')
         self.reject_dts = attributes[:'reject_dts']
       end
 
+      if attributes.key?(:'reject_reason')
+        self.reject_reason = attributes[:'reject_reason']
+      end
+
       if attributes.key?(:'salesforce')
         self.salesforce = attributes[:'salesforce']
       end
@@ -480,7 +498,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 &&
@@ -498,7 +518,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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

@@ -137,6 +137,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
 
@@ -247,6 +253,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',
@@ -317,6 +325,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',
@@ -535,6 +545,14 @@ module UltracartClient
         self.quickbooks_class = attributes[:'quickbooks_class']
       end
 
+      if attributes.key?(:'refund_reason')
+        self.refund_reason = attributes[:'refund_reason']
+      end
+
+      if attributes.key?(:'return_reason')
+        self.return_reason = attributes[:'return_reason']
+      end
+
       if attributes.key?(:'ship_separately')
         self.ship_separately = attributes[:'ship_separately']
       end
@@ -780,6 +798,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 &&
@@ -807,7 +827,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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,240 @@
+=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 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
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'default_reason' => :'Boolean',
+        :'description' => :'String',
+        :'value' => :'String'
+      }
+    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::OrderReason` 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::OrderReason`. 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?(:'default_reason')
+        self.default_reason = attributes[:'default_reason']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.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 [Integer] 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 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/models/order_refundable_response.rb

@@ -17,8 +17,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
 
@@ -31,7 +49,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'
@@ -47,7 +71,13 @@ module UltracartClient
     def self.openapi_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'
@@ -79,10 +109,42 @@ module UltracartClient
         self.error = attributes[:'error']
       end
 
+      if attributes.key?(:'item_level_refund_reason_required')
+        self.item_level_refund_reason_required = attributes[:'item_level_refund_reason_required']
+      end
+
+      if attributes.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.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.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.key?(:'order_level_refund_reason_required')
+        self.order_level_refund_reason_required = attributes[:'order_level_refund_reason_required']
+      end
+
+      if attributes.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.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.key?(:'refundable')
         self.refundable = attributes[:'refundable']
       end
@@ -115,7 +177,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
@@ -130,7 +198,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.134'
+  VERSION = '4.0.136'
 end

data/lib/ultracart_api.rb

@@ -609,6 +609,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: 4.0.134
+  version: 4.0.136
 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
@@ -667,6 +667,7 @@ files:
 - docs/OrderQuery.md
 - docs/OrderQueryBatch.md
 - docs/OrderQuote.md
+- docs/OrderReason.md
 - docs/OrderRefundableResponse.md
 - docs/OrderReplacement.md
 - docs/OrderReplacementItem.md
@@ -1434,6 +1435,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