ultracart_api 4.1.22 → 4.1.23

data/lib/ultracart_api/api/conversation_api.rb

@@ -32,6 +32,76 @@ module UltracartClient
       UltracartClient::ConversationApi.new(api_client)
     end
 
+    # Delete a knowledge base document
+    # Delete a knowledge base document 
+    # @param user_id [Integer] 
+    # @param document_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationDeleteKnowledgeBaseDocumentResponse]
+    def delete_agent_profile_knowledge_base_document(user_id, document_uuid, opts = {})
+      data, _status_code, _headers = delete_agent_profile_knowledge_base_document_with_http_info(user_id, document_uuid, opts)
+      data
+    end
+
+    # Delete a knowledge base document
+    # Delete a knowledge base document 
+    # @param user_id [Integer] 
+    # @param document_uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationDeleteKnowledgeBaseDocumentResponse, Integer, Hash)>] ConversationDeleteKnowledgeBaseDocumentResponse data, response status code and response headers
+    def delete_agent_profile_knowledge_base_document_with_http_info(user_id, document_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.delete_agent_profile_knowledge_base_document ...'
+      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.delete_agent_profile_knowledge_base_document"
+      end
+      # verify the required parameter 'document_uuid' is set
+      if @api_client.config.client_side_validation && document_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'document_uuid' when calling ConversationApi.delete_agent_profile_knowledge_base_document"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles/{user_id}/knowledge_base/{document_uuid}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'document_uuid' + '}', CGI.escape(document_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] || 'ConversationDeleteKnowledgeBaseDocumentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.delete_agent_profile_knowledge_base_document",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversationApi#delete_agent_profile_knowledge_base_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete a conversation canned message
     # Delete a conversation canned message 
     # @param conversation_canned_message_oid [Integer] 
@@ -858,6 +928,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get the list of knowledge base documents associated with this agent profile
+    # Retrieve knowledge base documents 
+    # @param user_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationKnowledgeBaseDocumentsResponse]
+    def get_agent_profile_knowledge_base(user_id, opts = {})
+      data, _status_code, _headers = get_agent_profile_knowledge_base_with_http_info(user_id, opts)
+      data
+    end
+
+    # Get the list of knowledge base documents associated with this agent profile
+    # Retrieve knowledge base documents 
+    # @param user_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationKnowledgeBaseDocumentsResponse, Integer, Hash)>] ConversationKnowledgeBaseDocumentsResponse data, response status code and response headers
+    def get_agent_profile_knowledge_base_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_agent_profile_knowledge_base ...'
+      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_knowledge_base"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles/{user_id}/knowledge_base'.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] || 'ConversationKnowledgeBaseDocumentsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_agent_profile_knowledge_base",
+        :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_knowledge_base\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
@@ -1401,6 +1535,76 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get a pre-signed conversation knowledge base document upload URL
+    # Get a pre-signed conversation knowledge base document upload URL 
+    # @param user_id [Integer] 
+    # @param extension [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationKnowledgeBaseDocumentUploadUrlResponse]
+    def get_conversation_knowledge_base_document_upload_url(user_id, extension, opts = {})
+      data, _status_code, _headers = get_conversation_knowledge_base_document_upload_url_with_http_info(user_id, extension, opts)
+      data
+    end
+
+    # Get a pre-signed conversation knowledge base document upload URL
+    # Get a pre-signed conversation knowledge base document upload URL 
+    # @param user_id [Integer] 
+    # @param extension [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationKnowledgeBaseDocumentUploadUrlResponse, Integer, Hash)>] ConversationKnowledgeBaseDocumentUploadUrlResponse data, response status code and response headers
+    def get_conversation_knowledge_base_document_upload_url_with_http_info(user_id, extension, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_knowledge_base_document_upload_url ...'
+      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_conversation_knowledge_base_document_upload_url"
+      end
+      # verify the required parameter 'extension' is set
+      if @api_client.config.client_side_validation && extension.nil?
+        fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_knowledge_base_document_upload_url"
+      end
+      # resource path
+      local_var_path = '/conversation//rest/v2/conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension}'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s)).sub('{' + 'extension' + '}', CGI.escape(extension.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] || 'ConversationKnowledgeBaseDocumentUploadUrlResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.get_conversation_knowledge_base_document_upload_url",
+        :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_conversation_knowledge_base_document_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve conversation messages
     # Retrieve conversation messages since a particular time 
     # @param conversation_uuid [String] 
@@ -3465,6 +3669,81 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Insert a knowledge base document
+    # Insert a knowledge base document 
+    # @param user_id [Integer] 
+    # @param knowledge_base_document_request [ConversationInsertKnowledgeBaseDocumentRequest] Insert request
+    # @param [Hash] opts the optional parameters
+    # @return [ConversationInsertKnowledgeBaseDocumentResponse]
+    def insert_agent_profile_knowledge_base_document(user_id, knowledge_base_document_request, opts = {})
+      data, _status_code, _headers = insert_agent_profile_knowledge_base_document_with_http_info(user_id, knowledge_base_document_request, opts)
+      data
+    end
+
+    # Insert a knowledge base document
+    # Insert a knowledge base document 
+    # @param user_id [Integer] 
+    # @param knowledge_base_document_request [ConversationInsertKnowledgeBaseDocumentRequest] Insert request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConversationInsertKnowledgeBaseDocumentResponse, Integer, Hash)>] ConversationInsertKnowledgeBaseDocumentResponse data, response status code and response headers
+    def insert_agent_profile_knowledge_base_document_with_http_info(user_id, knowledge_base_document_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversationApi.insert_agent_profile_knowledge_base_document ...'
+      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_knowledge_base_document"
+      end
+      # verify the required parameter 'knowledge_base_document_request' is set
+      if @api_client.config.client_side_validation && knowledge_base_document_request.nil?
+        fail ArgumentError, "Missing the required parameter 'knowledge_base_document_request' when calling ConversationApi.insert_agent_profile_knowledge_base_document"
+      end
+      # resource path
+      local_var_path = '/conversation/agent/profiles/{user_id}/knowledge_base'.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(knowledge_base_document_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConversationInsertKnowledgeBaseDocumentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ConversationApi.insert_agent_profile_knowledge_base_document",
+        :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_knowledge_base_document\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

data/lib/ultracart_api/api/customer_api.rb

@@ -251,10 +251,10 @@ module UltracartClient
     # @param customer_profile_oid [Integer] The customer oid for this wishlist.
     # @param customer_wishlist_item_oid [Integer] The wishlist oid for this wishlist item to delete.
     # @param [Hash] opts the optional parameters
-    # @return [CustomerWishListItem]
+    # @return [nil]
     def delete_wish_list_item(customer_profile_oid, customer_wishlist_item_oid, opts = {})
-      data, _status_code, _headers = delete_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid, opts)
-      data
+      delete_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid, opts)
+      nil
     end
 
     # Delete a customer wishlist item
@@ -262,7 +262,7 @@ module UltracartClient
     # @param customer_profile_oid [Integer] The customer oid for this wishlist.
     # @param customer_wishlist_item_oid [Integer] The wishlist oid for this wishlist item to delete.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CustomerWishListItem, Integer, Hash)>] CustomerWishListItem data, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: CustomerApi.delete_wish_list_item ...'
@@ -294,7 +294,7 @@ module UltracartClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'CustomerWishListItem'
+      return_type = opts[:debug_return_type]
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

data/lib/ultracart_api/models/conversation_delete_knowledge_base_document_response.rb

@@ -0,0 +1,256 @@
+=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 ConversationDeleteKnowledgeBaseDocumentResponse
+    attr_accessor :document_id
+
+    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
+      {
+        :'document_id' => :'document_id',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    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
+      {
+        :'document_id' => :'String',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    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::ConversationDeleteKnowledgeBaseDocumentResponse` 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::ConversationDeleteKnowledgeBaseDocumentResponse`. 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?(:'document_id')
+        self.document_id = attributes[:'document_id']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.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 &&
+          document_id == o.document_id &&
+          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 [Integer] Hash code
+    def hash
+      [document_id, 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 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