ultracart_api 4.1.147 → 4.1.148

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 490ac8086f81d0ada26de478aa8456404659ba28b4589f778117e1aeab05d043
-  data.tar.gz: c3df95b939b310dbd25c9b24e02c2004c2a540787506fb01f49c4b2413c08b37
+  metadata.gz: ba4977a62acb33c11fa5fc16903ffa679e996f053ca6c5920f6d2f8c450c6cce
+  data.tar.gz: f8805e823b86f7ae7b56b86e2ab8dd52aec339076104437c81cfed9610dab404
 SHA512:
-  metadata.gz: 4115a13993932d0c78cc857bc053e96586797d97dc8b7a22e860f889ea0f33acd854f07d6c08994bf0b37b8c3f47d2852348bb684fd67ef427222538d6a2547b
-  data.tar.gz: a7022fa9cf5acd43820c5383d55559046f586440d728b496da373d4c508f9f626a1e689084c1935b405014dbee3306eee752c7d2ac66d89cbbe99797287ef5b4
+  metadata.gz: 5c2d29199eb34ebb2d86c3071c7c185ffaf2f077f8206be73906468424bd21406c26615c26daec6a3e443022dabb5b1fd66cb5a01a2a5b069171d6439af75702
+  data.tar.gz: d51e2f0a95eea2719be0767245cb3a203dbf13b79f2627169165c317f91e9e134a948b4dcee4c70d00319f4b165a0200270b64857bb2955334f964e31999e442

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.147
+- Package version: 4.1.148
 - 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.147'
+gem 'ultracart_api', '4.1.148'
 ```
 
 install:
@@ -1084,6 +1084,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::ConversationVirtualAgentBudgetResponse](docs/ConversationVirtualAgentBudgetResponse.md)
  - [UltracartClient::ConversationVirtualAgentCapabilities](docs/ConversationVirtualAgentCapabilities.md)
  - [UltracartClient::ConversationVirtualAgentCapabilitiesResponse](docs/ConversationVirtualAgentCapabilitiesResponse.md)
+ - [UltracartClient::ConversationVirtualAgentCapabilityCustomCollection](docs/ConversationVirtualAgentCapabilityCustomCollection.md)
  - [UltracartClient::ConversationVirtualAgentCapabilityZohoDeskDepartment](docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md)
  - [UltracartClient::ConversationWebchatContext](docs/ConversationWebchatContext.md)
  - [UltracartClient::ConversationWebchatQueueStatus](docs/ConversationWebchatQueueStatus.md)
@@ -1927,6 +1928,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.148 | 09/04/2026 | conversations - added ai agent capabilities |
 | 4.1.147 | 09/04/2026 | sfvb - internal testing |
 | 4.1.146 | 09/03/2026 | sfvb - internal testing |
 | 4.1.145 | 09/02/2026 | sfvb - internal testing |

data/docs/ConversationVirtualAgentCapabilities.md

@@ -4,8 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **access_custom_collections** | **Boolean** | Permission flag to allow this Agent to search the merchant's custom Typesense collections. | [optional] |
 | **access_storefront_and_item** | **Boolean** | Permission flag to allow this Agent access to the storefront and item information. | [optional] |
 | **cancel_subscription** | **Boolean** |  | [optional] |
+| **custom_collection_oids** | **Object** | The custom collections this Agent is allowed to search.  Empty means none, even when access_custom_collections is true. | [optional] |
+| **custom_collections** | [**Array<ConversationVirtualAgentCapabilityCustomCollection>**](ConversationVirtualAgentCapabilityCustomCollection.md) | Read only.  All of the merchant's custom collections, to populate the selection list for custom_collection_oids.  Changes here are ignored. | [optional] |
 | **delay_subscription** | **Boolean** |  | [optional] |
 | **generate_coupon** | **Boolean** | Permission flag to allow this Agent to generate coupons based upon the agent prompt instructions | [optional] |
 | **lookup_order_information** | **Boolean** |  | [optional] |
@@ -27,8 +30,11 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ConversationVirtualAgentCapabilities.new(
+  access_custom_collections: null,
   access_storefront_and_item: null,
   cancel_subscription: null,
+  custom_collection_oids: null,
+  custom_collections: null,
   delay_subscription: null,
   generate_coupon: null,
   lookup_order_information: null,

data/docs/ConversationVirtualAgentCapabilityCustomCollection.md

@@ -0,0 +1,30 @@
+# UltracartClient::ConversationVirtualAgentCapabilityCustomCollection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ai_description** | **String** | Merchant authored description of what is in this collection, which is what the agent sees when deciding whether to search it | [optional] |
+| **ai_enabled** | **Boolean** | True if this collection has been enabled for AI access in its own configuration.  A collection that is not enabled cannot be searched even if it is selected here. | [optional] |
+| **collection_name** | **String** | Merchant assigned name of the collection | [optional] |
+| **error_message** | **String** | Error from the last build, if it failed.  A collection with an error will return nothing to the agent, so this is worth surfacing next to the selection. | [optional] |
+| **last_update_dts** | **String** | Date/time the collection was last rebuilt from the merchant's BigQuery query | [optional] |
+| **record_count** | **Integer** | Number of records loaded on the last build | [optional] |
+| **typesense_custom_collection_oid** | **Integer** | The identifier to place in custom_collection_oids to grant the agent access to this collection | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationVirtualAgentCapabilityCustomCollection.new(
+  ai_description: null,
+  ai_enabled: null,
+  collection_name: null,
+  error_message: null,
+  last_update_dts: null,
+  record_count: null,
+  typesense_custom_collection_oid: null
+)
+```
+

