mints 0.0.1 → 0.0.6

data/lib/user.rb

@@ -1,9 +1,35 @@
 require_relative './client.rb'
 module Mints
+  ##
+  # == User context API
+  # User class contains functions that needs an API key and a session token as authentication
+  # == Usage example
+  # Initialize
+  #     client = Mints::User.new(mints_url, api_key)
+  # Call any function
+  #     client.get_contacts
+  # == Single resource options
+  # * +include+ - [String] include a relationship
+  # * +attributes+ - [Boolean] attach attributes to response
+  # * +categories+ - [Boolean] attach categories to response
+  # * +tags+ - [Boolean] attach tags to response
+  # == Resource collections options 
+  # * +search+ - [String] filter by a search word
+  # * +scopes+ - [String] filter by a scope
+  # * +filters+ - [String] filter by where clauses
+  # * +jfilters+ - [String] filter using complex condition objects
+  # * +catfilters+ - [String] filter by categories
+  # * +fields+ - [String] indicates the columns that will be selected
+  # * +sort+ - [String] indicates the columns that will be selected
+  # * +include+ - [String] include a relationship
+  # * +attributes+ - [Boolean] attach attributes to response
+  # * +categories+ - [Boolean] attach categories to response
+  # * +taxonomies+ - [Boolean] attach categories to response
+  # * +tags+ - [Boolean] attach tags to response
   class User
     attr_reader :client
-    def initialize(host, api_key, session_token = nil)
-      @client = Mints::Client.new(host, api_key, 'user', session_token)
+    def initialize(host, api_key, session_token = nil, debug = false)
+      @client = Mints::Client.new(host, api_key, 'user', session_token, debug)
     end
 
     def login(email, password)
@@ -11,165 +37,371 @@ module Mints
         email: email,
         password: password,
       }
-      response = @client.raw("post", "/users/login", data, '/api/v1')
+      response = @client.raw("post", "/users/login", nil, data, '/api/v1')
       if response.key? "api_token"
         @client.session_token = response["api_token"]
       end
       return response
     end
     ######################################### CRM #########################################
-    ### Contacts ###
-    def get_contacts
-      return @client.get__crm__contacts
+    ##
+    # === Get contacts.
+    # Get a collection of contacts
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_contacts(options = nil)
+      return @client.get__crm__contacts(options)
     end
 
-    def get_contact(id)
-      return @client.get__crm__contacts(id)
+    def get_contact(id, options = nil)
+      return @client.get__crm__contacts(id, options)
     end
 
-    def create_contact(data)
-      return @client.create__crm__contacts(data)
+    def create_contact(data, options = nil)
+      return @client.create__crm__contacts(data, options)
     end
 
-    def update_contact(id, data)
-      return @client.update__crm__contacts(id, data)
+    def update_contact(id, data, options = nil)
+      return @client.update__crm__contacts(id, data, options)
     end
-    ### Companies ###
-    def get_companies
-      return @client.get__crm__companies
+    
+    # === Get companies.
+    # Get a collection of companies
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_companies(options = nil)
+      return @client.get__crm__companies(options)
     end
 
-    def get_company(id)
-      return @client.get__crm__companies(id)
+    def get_company(id, options = nil)
+      return @client.get__crm__companies(id, options)
     end
 
-    def create_company(data)
-      return @client.create__crm__companies(data)
+    def create_company(data, options = nil)
+      return @client.create__crm__companies(data, options)
     end
 
-    def update_company(id, data)
-      return @client.update__crm__companies(id, data)
+    def update_company(id, data, options = nil)
+      return @client.update__crm__companies(id, data, options)
     end
 
-    ### Deals ###
-    def get_deals
-      return @client.get__crm__deals
+    # === Get deals.
+    # Get a collection of deals
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_deals(options = nil)
+      return @client.get__crm__deals(options)
     end
 
-    def get_deal(id)
-      return @client.get__crm__deals(id)
+    def get_deal(id, options = nil)
+      return @client.get__crm__deals(id, options)
     end
 
-    def create_deal(data)
-      return @client.create__crm__deals(data)
+    def create_deal(data, options = nil)
+      return @client.create__crm__deals(data, options)
     end
 
-    def update_deal(id, data)
-      return @client.update__crm__deals(id, data)
+    def update_deal(id, data, options = nil)
+      return @client.update__crm__deals(id, data, options)
     end
 
     ######################################### Content #########################################
