ultracart_api 4.1.29 → 4.1.30

data/lib/ultracart_api/api/conversation_api.rb

@@ -992,6 +992,140 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get an MCP server associated with this agent
+    # Retrieve MCP server associated with this agent 
+    # @param user_id [Integer] 
+    # @param mcp_server_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationMcpServerResponse]
+    def get_agent_profile_mcp(user_id, mcp_server_uuid, opts = {})
+      data, _status_code, _headers = get_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, opts)
+      data
+    end
+
+    # Get an MCP server associated with this agent
+    # Retrieve MCP server associated with this agent 
+    # @param user_id [Integer] 
+    # @param mcp_server_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationMcpServerResponse, Integer, Hash)>] ConversationMcpServerResponse data, response status code and response headers
+    def get_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_profile_mcp ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.get_agent_profile_mcp"
+      end
+      # verify the required parameter 'mcp_server_uuid' is set
+      if @api_client.config.client_side_validation && mcp_server_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'mcp_server_uuid' when calling ConversationApi.get_agent_profile_mcp"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'mcp_server_uuid' + '}', CGI.escape(mcp_server_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationMcpServerResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_agent_profile_mcp",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_agent_profile_mcp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the list of MCP servers associated with this agent
+    # Retrieve MCP servers associated with this agent 
+    # @param user_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationMcpServersResponse]
+    def get_agent_profile_mcps(user_id, opts = {})
+      data, _status_code, _headers = get_agent_profile_mcps_with_http_info(user_id, opts)
+      data
+    end
+
+    # Get the list of MCP servers associated with this agent
+    # Retrieve MCP servers associated with this agent 
+    # @param user_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationMcpServersResponse, Integer, Hash)>] ConversationMcpServersResponse data, response status code and response headers
+    def get_agent_profile_mcps_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_profile_mcps ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.get_agent_profile_mcps"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles/{user_id}/mcps'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationMcpServersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_agent_profile_mcps",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#get_agent_profile_mcps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get agent profiles
     # Retrieve the agents profile 
     # @param [Hash] opts the optional parameters
