ultracart_api 4.1.5 → 4.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 072052f4d9cffb084d1c14e700e1a912b9d07d0f5528d5bfb56afc397055cc34
-  data.tar.gz: 16dc833a02415b6218568966bf11c7ac3cc4c02cfb2d6f9f2954c30b2fb589c1
+  metadata.gz: e6f3a683613b1018628224e6efb16065b44d8ba2e77df9710d5c7ecb9e5f868b
+  data.tar.gz: 5f2ef29b9a7f718d8f7abf93cfd6c3203d809fe60632e2058ed5d40367853326
 SHA512:
-  metadata.gz: a26bfb1c9739bd9aaf0cd5dac305b5b2927fa09337b196a1796a7f2265512bc914ff083a02f0dc821e76fad615e024f8fb86be4490e316d1bf7769df75908348
-  data.tar.gz: 5f4957d6892dc48e4a214b90f9951fd3dad6c0ee782c567ae491aac5c5f5147c22638cb89836643cc4509da6e8a153a6e50192530c250ccf47e2fa297adc0d1d
+  metadata.gz: b44381fc7babd188a4eff34734111fae121f5d074677dab3aa331b1552ed68f7c776bc96548ebe6d0c6b7fade559b0e4667fb72e9baac70efc7383fdf38bc071
+  data.tar.gz: 4f97b60e7794cf61f77dedc5b808a58b73e6bbc6f5777ef7a3f49f25c43ccfb2a8d77fb99002cdbbdf8cc05c9e2acff9df21624fcdfb355f7bbe307a2a054ffb

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.5
+- Package version: 4.1.7
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.5'
+gem 'ultracart_api', '4.1.7'
 ```
 
 install:
@@ -334,6 +334,7 @@ Class | Method | HTTP request | Description
 *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* | [**refund_order_completely**](docs/OrderApi.md#refund_order_completely) | **PUT** /order/orders/{order_id}/refund_completely | Refund an order completely
 *UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
 *UltracartClient::OrderApi* | [**resend_receipt**](docs/OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
 *UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
@@ -696,6 +697,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ChannelPartnerOrder](docs/ChannelPartnerOrder.md)
  - [UltracartClient::ChannelPartnerOrderItem](docs/ChannelPartnerOrderItem.md)
  - [UltracartClient::ChannelPartnerOrderItemOption](docs/ChannelPartnerOrderItemOption.md)
+ - [UltracartClient::ChannelPartnerOrderItemProperty](docs/ChannelPartnerOrderItemProperty.md)
  - [UltracartClient::ChannelPartnerOrderTransaction](docs/ChannelPartnerOrderTransaction.md)
  - [UltracartClient::ChannelPartnerOrderTransactionDetail](docs/ChannelPartnerOrderTransactionDetail.md)
  - [UltracartClient::ChannelPartnerShipToPreference](docs/ChannelPartnerShipToPreference.md)
@@ -1516,6 +1518,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.7 | 04/21/2025 | conversation agent additional fields |
+| 4.1.6 | 04/16/2025 | added channel partner order item properties |
 | 4.1.5 | 03/28/2025 | added paypal fastlane constants for payments |
 | 4.1.4 | 03/07/2025 | updated github readme.md |
 | 4.1.3 | 03/07/2025 | updated github readme.md files |

data/docs/ChannelPartnerOrderItem.md

@@ -9,6 +9,7 @@
 | **auto_order_schedule** | **String** | The frequency schedule for this item if this item is part of an auto (recurring) order | [optional] |
 | **merchant_item_id** | **String** | Item ID | [optional] |
 | **options** | [**Array<ChannelPartnerOrderItemOption>**](ChannelPartnerOrderItemOption.md) | Item options | [optional] |
+| **properties** | [**Array<ChannelPartnerOrderItemProperty>**](ChannelPartnerOrderItemProperty.md) | Properties | [optional] |
 | **quantity** | **Float** | Quantity | [optional] |
 | **upsell** | **Boolean** | True if this item was an upsell item. | [optional] |
 
@@ -23,6 +24,7 @@ instance = UltracartClient::ChannelPartnerOrderItem.new(
   auto_order_schedule: null,
   merchant_item_id: null,
   options: null,
+  properties: null,
   quantity: null,
   upsell: null
 )

data/docs/ChannelPartnerOrderItemProperty.md

@@ -0,0 +1,24 @@
+# UltracartClient::ChannelPartnerOrderItemProperty
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display** | **Boolean** | True if this property is displayed to the customer | [optional] |
+| **expiration_dts** | **String** | The date/time that the property expires and is deleted | [optional] |
+| **name** | **String** | Name | [optional] |
+| **value** | **String** | Value | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ChannelPartnerOrderItemProperty.new(
+  display: null,
+  expiration_dts: null,
+  name: null,
+  value: null
+)
+```
+