-    ### Stories ###
-    def get_stories
-      return @client.get__content__stories
+    # === Get stories.
+    # Get a collection of stories
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_stories(options = nil)
+      return @client.get__content__stories(options)
     end
 
-    def get_story(id)
-      return @client.get__content__stories(id)
+    def get_story(id, options = nil)
+      return @client.get__content__stories(id, options)
     end
 
-    def create_story(data)
-      return @client.create__content__stories(data)
+    def create_story(data, options = nil)
+      return @client.create__content__stories(data, options)
     end
 
-    def update_story(id, data)
-      return @client.update__content__stories(id, data)
+    def update_story(id, data, options = nil)
+      return @client.update__content__stories(id, data, options)
     end
 
-    ### Content instances ###
-    def get_content_instances
-      return @client.get__content__instances
+    # === Get story templates.
+    # Get a collection of story templates
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_story_templates(options = nil)
+      return @client.get__content__story_templates(options)
     end
 
-    def get_content_instance(id)
-      return @client.get__content__instances(id)
+    def get_story_template(id, options = nil)
+      return @client.get__content__story_templates(id, options)
     end
 
-    def create_content_instance(data)
-      return @client.create__content__instances(data)
+    def create_story_template(data, options = nil)
+      return @client.create__content__story_templates(data, options)
     end
 
-    def update_content_instance(id, data)
-      return @client.update__content__instances(id, data)
+    def update_story_template(id, data, options = nil)
+      return @client.update__content__story_templates(id, data, options)
     end
 
-    ### Content pages ###
-    def get_content_pages
-      return @client.get__content__pages
+    # === Get content instances.
+    # Get a collection of content instances
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_content_instances(options = nil)
+      return @client.get__content__instances(options)
     end
 
-    def get_content_page(id)
-      return @client.get__content__pages(id)
+    def get_content_instance(id, options = nil)
+      return @client.get__content__instances(id, options)
     end
 
-    def create_content_page(data)
-      return @client.create__content__pages(data)
+    def create_content_instance(data, options = nil)
+      return @client.create__content__instances(data, options)
     end
 
-    def update_content_page(id, data)
-      return @client.update__content__pages(id, data)
+    def update_content_instance(id, data, options = nil)
+      return @client.update__content__instances(id, data, options)
     end
 
-    ### Content templates ###
-    def get_content_templates
-      return @client.get__content__templates
+    # === Get content pages.
+    # Get a collection of content pages
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_content_pages(options = nil)
+      return @client.get__content__pages(options)
     end
 
-    def get_content_page(id)
-      return @client.get__content__templates(id)
+    def get_content_page(id, options = nil)
+      return @client.get__content__pages(id, options)
     end
 
-    def create_content_page(data)
-      return @client.create__content__templates(data)
+    def create_content_page(data, options = nil)
+      return @client.create__content__pages(data, options)
     end
 
-    def update_content_page(id, data)
-      return @client.update__content__templates(id, data)
+    def update_content_page(id, data, options = nil)
+      return @client.update__content__pages(id, data, options)
     end
 
-    ######################################### Ecommerce #########################################
-    ### Products ###
-    def get_products
-      return @client.get__ecommerce__products
+    # === Get content templates.
+    # Get a collection of content templates
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_content_templates(options = nil)
+      return @client.get__content__templates(options)
     end
 
-    def get_product(id)
-      return @client.get__ecommerce__products(id)
+    def get_content_template(id, options = nil)
+      return @client.get__content__templates(id, options)
     end
 
-    def create_product(data)
-      return @client.create__ecommerce__products(data)
+    def create_content_template(data, options = nil)
+      return @client.create__content__templates(data, options)
     end
 
-    def update_product(id, data)
-      return @client.update__ecommerce__products(id, data)
+    def update_content_template(id, data, options = nil)
+      return @client.update__content__templates(id, data, options)
     end
 
-    ### Locations ###
-    def get_locations
-      return @client.get__ecommerce__locations
+    # === Get products.
+    # Get a collection of products
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_products(options = nil)
+      return @client.get__ecommerce__products(options)
     end
 
-    def get_location(id)
-      return @client.get__ecommerce__locations(id)
+    def get_product(id, options = nil)
+      return @client.get__ecommerce__products(id, options)
     end
 
-    def create_location(data)
-      return @client.create__ecommerce__locations(data)
+    def create_product(data, options = nil)
+      return @client.create__ecommerce__products(data, options)
     end
 