@@ -3744,6 +3878,81 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Insert an agent MCP server
+    # Insert an agent MCP server 
+    # @param user_id [Integer] 
+    # @param mcp_server [ConversationMcpServer] MCP Server
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationMcpServerResponse]
+    def insert_agent_profile_mcp(user_id, mcp_server, opts = {})
+      data, _status_code, _headers = insert_agent_profile_mcp_with_http_info(user_id, mcp_server, opts)
+      data
+    end
+
+    # Insert an agent MCP server
+    # Insert an agent MCP server 
+    # @param user_id [Integer] 
+    # @param mcp_server [ConversationMcpServer] MCP Server
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationMcpServerResponse, Integer, Hash)>] ConversationMcpServerResponse data, response status code and response headers
+    def insert_agent_profile_mcp_with_http_info(user_id, mcp_server, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.insert_agent_profile_mcp ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.insert_agent_profile_mcp"
+      end
+      # verify the required parameter 'mcp_server' is set
+      if @api_client.config.client_side_validation && mcp_server.nil?
+        fail ArgumentError, "Missing the required parameter 'mcp_server' when calling ConversationApi.insert_agent_profile_mcp"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles/{user_id}/mcps'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(mcp_server)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationMcpServerResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.insert_agent_profile_mcp",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#insert_agent_profile_mcp\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 [ConversationCannedMessage] Canned message
@@ -5033,6 +5242,87 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Update an agent MCP server
+    # Update an agent MCP server 
+    # @param user_id [Integer] 
+    # @param mcp_server_uuid [String] 
+    # @param mcp_server [ConversationMcpServer] MCP Server
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationMcpServerResponse]
+    def update_agent_profile_mcp(user_id, mcp_server_uuid, mcp_server, opts = {})
+      data, _status_code, _headers = update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server, opts)
+      data
+    end
+
+    # Update an agent MCP server
+    # Update an agent MCP server 
+    # @param user_id [Integer] 
+    # @param mcp_server_uuid [String] 
+    # @param mcp_server [ConversationMcpServer] MCP Server
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationMcpServerResponse, Integer, Hash)>] ConversationMcpServerResponse data, response status code and response headers
+    def update_agent_profile_mcp_with_http_info(user_id, mcp_server_uuid, mcp_server, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.update_agent_profile_mcp ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling ConversationApi.update_agent_profile_mcp"
+      end
+      # verify the required parameter 'mcp_server_uuid' is set
+      if @api_client.config.client_side_validation && mcp_server_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'mcp_server_uuid' when calling ConversationApi.update_agent_profile_mcp"
+      end
+      # verify the required parameter 'mcp_server' is set
+      if @api_client.config.client_side_validation && mcp_server.nil?
+        fail ArgumentError, "Missing the required parameter 'mcp_server' when calling ConversationApi.update_agent_profile_mcp"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'mcp_server_uuid' + '}', CGI.escape(mcp_server_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(mcp_server)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationMcpServerResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.update_agent_profile_mcp",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#update_agent_profile_mcp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a canned message
     # Update a canned message 
     # @param conversation_canned_message_oid [Integer] 

data/lib/ultracart_api/models/conversation_mcp_server.rb

@@ -0,0 +1,324 @@
+=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 ConversationMcpServer
+    # Authorization Method
+    attr_accessor :auth_method
+
+    # Basic password
+    attr_accessor :basic_password
+
+    # Basic user name
+    attr_accessor :basic_user_name
+
+    # Header name
+    attr_accessor :header_name
+
+    # Header value
+    attr_accessor :header_value
+
+    # UUID of the MCP server configuration
+    attr_accessor :mcp_server_uuid
+
+    # Priority on which the MCP server tools are incorporated into the model.  Lower number comes first
+    attr_accessor :priority
+
+    # URL to the MCP server (must be https)
+    attr_accessor :url
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'auth_method' => :'auth_method',
+        :'basic_password' => :'basic_password',
+        :'basic_user_name' => :'basic_user_name',
+        :'header_name' => :'header_name',
+        :'header_value' => :'header_value',
+        :'mcp_server_uuid' => :'mcp_server_uuid',
+        :'priority' => :'priority',
+        :'url' => :'url'
+      }
+    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
+      {
+        :'auth_method' => :'String',
+        :'basic_password' => :'String',
+        :'basic_user_name' => :'String',
+        :'header_name' => :'String',
+        :'header_value' => :'String',
+        :'mcp_server_uuid' => :'String',
+        :'priority' => :'Integer',
+        :'url' => :'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::ConversationMcpServer` 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::ConversationMcpServer`. 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?(:'auth_method')
+        self.auth_method = attributes[:'auth_method']
+      end
+
+      if attributes.key?(:'basic_password')
+        self.basic_password = attributes[:'basic_password']
+      end
+
+      if attributes.key?(:'basic_user_name')
+        self.basic_user_name = attributes[:'basic_user_name']
+      end
+
+      if attributes.key?(:'header_name')
+        self.header_name = attributes[:'header_name']
+      end
+
+      if attributes.key?(:'header_value')
+        self.header_value = attributes[:'header_value']
+      end
+
+      if attributes.key?(:'mcp_server_uuid')
+        self.mcp_server_uuid = attributes[:'mcp_server_uuid']
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      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?
+      auth_method_validator = EnumAttributeValidator.new('String', ["none", "header", "basic"])
+      return false unless auth_method_validator.valid?(@auth_method)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] auth_method Object to be assigned
+    def auth_method=(auth_method)
+      validator = EnumAttributeValidator.new('String', ["none", "header", "basic"])
+      unless validator.valid?(auth_method)
+        fail ArgumentError, "invalid value for \"auth_method\", must be one of #{validator.allowable_values}."
+      end
+      @auth_method = auth_method
+    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 &&
+          auth_method == o.auth_method &&
+          basic_password == o.basic_password &&
+          basic_user_name == o.basic_user_name &&
+          header_name == o.header_name &&
+          header_value == o.header_value &&
+          mcp_server_uuid == o.mcp_server_uuid &&
+          priority == o.priority &&
+          url == o.url
+    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
+      [auth_method, basic_password, basic_user_name, header_name, header_value, mcp_server_uuid, priority, url].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