data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb

@@ -15,11 +15,20 @@ require 'time'
 
 module UltracartClient
   class ConversationVirtualAgentCapabilities
+    # Permission flag to allow this Agent to search the merchant's custom Typesense collections.
+    attr_accessor :access_custom_collections
+
     # Permission flag to allow this Agent access to the storefront and item information.
     attr_accessor :access_storefront_and_item
 
     attr_accessor :cancel_subscription
 
+    # The custom collections this Agent is allowed to search.  Empty means none, even when access_custom_collections is true.
+    attr_accessor :custom_collection_oids
+
+    # Read only.  All of the merchant's custom collections, to populate the selection list for custom_collection_oids.  Changes here are ignored.
+    attr_accessor :custom_collections
+
     attr_accessor :delay_subscription
 
     # Permission flag to allow this Agent to generate coupons based upon the agent prompt instructions
@@ -79,8 +88,11 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'access_custom_collections' => :'access_custom_collections',
         :'access_storefront_and_item' => :'access_storefront_and_item',
         :'cancel_subscription' => :'cancel_subscription',
+        :'custom_collection_oids' => :'custom_collection_oids',
+        :'custom_collections' => :'custom_collections',
         :'delay_subscription' => :'delay_subscription',
         :'generate_coupon' => :'generate_coupon',
         :'lookup_order_information' => :'lookup_order_information',
@@ -106,8 +118,11 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'access_custom_collections' => :'Boolean',
         :'access_storefront_and_item' => :'Boolean',
         :'cancel_subscription' => :'Boolean',
+        :'custom_collection_oids' => :'Object',
+        :'custom_collections' => :'Array<ConversationVirtualAgentCapabilityCustomCollection>',
         :'delay_subscription' => :'Boolean',
         :'generate_coupon' => :'Boolean',
         :'lookup_order_information' => :'Boolean',
@@ -146,6 +161,10 @@ module UltracartClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'access_custom_collections')
+        self.access_custom_collections = attributes[:'access_custom_collections']
+      end
+
       if attributes.key?(:'access_storefront_and_item')
         self.access_storefront_and_item = attributes[:'access_storefront_and_item']
       end
@@ -154,6 +173,16 @@ module UltracartClient
         self.cancel_subscription = attributes[:'cancel_subscription']
       end
 
+      if attributes.key?(:'custom_collection_oids')
+        self.custom_collection_oids = attributes[:'custom_collection_oids']
+      end
+
+      if attributes.key?(:'custom_collections')
+        if (value = attributes[:'custom_collections']).is_a?(Array)
+          self.custom_collections = value
+        end
+      end
+
       if attributes.key?(:'delay_subscription')
         self.delay_subscription = attributes[:'delay_subscription']
       end
@@ -243,8 +272,11 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          access_custom_collections == o.access_custom_collections &&
           access_storefront_and_item == o.access_storefront_and_item &&
           cancel_subscription == o.cancel_subscription &&
+          custom_collection_oids == o.custom_collection_oids &&
+          custom_collections == o.custom_collections &&
           delay_subscription == o.delay_subscription &&
           generate_coupon == o.generate_coupon &&
           lookup_order_information == o.lookup_order_information &&
