ultracart_api 3.11.11 → 3.11.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc09cf6002561dec52d2ee699501da07751a7a956ab09a7f92732553ab221a87
-  data.tar.gz: e051b886dcd6d5276c47ba9fc559b0aaf82d5ecb751376a4d883262d0d7e4081
+  metadata.gz: 656f56eb03edbe8d3fcea4b31483a94fbe1b59a1da823f4013651c8516b8c7b8
+  data.tar.gz: 686a268af6211e982927372fbceebe8f1b8928afffb0cb3c0397d240acd4ab8f
 SHA512:
-  metadata.gz: d0459df2f93e959ed9614d760c7706f1f3520c6299b4fb7acd2e8ce8b2d3f17afb0b0fc0442b3164e614e48682c12d99151c093a09022c063fab3465b1b84b87
-  data.tar.gz: 495caa4256f20a94433b3ffb62591c772981bab0ce547decb3729dbe06a6e29ef1845f3d448a088c24c810b7e0b9492b2a8af7127d67c7abbb9cbc5e0d8cdfd2
+  metadata.gz: 7c3ed31f2dcc4dd982973caf97c6da4141750386e003aea8cc8edea593f4a174bd65a9f8656d3883afcd4c6030ab55627541fd7b64e09ccca688c5275b6b2a25
+  data.tar.gz: 188eccb8f4461e294feea9f14de956749b5ef32b7a25bf0242216aa2e12bbe802ccd7bf440c427e67fcd7f4e5a0e91af549f99fd232402e19b0bc21df659665c

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.11.11
+- Package version: 3.11.13
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.11.11.gem
+gem install ./ultracart_api-3.11.13.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.11.11.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.11.13.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.11.11'
+    gem 'ultracart_api', '~> 3.11.13'
 
 ### Install from Git
 