-    def update_location(id, data)
-      return @client.update__ecommerce__locations(id, data)
+    def update_product(id, data, options = nil)
+      return @client.update__ecommerce__products(id, data, options)
     end
-  end
+
+    # === Get skus.
+    # Get a collection of skus
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_skus(options = nil)
+      return @client.get__ecommerce__skus(options)
+    end
+
+    def get_sku(id, options = nil)
+      return @client.get__ecommerce__skus(id, options)
+    end
+
+    def create_sku(data, options = nil)
+      return @client.create__ecommerce__skus(data, options)
+    end
+
+    def update_sku(id, data, options = nil)
+      return @client.update__ecommerce__skus(id, data, options)
+    end
+
+    # === Get prices.
+    # Get a collection of prices
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_prices(options = nil)
+      return @client.get__ecommerce__prices(options)
+    end
+
+    def get_price(id, options = nil)
+      return @client.get__ecommerce__prices(id, options)
+    end
+
+    def create_price(data, options = nil)
+      return @client.create__ecommerce__prices(data, options)
+    end
+
+    def update_price(id, data, options = nil)
+      return @client.update__ecommerce__prices(id, data, options)
+    end
+
+    # === Get prece lists.
+    # Get a collection of prece lists
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_price_lists(options = nil)
+      return @client.get__ecommerce__price_lists(options)
+    end
+
+    def get_price_list(id, options = nil)
+      return @client.get__ecommerce__price_lists(id, options)
+    end
+
+    def create_price_list(data, options = nil)
+      return @client.create__ecommerce__price_lists(data, options)
+    end
+
+    def update_price_list(id, data, options = nil)
+      return @client.update__ecommerce__price_lists(id, data, options)
+    end
+
+    # === Get product brands.
+    # Get a collection of product brands
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_product_brands(options = nil)
+      return @client.get__ecommerce__product_brands(options)
+    end
+
+    def get_prodict_brand(id, options = nil)
+      return @client.get__ecommerce__product_brands(id, options)
+    end
+
+    def create_prodict_brand(data, options = nil)
+      return @client.create__ecommerce__product_brands(data, options)
+    end
+
+    def update_product_brand(id, data, options = nil)
+      return @client.update__ecommerce__product_brands(id, data, options)
+    end
+
+    # === Get product types.
+    # Get a collection of product types
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_product_types(options = nil)
+      return @client.get__ecommerce__product_types(options)
+    end
+
+    def get_prodict_type(id, options = nil)
+      return @client.get__ecommerce__product_types(id, options)
+    end
+
+    def create_prodict_type(data, options = nil)
+      return @client.create__ecommerce__product_types(data, options)
+    end
+
+    def update_product_type(id, data, options = nil)
+      return @client.update__ecommerce__product_types(id, data, options)
+    end
+
+    # === Get product templates.
+    # Get a collection of product templates
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_product_templates(options = nil)
+      return @client.get__ecommerce__product_templates(options)
+    end
+
+    def get_prodict_template(id, options = nil)
+      return @client.get__ecommerce__product_templates(id, options)
+    end
+
+    def create_prodict_template(data, options = nil)
+      return @client.create__ecommerce__product_templates(data, options)
+    end
+
+    def update_product_template(id, data, options = nil)
+      return @client.update__ecommerce__product_templates(id, data, options)
+    end
+
+
+    # === Get locations.
+    # Get a collection of locations
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_locations(options = nil)
+      return @client.get__ecommerce__locations(options)
+    end
+
+    def get_location(id, options = nil)
+      return @client.get__ecommerce__locations(id, options)
+    end
+
+    def create_location(data, options = nil)
+      return @client.create__ecommerce__locations(data, options)
+    end
+
+    def update_location(id, data, options = nil)
+      return @client.update__ecommerce__locations(id, data, options)
+    end
+  
+    # === Get taxonomies.
+    # Get a collection of taxonomies
+    #
+    # ==== Parameters
+    # * +options+ - [Hash] List of {Resource collection Options}[#class-Mints::User-label-Resource+collections+options+] shown above can be used as parameter
+    def get_taxonomies(options = nil)
+      return @client.get__config__taxonomies(options)
+    end
+
+    def get_taxonomy(id, options = nil)
+      return @client.get__config__taxonomies(id, options)
+    end
+
+    def create_taxonomy(data, options = nil)
+      return @client.create__config__taxonomies(data, options)
+    end
+
+    def update_taxonomy(id, data, options = nil)
+      return @client.update__config__taxonomies(id, data, options)
+    end
+  end  
 end