@@ -270,7 +302,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [access_storefront_and_item, cancel_subscription, delay_subscription, generate_coupon, lookup_order_information, lookup_subscription_information, open_support_ticket, open_support_ticket_channel, open_support_ticket_channel_email, open_support_ticket_zoho_desk_department_id, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card, zoho_desk_available, zoho_desk_departments].hash
+      [access_custom_collections, access_storefront_and_item, cancel_subscription, custom_collection_oids, custom_collections, delay_subscription, generate_coupon, lookup_order_information, lookup_subscription_information, open_support_ticket, open_support_ticket_channel, open_support_ticket_channel_email, open_support_ticket_zoho_desk_department_id, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card, zoho_desk_available, zoho_desk_departments].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_virtual_agent_capability_custom_collection.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 ConversationVirtualAgentCapabilityCustomCollection
+    # Merchant authored description of what is in this collection, which is what the agent sees when deciding whether to search it
+    attr_accessor :ai_description
+
+    # True if this collection has been enabled for AI access in its own configuration.  A collection that is not enabled cannot be searched even if it is selected here.
+    attr_accessor :ai_enabled
+
+    # Merchant assigned name of the collection
+    attr_accessor :collection_name
+
+    # Error from the last build, if it failed.  A collection with an error will return nothing to the agent, so this is worth surfacing next to the selection.
+    attr_accessor :error_message
+
+    # Date/time the collection was last rebuilt from the merchant's BigQuery query
+    attr_accessor :last_update_dts
+
+    # Number of records loaded on the last build
+    attr_accessor :record_count
+
+    # The identifier to place in custom_collection_oids to grant the agent access to this collection
+    attr_accessor :typesense_custom_collection_oid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ai_description' => :'ai_description',
+        :'ai_enabled' => :'ai_enabled',
+        :'collection_name' => :'collection_name',
+        :'error_message' => :'error_message',
+        :'last_update_dts' => :'last_update_dts',
+        :'record_count' => :'record_count',
+        :'typesense_custom_collection_oid' => :'typesense_custom_collection_oid'
+      }
+    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
+      {
+        :'ai_description' => :'String',
+        :'ai_enabled' => :'Boolean',
+        :'collection_name' => :'String',
+        :'error_message' => :'String',
+        :'last_update_dts' => :'String',
+        :'record_count' => :'Integer',
+        :'typesense_custom_collection_oid' => :'Integer'
+      }
+    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::ConversationVirtualAgentCapabilityCustomCollection` 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::ConversationVirtualAgentCapabilityCustomCollection`. 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?(:'ai_description')
+        self.ai_description = attributes[:'ai_description']
+      end
+
+      if attributes.key?(:'ai_enabled')
+        self.ai_enabled = attributes[:'ai_enabled']
+      end
+
+      if attributes.key?(:'collection_name')
+        self.collection_name = attributes[:'collection_name']
+      end
+
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      end
+
+      if attributes.key?(:'last_update_dts')
+        self.last_update_dts = attributes[:'last_update_dts']
+      end
+
+      if attributes.key?(:'record_count')
+        self.record_count = attributes[:'record_count']
+      end
+
+      if attributes.key?(:'typesense_custom_collection_oid')
+        self.typesense_custom_collection_oid = attributes[:'typesense_custom_collection_oid']
+      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 &&
+          ai_description == o.ai_description &&
+          ai_enabled == o.ai_enabled &&
+          collection_name == o.collection_name &&
+          error_message == o.error_message &&
+          last_update_dts == o.last_update_dts &&
+          record_count == o.record_count &&
+          typesense_custom_collection_oid == o.typesense_custom_collection_oid
+    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
+      [ai_description, ai_enabled, collection_name, error_message, last_update_dts, record_count, typesense_custom_collection_oid].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/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.147'
+  VERSION = '4.1.148'
 end

data/lib/ultracart_api.rb

@@ -338,6 +338,7 @@ 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_virtual_agent_capability_custom_collection'
 require 'ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department'
 require 'ultracart_api/models/conversation_webchat_context'
 require 'ultracart_api/models/conversation_webchat_queue_status'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.1.147
+  version: 4.1.148
 platform: ruby
 authors:
 - UltraCart
@@ -389,6 +389,7 @@ files:
 - docs/ConversationVirtualAgentBudgetResponse.md
 - docs/ConversationVirtualAgentCapabilities.md
 - docs/ConversationVirtualAgentCapabilitiesResponse.md
+- docs/ConversationVirtualAgentCapabilityCustomCollection.md
 - docs/ConversationVirtualAgentCapabilityZohoDeskDepartment.md
 - docs/ConversationWebchatContext.md
 - docs/ConversationWebchatQueueStatus.md
@@ -1524,6 +1525,7 @@ files:
 - 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_virtual_agent_capability_custom_collection.rb
 - lib/ultracart_api/models/conversation_virtual_agent_capability_zoho_desk_department.rb
 - lib/ultracart_api/models/conversation_webchat_context.rb
 - lib/ultracart_api/models/conversation_webchat_queue_status.rb