@@ -192,6 +192,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailbox**](docs/ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
 *UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
 *UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
+*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
 *UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
 *UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
 *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
@@ -224,6 +225,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::ConversationApi* | [**update_pbx_time_range**](docs/ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
 *UltracartClient::ConversationApi* | [**update_pbx_voicemail_mailbox**](docs/ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
 *UltracartClient::ConversationApi* | [**update_virtual_agent_budget**](docs/ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget
+*UltracartClient::ConversationApi* | [**update_virtual_agent_capabilities**](docs/ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
 *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
 *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
 *UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
@@ -817,6 +819,8 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationTwilioAccount](docs/ConversationTwilioAccount.md)
  - [UltracartClient::ConversationVirtualAgentBudget](docs/ConversationVirtualAgentBudget.md)
  - [UltracartClient::ConversationVirtualAgentBudgetResponse](docs/ConversationVirtualAgentBudgetResponse.md)
+ - [UltracartClient::ConversationVirtualAgentCapabilities](docs/ConversationVirtualAgentCapabilities.md)
+ - [UltracartClient::ConversationVirtualAgentCapabilitiesResponse](docs/ConversationVirtualAgentCapabilitiesResponse.md)
  - [UltracartClient::ConversationWebchatContext](docs/ConversationWebchatContext.md)
  - [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
  - [UltracartClient::ConversationWebchatQueueStatusAgent](docs/ConversationWebchatQueueStatusAgent.md)
@@ -1528,6 +1532,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.11.13 | 05/20/2025 | conversation - virtual agent flag and virtual agent cost |
+| 3.11.12 | 05/19/2025 | conversations - AI agent capabilities method |
 | 3.11.11 | 05/19/2025 | conversations - virtual AI budgets |
 | 3.11.10 | 05/06/2025 | conversation - ConversationAgentProfile.user_id added for agent profiles call |
 | 3.11.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |

data/docs/Conversation.md

@@ -21,6 +21,8 @@ Name | Type | Description | Notes
 **sentiment** | [**ConversationSentiment**](ConversationSentiment.md) |  | [optional] 
 **start_dts** | **String** | Start of the conversation date/time | [optional] 
 **unread_messages** | **BOOLEAN** |  | [optional] 
+**virtual_agent** | **BOOLEAN** | True if a virtual agent answered the conversation | [optional] 
+**virtual_agent_cost** | **Float** | The cost of this conversation performed by the virtual agent | [optional] 
 **visible** | **BOOLEAN** |  | [optional] 
 
 

data/docs/ConversationApi.md

@@ -58,6 +58,7 @@ Method | HTTP request | Description
 [**get_pbx_voicemail_mailbox**](ConversationApi.md#get_pbx_voicemail_mailbox) | **GET** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Get pbx voicemailMailbox
 [**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
 [**get_virtual_agent_budget**](ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
+[**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
 [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
 [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
 [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
@@ -90,6 +91,7 @@ Method | HTTP request | Description
 [**update_pbx_time_range**](ConversationApi.md#update_pbx_time_range) | **PUT** /conversation/pbx/time_range/{conversationPbxTimeRangeUuid} | Update pbx timeRange
 [**update_pbx_voicemail_mailbox**](ConversationApi.md#update_pbx_voicemail_mailbox) | **PUT** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Update pbx voicemailMailbox
 [**update_virtual_agent_budget**](ConversationApi.md#update_virtual_agent_budget) | **PUT** /conversation/virtualagent/budget | Update virtual agent budget
+[**update_virtual_agent_capabilities**](ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
 
 
 # **delete_conversation_canned_message**
@@ -2705,6 +2707,51 @@ This endpoint does not need any parameter.
 
 
 
+# **get_virtual_agent_capabilities**
+> ConversationVirtualAgentCapabilitiesResponse get_virtual_agent_capabilities
+
+Get virtual agent capabilities
+
+Retrieve virtual agent capabilities 
+
+### 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)
+
+
+
+begin
+  #Get virtual agent capabilities
+  result = api_instance.get_virtual_agent_capabilities
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->get_virtual_agent_capabilities: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ConversationVirtualAgentCapabilitiesResponse**](ConversationVirtualAgentCapabilitiesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **insert_conversation_canned_message**
 > ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
 
@@ -4340,3 +4387,53 @@ Name | Type | Description  | Notes
 
 
 
+# **update_virtual_agent_capabilities**
+> ConversationVirtualAgentCapabilitiesResponse update_virtual_agent_capabilities(virtual_agent_capabilities)
+
+Update virtual agent capabilities
+
+Update virtual agent capabilities 
+
+### 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)
+
+
+virtual_agent_capabilities = UltracartClient::ConversationVirtualAgentCapabilities.new # ConversationVirtualAgentCapabilities | Virtual Agent Capabilities
+
+
+begin
+  #Update virtual agent capabilities
+  result = api_instance.update_virtual_agent_capabilities(virtual_agent_capabilities)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling ConversationApi->update_virtual_agent_capabilities: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **virtual_agent_capabilities** | [**ConversationVirtualAgentCapabilities**](ConversationVirtualAgentCapabilities.md)| Virtual Agent Capabilities | 
+
+### Return type
+
+[**ConversationVirtualAgentCapabilitiesResponse**](ConversationVirtualAgentCapabilitiesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ConversationVirtualAgentCapabilities.md

@@ -0,0 +1,16 @@
+# UltracartClient::ConversationVirtualAgentCapabilities
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cancel_subscription** | **BOOLEAN** |  | [optional] 
+**delay_subscription** | **BOOLEAN** |  | [optional] 
+**lookup_order_information** | **BOOLEAN** |  | [optional] 
+**lookup_subscription_information** | **BOOLEAN** |  | [optional] 
+**open_support_ticket** | **BOOLEAN** |  | [optional] 
+**pause_subscription** | **BOOLEAN** |  | [optional] 
+**resume_subscription** | **BOOLEAN** |  | [optional] 
+**transfer_chat_to_live_agent** | **BOOLEAN** |  | [optional] 
+**update_subscription_credit_card** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ConversationVirtualAgentCapabilitiesResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::ConversationVirtualAgentCapabilitiesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**capabilities** | [**ConversationVirtualAgentCapabilities**](ConversationVirtualAgentCapabilities.md) |  | [optional] 
+**error** | [**Error**](Error.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/ItemRestriction.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **exclude_coupon** | **BOOLEAN** | Exclude coupons | [optional] 
 **exclude_from_free_promotion** | **BOOLEAN** | Exclude from free promotion | [optional] 
+**exclude_from_loyalty** | **BOOLEAN** | Exclude from loyalty.  Must be set to true or false to save.  Null is ignored for backwards SDK compatibility | [optional] 
 **items** | [**Array<ItemRestrictionItem>**](ItemRestrictionItem.md) | Items | [optional] 
 **maximum_quantity** | **Integer** | Maximum quantity | [optional] 
 **minimum_quantity** | **Integer** | Minimum quantity (defaults to 1) | [optional] 

data/lib/ultracart_api/api/conversation_api.rb

@@ -2900,6 +2900,55 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get virtual agent capabilities
+    # Retrieve virtual agent capabilities 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationVirtualAgentCapabilitiesResponse]
+    def get_virtual_agent_capabilities(opts = {})
+      data, _status_code, _headers = get_virtual_agent_capabilities_with_http_info(opts)
+      data
+    end
+
+    # Get virtual agent capabilities
+    # Retrieve virtual agent capabilities 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationVirtualAgentCapabilitiesResponse, Fixnum, Hash)>] ConversationVirtualAgentCapabilitiesResponse data, response status code and response headers
+    def get_virtual_agent_capabilities_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_virtual_agent_capabilities ...'
+      end
+      # resource path
+      local_var_path = '/conversation/virtualagent/capabilities'
+
+      # 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(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ConversationVirtualAgentCapabilitiesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_virtual_agent_capabilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Insert a canned message
     # Insert a canned message 
     # @param canned_message Canned message
@@ -4732,5 +4781,60 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update virtual agent capabilities
+    # Update virtual agent capabilities 
+    # @param virtual_agent_capabilities Virtual Agent Capabilities
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationVirtualAgentCapabilitiesResponse]
+    def update_virtual_agent_capabilities(virtual_agent_capabilities, opts = {})
+      data, _status_code, _headers = update_virtual_agent_capabilities_with_http_info(virtual_agent_capabilities, opts)
+      data
+    end
+
+    # Update virtual agent capabilities
+    # Update virtual agent capabilities 
+    # @param virtual_agent_capabilities Virtual Agent Capabilities
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationVirtualAgentCapabilitiesResponse, Fixnum, Hash)>] ConversationVirtualAgentCapabilitiesResponse data, response status code and response headers
+    def update_virtual_agent_capabilities_with_http_info(virtual_agent_capabilities, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.update_virtual_agent_capabilities ...'
+      end
+      # verify the required parameter 'virtual_agent_capabilities' is set
+      if @api_client.config.client_side_validation && virtual_agent_capabilities.nil?
+        fail ArgumentError, "Missing the required parameter 'virtual_agent_capabilities' when calling ConversationApi.update_virtual_agent_capabilities"
+      end
+      # resource path
+      local_var_path = '/conversation/virtualagent/capabilities'
+
+      # 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 = @api_client.object_to_http_body(virtual_agent_capabilities)
+      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,
+        :return_type => 'ConversationVirtualAgentCapabilitiesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#update_virtual_agent_capabilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/ultracart_api/models/conversation.rb

@@ -56,6 +56,12 @@ module UltracartClient
 
     attr_accessor :unread_messages
 
+    # True if a virtual agent answered the conversation
+    attr_accessor :virtual_agent
+
+    # The cost of this conversation performed by the virtual agent
+    attr_accessor :virtual_agent_cost
+
     attr_accessor :visible
 
     class EnumAttributeValidator
@@ -101,6 +107,8 @@ module UltracartClient
         :'sentiment' => :'sentiment',
         :'start_dts' => :'start_dts',
         :'unread_messages' => :'unread_messages',
+        :'virtual_agent' => :'virtual_agent',
+        :'virtual_agent_cost' => :'virtual_agent_cost',
         :'visible' => :'visible'
       }
     end
@@ -126,6 +134,8 @@ module UltracartClient
         :'sentiment' => :'ConversationSentiment',
         :'start_dts' => :'String',
         :'unread_messages' => :'BOOLEAN',
+        :'virtual_agent' => :'BOOLEAN',
+        :'virtual_agent_cost' => :'Float',
         :'visible' => :'BOOLEAN'
       }
     end
@@ -214,6 +224,14 @@ module UltracartClient
         self.unread_messages = attributes[:'unread_messages']
       end
 
+      if attributes.has_key?(:'virtual_agent')
+        self.virtual_agent = attributes[:'virtual_agent']
+      end
+
+      if attributes.has_key?(:'virtual_agent_cost')
+        self.virtual_agent_cost = attributes[:'virtual_agent_cost']
+      end
+
       if attributes.has_key?(:'visible')
         self.visible = attributes[:'visible']
       end
@@ -267,6 +285,8 @@ module UltracartClient
           sentiment == o.sentiment &&
           start_dts == o.start_dts &&
           unread_messages == o.unread_messages &&
+          virtual_agent == o.virtual_agent &&
+          virtual_agent_cost == o.virtual_agent_cost &&
           visible == o.visible
     end
 
@@ -279,7 +299,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [base_language_iso_code, closed, conversation_arn, conversation_uuid, customer_first_message_unresponded_to_dts, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_interactive_message_dts, last_message_dts, medium, merchant_id, message_count, messages, participants, sentiment, start_dts, unread_messages, visible].hash
+      [base_language_iso_code, closed, conversation_arn, conversation_uuid, customer_first_message_unresponded_to_dts, last_conversation_message_body, last_conversation_participant_arn, last_conversation_participant_name, last_interactive_message_dts, last_message_dts, medium, merchant_id, message_count, messages, participants, sentiment, start_dts, unread_messages, virtual_agent, virtual_agent_cost, visible].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb

@@ -0,0 +1,256 @@
+=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 ConversationVirtualAgentCapabilities
+    attr_accessor :cancel_subscription
+
+    attr_accessor :delay_subscription
+
+    attr_accessor :lookup_order_information
+
+    attr_accessor :lookup_subscription_information
+
+    attr_accessor :open_support_ticket
+
+    attr_accessor :pause_subscription
+
+    attr_accessor :resume_subscription
+
+    attr_accessor :transfer_chat_to_live_agent
+
+    attr_accessor :update_subscription_credit_card
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cancel_subscription' => :'cancel_subscription',
+        :'delay_subscription' => :'delay_subscription',
+        :'lookup_order_information' => :'lookup_order_information',
+        :'lookup_subscription_information' => :'lookup_subscription_information',
+        :'open_support_ticket' => :'open_support_ticket',
+        :'pause_subscription' => :'pause_subscription',
+        :'resume_subscription' => :'resume_subscription',
+        :'transfer_chat_to_live_agent' => :'transfer_chat_to_live_agent',
+        :'update_subscription_credit_card' => :'update_subscription_credit_card'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cancel_subscription' => :'BOOLEAN',
+        :'delay_subscription' => :'BOOLEAN',
+        :'lookup_order_information' => :'BOOLEAN',
+        :'lookup_subscription_information' => :'BOOLEAN',
+        :'open_support_ticket' => :'BOOLEAN',
+        :'pause_subscription' => :'BOOLEAN',
+        :'resume_subscription' => :'BOOLEAN',
+        :'transfer_chat_to_live_agent' => :'BOOLEAN',
+        :'update_subscription_credit_card' => :'BOOLEAN'
+      }
+    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?(:'cancel_subscription')
+        self.cancel_subscription = attributes[:'cancel_subscription']
+      end
+
+      if attributes.has_key?(:'delay_subscription')
+        self.delay_subscription = attributes[:'delay_subscription']
+      end
+
+      if attributes.has_key?(:'lookup_order_information')
+        self.lookup_order_information = attributes[:'lookup_order_information']
+      end
+
+      if attributes.has_key?(:'lookup_subscription_information')
+        self.lookup_subscription_information = attributes[:'lookup_subscription_information']
+      end
+
+      if attributes.has_key?(:'open_support_ticket')
+        self.open_support_ticket = attributes[:'open_support_ticket']
+      end
+
+      if attributes.has_key?(:'pause_subscription')
+        self.pause_subscription = attributes[:'pause_subscription']
+      end
+
+      if attributes.has_key?(:'resume_subscription')
+        self.resume_subscription = attributes[:'resume_subscription']
+      end
+
+      if attributes.has_key?(:'transfer_chat_to_live_agent')
+        self.transfer_chat_to_live_agent = attributes[:'transfer_chat_to_live_agent']
+      end
+
+      if attributes.has_key?(:'update_subscription_credit_card')
+        self.update_subscription_credit_card = attributes[:'update_subscription_credit_card']
+      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 &&
+          cancel_subscription == o.cancel_subscription &&
+          delay_subscription == o.delay_subscription &&
+          lookup_order_information == o.lookup_order_information &&
+          lookup_subscription_information == o.lookup_subscription_information &&
+          open_support_ticket == o.open_support_ticket &&
+          pause_subscription == o.pause_subscription &&
+          resume_subscription == o.resume_subscription &&
+          transfer_chat_to_live_agent == o.transfer_chat_to_live_agent &&
+          update_subscription_credit_card == o.update_subscription_credit_card
+    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
+      [cancel_subscription, delay_subscription, lookup_order_information, lookup_subscription_information, open_support_ticket, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card].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/conversation_virtual_agent_capabilities_response.rb

@@ -0,0 +1,221 @@
+=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 ConversationVirtualAgentCapabilitiesResponse
+    attr_accessor :capabilities
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'capabilities' => :'capabilities',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'capabilities' => :'ConversationVirtualAgentCapabilities',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'capabilities')
+        self.capabilities = attributes[:'capabilities']
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          capabilities == o.capabilities &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [capabilities, error, metadata, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/item_restriction.rb

@@ -20,6 +20,9 @@ module UltracartClient
     # Exclude from free promotion
     attr_accessor :exclude_from_free_promotion
 
+    # Exclude from loyalty.  Must be set to true or false to save.  Null is ignored for backwards SDK compatibility
+    attr_accessor :exclude_from_loyalty
+
     # Items
     attr_accessor :items
 
@@ -43,6 +46,7 @@ module UltracartClient
       {
         :'exclude_coupon' => :'exclude_coupon',
         :'exclude_from_free_promotion' => :'exclude_from_free_promotion',
+        :'exclude_from_loyalty' => :'exclude_from_loyalty',
         :'items' => :'items',
         :'maximum_quantity' => :'maximum_quantity',
         :'minimum_quantity' => :'minimum_quantity',
@@ -57,6 +61,7 @@ module UltracartClient
       {
         :'exclude_coupon' => :'BOOLEAN',
         :'exclude_from_free_promotion' => :'BOOLEAN',
+        :'exclude_from_loyalty' => :'BOOLEAN',
         :'items' => :'Array<ItemRestrictionItem>',
         :'maximum_quantity' => :'Integer',
         :'minimum_quantity' => :'Integer',
@@ -82,6 +87,10 @@ module UltracartClient
         self.exclude_from_free_promotion = attributes[:'exclude_from_free_promotion']
       end
 
+      if attributes.has_key?(:'exclude_from_loyalty')
+        self.exclude_from_loyalty = attributes[:'exclude_from_loyalty']
+      end
+
       if attributes.has_key?(:'items')
         if (value = attributes[:'items']).is_a?(Array)
           self.items = value
@@ -129,6 +138,7 @@ module UltracartClient
       self.class == o.class &&
           exclude_coupon == o.exclude_coupon &&
           exclude_from_free_promotion == o.exclude_from_free_promotion &&
+          exclude_from_loyalty == o.exclude_from_loyalty &&
           items == o.items &&
           maximum_quantity == o.maximum_quantity &&
           minimum_quantity == o.minimum_quantity &&
@@ -146,7 +156,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [exclude_coupon, exclude_from_free_promotion, items, maximum_quantity, minimum_quantity, multiple_quantity, one_per_customer, purchase_separately].hash
+      [exclude_coupon, exclude_from_free_promotion, exclude_from_loyalty, items, maximum_quantity, minimum_quantity, multiple_quantity, one_per_customer, purchase_separately].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.11.11'
+  VERSION = '3.11.13'
 end

data/lib/ultracart_api.rb

@@ -240,6 +240,8 @@ require 'ultracart_api/models/conversation_summary'
 require 'ultracart_api/models/conversation_twilio_account'
 require 'ultracart_api/models/conversation_virtual_agent_budget'
 require 'ultracart_api/models/conversation_virtual_agent_budget_response'
+require 'ultracart_api/models/conversation_virtual_agent_capabilities'
+require 'ultracart_api/models/conversation_virtual_agent_capabilities_response'
 require 'ultracart_api/models/conversation_webchat_context'
 require 'ultracart_api/models/conversation_webchat_queue_status'
 require 'ultracart_api/models/conversation_webchat_queue_status_agent'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.11.11
+  version: 3.11.13
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-19 00:00:00.000000000 Z
+date: 2025-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -450,6 +450,8 @@ files:
 - docs/ConversationTwilioAccount.md
 - docs/ConversationVirtualAgentBudget.md
 - docs/ConversationVirtualAgentBudgetResponse.md
+- docs/ConversationVirtualAgentCapabilities.md
+- docs/ConversationVirtualAgentCapabilitiesResponse.md
 - docs/ConversationWebchatContext.md
 - docs/ConversationWebchatQueueStatus.md
 - docs/ConversationWebchatQueueStatusAgent.md
@@ -1353,6 +1355,8 @@ files:
 - lib/ultracart_api/models/conversation_twilio_account.rb
 - lib/ultracart_api/models/conversation_virtual_agent_budget.rb
 - lib/ultracart_api/models/conversation_virtual_agent_budget_response.rb
+- lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb
+- lib/ultracart_api/models/conversation_virtual_agent_capabilities_response.rb
 - lib/ultracart_api/models/conversation_webchat_context.rb
 - lib/ultracart_api/models/conversation_webchat_queue_status.rb
 - lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb