supportify_client 0.0.4 → 1.0.0

data/lib/supportify_client/api/supportify_api.rb

@@ -0,0 +1,560 @@
+require "uri"
+
+module Supportify
+  class SupportifyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = nil)
+      @api_client = api_client || Configuration.api_client
+    end
+
+    # 
+    # Returns all categories from the application.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The maximum number of entries to return in the collection.
+    # @option opts [Integer] :skip The number of entries to skip over when returning the results.
+    # @option opts [String] :sort The sort order and method of the results.
+    # @return [Array<Category>]
+    def get_categories(opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#get_categories ..."
+      end
+      
+      # resource path
+      path = "/categories".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'skip'] = opts[:'skip'] if opts[:'skip']
+      query_params[:'sort'] = opts[:'sort'] if opts[:'sort']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Category>')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#get_categories. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # 
+    # Returns a category based on a single ID.
+    # @param id ID of category to fetch
+    # @param [Hash] opts the optional parameters
+    # @return [Category]
+    def get_category_by_id(id, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#get_category_by_id ..."
+      end
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling get_category_by_id" if id.nil?
+      
+      # resource path
+      path = "/categories/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Category')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#get_category_by_id. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # 
+    # Returns all content entries from the application.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :categories categories to filter by
+    # @option opts [Integer] :limit The maximum number of entries to return in the collection.
+    # @option opts [Integer] :skip The number of entries to skip over when returning the results.
+    # @option opts [String] :sort The sort order and method of the results.
+    # @option opts [Array<String>] :tags tags to filter by
+    # @return [Array<Faq>]
+    def get_faqs(opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#get_faqs ..."
+      end
+      
+      # resource path
+      path = "/faqs".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'categories'] = opts[:'categories'] if opts[:'categories']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'skip'] = opts[:'skip'] if opts[:'skip']
+      query_params[:'sort'] = opts[:'sort'] if opts[:'sort']
+      query_params[:'tags'] = opts[:'tags'] if opts[:'tags']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Faq>')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#get_faqs. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # 
+    # Create a new content entry and add it to the application.
+    # @param answer The body of the content entry.  Can be an answer to a FAQ, a knowledge base entry, or any other type of string.  This is a non-encoded string and may contain HTML.
+    # @param author The e-mail address of the user that created the content entry.  This e-mail address must correspond to a user on your Supportify account.
+    # @param question The title of the content entry.  Can be a question, a title, or any other type of string.  This is a non-encoded string and may contain HTML.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :categories The categories that the content entry belongs to.
+    # @option opts [String] :format The format of the content that has been posted. Currently, the only accepted values are &#39;markdown&#39; and &#39;html&#39;.
+    # @option opts [Array<String>] :tags The tags that the content entry belongs to.
+    # @return [nil]
+    def create_faq(answer, author, question, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#create_faq ..."
+      end
+      
+      # verify the required parameter 'answer' is set
+      fail "Missing the required parameter 'answer' when calling create_faq" if answer.nil?
+      
+      # verify the required parameter 'author' is set
+      fail "Missing the required parameter 'author' when calling create_faq" if author.nil?
+      
+      # verify the required parameter 'question' is set
+      fail "Missing the required parameter 'question' when calling create_faq" if question.nil?
+      
+      # resource path
+      path = "/faqs".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+      form_params["answer"] = answer
+      form_params["author"] = author
+      form_params["question"] = question
+      form_params["categories"] = opts[:'categories'] if opts[:'categories']
+      form_params["format"] = opts[:'format'] if opts[:'format']
+      form_params["tags"] = opts[:'tags'] if opts[:'tags']
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      @api_client.call_api(:POST, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#create_faq"
+      end
+      return nil
+    end
+
+    # 
+    # Returns a content entry based on a single ID.
+    # @param id ID of the content entry to fetch.
+    # @param [Hash] opts the optional parameters
+    # @return [Faq]
+    def get_faq_by_id(id, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#get_faq_by_id ..."
+      end
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling get_faq_by_id" if id.nil?
+      
+      # resource path
+      path = "/faqs/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Faq')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#get_faq_by_id. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # 
+    # Record a vote for a content entry.
+    # @param id ID of the content entry to record the vote for.
+    # @param vote The direction of the vote to be recorded.  Currently, the only accepted values are &#39;up&#39; and &#39;down&#39;.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def vote_on_faq(id, vote, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#vote_on_faq ..."
+      end
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling vote_on_faq" if id.nil?
+      
+      # verify the required parameter 'vote' is set
+      fail "Missing the required parameter 'vote' when calling vote_on_faq" if vote.nil?
+      
+      # resource path
+      path = "/faqs/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+      form_params["vote"] = vote
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      @api_client.call_api(:POST, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#vote_on_faq"
+      end
+      return nil
+    end
+
+    # 
+    # The Info endpoint returns an information object containing details of the application being accessed.\n\nThis endpoint is mostly used for diagnostic purposes.
+    # @param [Hash] opts the optional parameters
+    # @return [Info]
+    def get_info(opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#get_info ..."
+      end
+      
+      # resource path
+      path = "/info".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Info')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#get_info. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # 
+    # Search for a collection of content entries that match the supplied query.
+    # @param query The string to match the content entry against.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :categories categories to filter by
+    # @option opts [Integer] :limit The maximum number of entries to return in the collection.
+    # @option opts [Integer] :skip The number of entries to skip over when returning the results.
+    # @option opts [Array<String>] :tags tags to filter by
+    # @return [Array<Faq>]
+    def search(query, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#search ..."
+      end
+      
+      # verify the required parameter 'query' is set
+      fail "Missing the required parameter 'query' when calling search" if query.nil?
+      
+      # resource path
+      path = "/search".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'query'] = query
+      query_params[:'categories'] = opts[:'categories'] if opts[:'categories']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'skip'] = opts[:'skip'] if opts[:'skip']
+      query_params[:'tags'] = opts[:'tags'] if opts[:'tags']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Faq>')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#search. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # 
+    # Returns all tags from the application.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The maximum number of entries to return in the collection.
+    # @option opts [Integer] :skip The number of entries to skip over when returning the results.
+    # @option opts [String] :sort The sort order and method of the results.
+    # @return [Array<Tag>]
+    def get_tags(opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#get_tags ..."
+      end
+      
+      # resource path
+      path = "/tags".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'skip'] = opts[:'skip'] if opts[:'skip']
+      query_params[:'sort'] = opts[:'sort'] if opts[:'sort']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<Tag>')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#get_tags. Result: #{result.inspect}"
+      end
+      return result
+    end
+
+    # 
+    # Returns a tag based on a single ID.
+    # @param id ID of tag to fetch
+    # @param [Hash] opts the optional parameters
+    # @return [Tag]
+    def get_tag_by_id(id, opts = {})
+      if Configuration.debugging
+        Configuration.logger.debug "Calling API: SupportifyApi#get_tag_by_id ..."
+      end
+      
+      # verify the required parameter 'id' is set
+      fail "Missing the required parameter 'id' when calling get_tag_by_id" if id.nil?
+      
+      # resource path
+      path = "/tags/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      _header_accept = ['application/json']
+      _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
+
+      # HTTP header 'Content-Type'
+      _header_content_type = []
+      header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+
+      auth_names = ['api_key', 'app_key']
+      result = @api_client.call_api(:GET, path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Tag')
+      if Configuration.debugging
+        Configuration.logger.debug "API called: SupportifyApi#get_tag_by_id. Result: #{result.inspect}"
+      end
+      return result
+    end
+  end
+end
+
+
+
+