data/docs/ConversationAgentProfile.md

@@ -4,6 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **ai** | **Boolean** | AI powered chat bot | [optional] |
+| **ai_chat_instructions** | **String** | Additional instructions for this AI when handle web chats | [optional] |
+| **ai_persona** | **String** | Persona of this AI agent | [optional] |
+| **ai_sms_instructions** | **String** | Additional instructions for this AI when handle SMS messages | [optional] |
 | **chat_limit** | **Integer** | The number of engagement chats that can be pushed on them at any given time. | [optional] |
 | **default_language_iso_code** | **String** | The default language the agent is chatting in | [optional] |
 | **default_status** | **String** | Default status when the agent loads conversations app. | [optional] |
@@ -18,6 +22,10 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ConversationAgentProfile.new(
+  ai: null,
+  ai_chat_instructions: null,
+  ai_persona: null,
+  ai_sms_instructions: null,
   chat_limit: null,
   default_language_iso_code: null,
   default_status: null,

data/docs/OrderApi.md

@@ -25,6 +25,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**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 |
+| [**refund_order_completely**](OrderApi.md#refund_order_completely) | **PUT** /order/orders/{order_id}/refund_completely | Refund an order completely |
 | [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order |
 | [**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt |
 | [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation |
@@ -1650,6 +1651,97 @@ end
 - **Accept**: application/json
 
 
+## refund_order_completely
+
+> <OrderResponse> refund_order_completely(order_id, opts)
+
+Refund an order completely
+
+Perform a refund operation on an order and then update the order if successful. 
+
+### 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 refund.
+opts = {
+  reject_after_refund: true, # Boolean | Reject order after refund
+  skip_customer_notification: true, # Boolean | Skip customer email notification
+  auto_order_cancel: true, # Boolean | Cancel associated auto orders
+  manual_refund: true, # Boolean | Consider a manual refund done externally
+  reverse_affiliate_transactions: true, # Boolean | Reverse affiliate transactions
+  issue_store_credit: true, # Boolean | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
+  auto_order_cancel_reason: 'auto_order_cancel_reason_example', # String | Reason for auto orders cancellation
+  refund_reason: 'refund_reason_example', # String | Reason for refund
+  reject_reason: 'reject_reason_example' # String | Reason for reject
+}
+
+begin
+  # Refund an order completely
+  result = api_instance.refund_order_completely(order_id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->refund_order_completely: #{e}"
+end
+```
+
+#### Using the refund_order_completely_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrderResponse>, Integer, Hash)> refund_order_completely_with_http_info(order_id, opts)
+
+```ruby
+begin
+  # Refund an order completely
+  data, status_code, headers = api_instance.refund_order_completely_with_http_info(order_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrderResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->refund_order_completely_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | The order id to refund. |  |
+| **reject_after_refund** | **Boolean** | Reject order after refund | [optional][default to false] |
+| **skip_customer_notification** | **Boolean** | Skip customer email notification | [optional][default to false] |
+| **auto_order_cancel** | **Boolean** | Cancel associated auto orders | [optional][default to false] |
+| **manual_refund** | **Boolean** | Consider a manual refund done externally | [optional][default to false] |
+| **reverse_affiliate_transactions** | **Boolean** | Reverse affiliate transactions | [optional][default to true] |
+| **issue_store_credit** | **Boolean** | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account | [optional][default to false] |
+| **auto_order_cancel_reason** | **String** | Reason for auto orders cancellation | [optional] |
+| **refund_reason** | **String** | Reason for refund | [optional] |
+| **reject_reason** | **String** | Reason for reject | [optional] |
+
+### Return type
+
+[**OrderResponse**](OrderResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## replacement
 
 > <OrderReplacementResponse> replacement(order_id, replacement)

data/lib/ultracart_api/api/order_api.rb

@@ -1579,6 +1579,97 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Refund an order completely
+    # Perform a refund operation on an order and then update the order if successful. 
+    # @param order_id [String] The order id to refund.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
+    # @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
+    # @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
+    # @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
+    # @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
+    # @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
+    # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
+    # @option opts [String] :refund_reason Reason for refund
+    # @option opts [String] :reject_reason Reason for reject
+    # @return [OrderResponse]
+    def refund_order_completely(order_id, opts = {})
+      data, _status_code, _headers = refund_order_completely_with_http_info(order_id, opts)
+      data
+    end
+
+    # Refund an order completely
+    # Perform a refund operation on an order and then update the order if successful. 
+    # @param order_id [String] The order id to refund.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
+    # @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
+    # @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
+    # @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
+    # @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
+    # @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
+    # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
+    # @option opts [String] :refund_reason Reason for refund
+    # @option opts [String] :reject_reason Reason for reject
+    # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
+    def refund_order_completely_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.refund_order_completely ...'
+      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.refund_order_completely"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/refund_completely'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
+      query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
+      query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
+      query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
+      query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
+      query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
+      query_params[:'auto_order_cancel_reason'] = opts[:'auto_order_cancel_reason'] if !opts[:'auto_order_cancel_reason'].nil?
+      query_params[:'refund_reason'] = opts[:'refund_reason'] if !opts[:'refund_reason'].nil?
+      query_params[:'reject_reason'] = opts[:'reject_reason'] if !opts[:'reject_reason'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.refund_order_completely",
+        :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: OrderApi#refund_order_completely\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Replacement order
     # Create a replacement order based upon a previous order 
     # @param order_id [String] The order id to generate a replacement for.

data/lib/ultracart_api/models/channel_partner_order_item.rb

@@ -30,6 +30,9 @@ module UltracartClient
     # Item options
     attr_accessor :options
 
+    # Properties
+    attr_accessor :properties
+
     # Quantity
     attr_accessor :quantity
 
@@ -66,6 +69,7 @@ module UltracartClient
         :'auto_order_schedule' => :'auto_order_schedule',
         :'merchant_item_id' => :'merchant_item_id',
         :'options' => :'options',
+        :'properties' => :'properties',
         :'quantity' => :'quantity',
         :'upsell' => :'upsell'
       }
@@ -84,6 +88,7 @@ module UltracartClient
         :'auto_order_schedule' => :'String',
         :'merchant_item_id' => :'String',
         :'options' => :'Array<ChannelPartnerOrderItemOption>',
+        :'properties' => :'Array<ChannelPartnerOrderItemProperty>',
         :'quantity' => :'Float',
         :'upsell' => :'Boolean'
       }
@@ -132,6 +137,12 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'properties')
+        if (value = attributes[:'properties']).is_a?(Array)
+          self.properties = value
+        end
+      end
+
       if attributes.key?(:'quantity')
         self.quantity = attributes[:'quantity']
       end
@@ -191,6 +202,7 @@ module UltracartClient
           auto_order_schedule == o.auto_order_schedule &&
           merchant_item_id == o.merchant_item_id &&
           options == o.options &&
+          properties == o.properties &&
           quantity == o.quantity &&
           upsell == o.upsell
     end
@@ -204,7 +216,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, merchant_item_id, options, quantity, upsell].hash
+      [arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, merchant_item_id, options, properties, quantity, upsell].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/channel_partner_order_item_property.rb

@@ -0,0 +1,280 @@
+=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 ChannelPartnerOrderItemProperty
+    # True if this property is displayed to the customer
+    attr_accessor :display
+
+    # The date/time that the property expires and is deleted
+    attr_accessor :expiration_dts
+
+    # Name
+    attr_accessor :name
+
+    # Value
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'display' => :'display',
+        :'expiration_dts' => :'expiration_dts',
+        :'name' => :'name',
+        :'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
+      {
+        :'display' => :'Boolean',
+        :'expiration_dts' => :'String',
+        :'name' => :'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::ChannelPartnerOrderItemProperty` 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::ChannelPartnerOrderItemProperty`. 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?(:'display')
+        self.display = attributes[:'display']
+      end
+
+      if attributes.key?(:'expiration_dts')
+        self.expiration_dts = attributes[:'expiration_dts']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      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
+      if !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      end
+
+      if !@value.nil? && @value.to_s.length > 3800
+        invalid_properties.push('invalid value for "value", the character length must be smaller than or equal to 3800.')
+      end
+
+      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?
+      return false if !@name.nil? && @name.to_s.length > 100
+      return false if !@value.nil? && @value.to_s.length > 3800
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] value Value to be assigned
+    def value=(value)
+      if !value.nil? && value.to_s.length > 3800
+        fail ArgumentError, 'invalid value for "value", the character length must be smaller than or equal to 3800.'
+      end
+
+      @value = value
+    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 &&
+          display == o.display &&
+          expiration_dts == o.expiration_dts &&
+          name == o.name &&
+          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
+      [display, expiration_dts, name, 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/conversation_agent_profile.rb

@@ -15,6 +15,18 @@ require 'time'
 
 module UltracartClient
   class ConversationAgentProfile
+    # AI powered chat bot
+    attr_accessor :ai
+
+    # Additional instructions for this AI when handle web chats
+    attr_accessor :ai_chat_instructions
+
+    # Persona of this AI agent
+    attr_accessor :ai_persona
+
+    # Additional instructions for this AI when handle SMS messages
+    attr_accessor :ai_sms_instructions
+
     # The number of engagement chats that can be pushed on them at any given time.
     attr_accessor :chat_limit
 
@@ -61,6 +73,10 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'ai' => :'ai',
+        :'ai_chat_instructions' => :'ai_chat_instructions',
+        :'ai_persona' => :'ai_persona',
+        :'ai_sms_instructions' => :'ai_sms_instructions',
         :'chat_limit' => :'chat_limit',
         :'default_language_iso_code' => :'default_language_iso_code',
         :'default_status' => :'default_status',
@@ -79,6 +95,10 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'ai' => :'Boolean',
+        :'ai_chat_instructions' => :'String',
+        :'ai_persona' => :'String',
+        :'ai_sms_instructions' => :'String',
         :'chat_limit' => :'Integer',
         :'default_language_iso_code' => :'String',
         :'default_status' => :'String',
@@ -110,6 +130,22 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'ai')
+        self.ai = attributes[:'ai']
+      end
+
+      if attributes.key?(:'ai_chat_instructions')
+        self.ai_chat_instructions = attributes[:'ai_chat_instructions']
+      end
+
+      if attributes.key?(:'ai_persona')
+        self.ai_persona = attributes[:'ai_persona']
+      end
+
+      if attributes.key?(:'ai_sms_instructions')
+        self.ai_sms_instructions = attributes[:'ai_sms_instructions']
+      end
+
       if attributes.key?(:'chat_limit')
         self.chat_limit = attributes[:'chat_limit']
       end
@@ -169,6 +205,10 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          ai == o.ai &&
+          ai_chat_instructions == o.ai_chat_instructions &&
+          ai_persona == o.ai_persona &&
+          ai_sms_instructions == o.ai_sms_instructions &&
           chat_limit == o.chat_limit &&
           default_language_iso_code == o.default_language_iso_code &&
           default_status == o.default_status &&
@@ -187,7 +227,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [chat_limit, default_language_iso_code, default_status, display_name, name, profile_image_upload_key, profile_image_url].hash
+      [ai, ai_chat_instructions, ai_persona, ai_sms_instructions, chat_limit, default_language_iso_code, default_status, display_name, name, profile_image_upload_key, profile_image_url].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.1.5'
+  VERSION = '4.1.7'
 end

data/lib/ultracart_api.rb

@@ -128,6 +128,7 @@ require 'ultracart_api/models/channel_partner_import_response'
 require 'ultracart_api/models/channel_partner_order'
 require 'ultracart_api/models/channel_partner_order_item'
 require 'ultracart_api/models/channel_partner_order_item_option'
+require 'ultracart_api/models/channel_partner_order_item_property'
 require 'ultracart_api/models/channel_partner_order_transaction'
 require 'ultracart_api/models/channel_partner_order_transaction_detail'
 require 'ultracart_api/models/channel_partner_ship_to_preference'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.1.7
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-28 00:00:00.000000000 Z
+date: 2025-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -175,6 +175,7 @@ files:
 - docs/ChannelPartnerOrder.md
 - docs/ChannelPartnerOrderItem.md
 - docs/ChannelPartnerOrderItemOption.md
+- docs/ChannelPartnerOrderItemProperty.md
 - docs/ChannelPartnerOrderTransaction.md
 - docs/ChannelPartnerOrderTransactionDetail.md
 - docs/ChannelPartnerShipToPreference.md
@@ -1075,6 +1076,7 @@ files:
 - lib/ultracart_api/models/channel_partner_order.rb
 - lib/ultracart_api/models/channel_partner_order_item.rb
 - lib/ultracart_api/models/channel_partner_order_item_option.rb
+- lib/ultracart_api/models/channel_partner_order_item_property.rb
 - lib/ultracart_api/models/channel_partner_order_transaction.rb
 - lib/ultracart_api/models/channel_partner_order_transaction_detail.rb
 - lib/ultracart_api/models/channel_partner_ship_to_preference.rb