mints 0.0.28 → 0.0.30

data/lib/user/config/attributes.rb

@@ -1,86 +1,88 @@
+# frozen_string_literal: true
+
 module Attributes
-    ##
-    # == Attributes
-    #
+  ##
+  # == Attributes
+  #
+
+  # === Get attributes data types.
+  # Get data types used in attributes.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_attributes_data_types
+  def get_attributes_data_types
+    @client.raw('get', '/config/attributes/data-types')
+  end
+
+  # === Get sub attributes.
+  # Get sub attributes with a slug.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #
+  def get_sub_attributes(options)
+    @client.raw('get', '/config/attributes/sub-attributes', options)
+  end
 
-    # === Get attributes data types.
-    # Get data types used in attributes.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_attributes_data_types
-    def get_attributes_data_types
-        @client.raw('get', "/config/attributes/data-types")
-    end
+  # === Get attributes.
+  # Get a collection of attributes.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_attributes
+  def get_attributes
+    @client.raw('get', '/config/attributes')
+  end
 
-    # === Get sub attributes.
-    # Get sub attributes with a slug.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== Example
-    #     
-    def get_sub_attributes(options) #TODO: Test, this method has been added recently
-        @client.raw('get', "/config/attributes/sub-attributes", options)
-    end
-    
-    # === Get attributes.
-    # Get a collection of attributes.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_attributes
-    def get_attributes
-        @client.raw('get', "/config/attributes")
-    end
-    
-    # === Get attribute.
-    # Get an attribute info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Attribute id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_attribute(1)
-    def get_attribute(id)
-        @client.raw('get', "/config/attributes/#{id}")
-    end
+  # === Get attribute.
+  # Get an attribute info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Attribute id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_attribute(1)
+  def get_attribute(id)
+    @client.raw('get', "/config/attributes/#{id}")
+  end
 
-    # === Create attribute.
-    # Create an attribute with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       title: "New Attribute",
-    #       "object_type": "orders",
-    #       slug: "new_attribute",
-    #       "attribute_group_id": 1,
-    #       "data_type_enum": 10
-    #     }
-    #     @data = @mints_user.create_attribute(data)
-    def create_attribute(data)
-        @client.raw('post', "/config/attributes", nil, data_transform(data))
-    end
+  # === Create attribute.
+  # Create an attribute with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: "New Attribute",
+  #       object_type: "orders",
+  #       slug: "new_attribute",
+  #       attribute_group_id: 1,
+  #       data_type_enum: 10
+  #     }
+  #     @data = @mints_user.create_attribute(data)
+  def create_attribute(data)
+    @client.raw('post', '/config/attributes', nil, data_transform(data))
+  end
 
-    # === Update attribute.
-    # Update an attribute info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Attribute id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       title: "New Attribute Modified",
-    #       "object_type": "orders",
-    #       slug: "new_attribute",
-    #       "attribute_group_id": 1,
-    #       "data_type_enum": 10
-    #     }
-    #     @data = @mints_user.update_attribute(292, data)
-    def update_attribute(id, data)
-        @client.raw('put', "/config/attributes/#{id}", nil, data_transform(data))
-    end
-end
+  # === Update attribute.
+  # Update an attribute info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Attribute id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Attribute Modified',
+  #       object_type: 'orders',
+  #       slug: 'new_attribute',
+  #       attribute_group_id: 1,
+  #       data_type_enum: 10
+  #     }
+  #     @data = @mints_user.update_attribute(292, data)
+  def update_attribute(id, data)
+    @client.raw('put', "/config/attributes/#{id}", nil, data_transform(data))
+  end
+end

data/lib/user/config/calendars.rb

@@ -1,89 +1,91 @@
+# frozen_string_literal: true
+
 module Calendars
-    ##
-    # == Calendars
-    #
+  ##
+  # == Calendars
+  #
+
+  # === Get calendars.
+  # Get a collection of calendars.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_calendars
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title'
+  #     }
+  #     @data = @mints_user.get_calendars(options)
+  def get_calendars(options = nil)
+    @client.raw('get', '/config/calendars', options)
+  end
+
+  # === Get calendar.
+  # Get a calendar info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Calendar id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_calendar(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title'
+  #     }
+  #     @data = @mints_user.get_calendar(1, options)
+  def get_calendar(id, options = nil)
+    @client.raw('get', "/config/calendars/#{id}", options)
+  end
+
+  # === Create calendar.
+  # Create a calendar with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Calendar',
+  #       object_type: 'contacts',
+  #       object_id: 1
+  #     }
+  #     @data = @mints_user.create_calendar(data)
+  def create_calendar(data)
+    @client.raw('post', '/config/calendars', nil, data_transform(data))
+  end
 
-    # === Get calendars.
-    # Get a collection of calendars.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_calendars
-    #
-    # ==== Second Example
-    #     options = {
-    #       fields: "title"
-    #     }
-    #     @data = @mints_user.get_calendars(options)
-    def get_calendars(options = nil)
-        @client.raw('get', "/config/calendars", options)
-    end
-    
-    # === Get calendar.
-    # Get a calendar info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Calendar id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_calendar(1)
-    #
-    # ==== Second Example
-    #     options = {
-    #       fields: "title"
-    #     }
-    #     @data = @mints_user.get_calendar(1, options)
-    def get_calendar(id, options = nil)
-        @client.raw('get', "/config/calendars/#{id}", options)
-    end
-    
-    # === Create calendar.
-    # Create a calendar with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       title: "New Calendar",
-    #       "object_type": "contacts",
-    #       "object_id": 1
-    #     }
-    #     @data = @mints_user.create_calendar(data)
-    def create_calendar(data)
-        @client.raw('post', "/config/calendars", nil, data_transform(data))
-    end
+  # === Update calendar.
+  # Update a calendar info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Calendar id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Calendar Modified',
+  #       object_type: 'contacts',
+  #       object_id: 1
+  #     }
+  #     @data = @mints_user.update_calendar(4, data)
+  def update_calendar(id, data)
+    @client.raw('put', "/config/calendars/#{id}", nil, data_transform(data))
+  end
 
-    # === Update calendar.
-    # Update a calendar info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Calendar id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       title: "New Calendar Modified",
-    #       "object_type": "contacts",
-    #       "object_id": 1
-    #     }
-    #     @data = @mints_user.update_calendar(4, data)
-    def update_calendar(id, data)
-        @client.raw('put', "/config/calendars/#{id}", nil, data_transform(data))
-    end
-    
-    # === Delete calendar.
-    # Delete a calendar.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Calendar id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_calendar(4)
-    def delete_calendar(id)
-        @client.raw('delete', "/config/calendars/#{id}")
-    end
-end
+  # === Delete calendar.
+  # Delete a calendar.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Calendar id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_calendar(4)
+  def delete_calendar(id)
+    @client.raw('delete', "/config/calendars/#{id}")
+  end
+end

data/lib/user/config/config.rb

@@ -1,65 +1,33 @@
-require_relative './api_keys.rb'
-require_relative './appointments.rb'
-require_relative './attribute_groups.rb'
-require_relative './attributes.rb'
-require_relative './calendars.rb'
-require_relative './importers.rb'
-require_relative './public_folders.rb'
-require_relative './relationships.rb'
-require_relative './roles.rb'
-require_relative './seeds.rb'
-require_relative './system_settings.rb'
-require_relative './tags.rb'
-require_relative './taxonomies.rb'
-require_relative './teams.rb'
-require_relative './users.rb'
+# frozen_string_literal: true
 
-module Config
-    include ApiKeys
-    include Appointments
-    include AttributeGroups
-    include Attributes
-    include Calendars
-    include Importers
-    include PublicFolders
-    include Relationships
-    include Roles
-    include Seeds
-    include SystemSettings
-    include Tags
-    include Taxonomies
-    include Teams
-    include Users
-
-    ##
-    # == Categories
-    #
-
-    # def sync_categories_for_object(data)
-    #  @client.raw('put', "/config/categories/sync_categories_for_object", nil, data)
-    #end
-
-    # def get_categories_for_object(options)
-    #  @client.raw('get', "/config/categories/get_categories_for_object", options)
-    #end
-    
-    # def get_categories
-    #  @client.raw('get', "/config/categories")
-    #end
+require_relative './api_keys'
+require_relative './appointments'
+require_relative './attribute_groups'
+require_relative './attributes'
+require_relative './calendars'
+require_relative './public_folders'
+require_relative './relationships'
+require_relative './roles'
+require_relative './seeds'
+require_relative './system_settings'
+require_relative './tags'
+require_relative './taxonomies'
+require_relative './teams'
+require_relative './users'
 
-    # def create_category(data) #TODO: Research if 'visible' is a boolean or int. It accepts smallint
-    #  @client.raw('post', "/config/categories", nil, data)
-    #end
-
-    # def update_category(id, data)
-    #  @client.raw('put', "/config/categories/#{id}", nil, data)
-    #end
-
-    # def get_category_support_data(id)
-    #  @client.raw('get', "/config/categories/support-data/#{id}")
-    #end
-    
-    # def get_category(id)
-    #  @client.raw('get', "/config/categories/#{id}")
-    #end
-end
+module Config
+  include ApiKeys
+  include Appointments
+  include AttributeGroups
+  include Attributes
+  include Calendars
+  include PublicFolders
+  include Relationships
+  include Roles
+  include Seeds
+  include SystemSettings
+  include Tags
+  include Taxonomies
+  include Teams
+  include Users
+end

data/lib/user/config/public_folders.rb

@@ -1,108 +1,109 @@
+# frozen_string_literal: true
+
 module PublicFolders
-    ##
-    # == Public Folders
-    #
+  ##
+  # == Public Folders
+  #
+  # === Sync public folders for object.
+  # Sync public folders for object.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       object_type: 'contacts',
+  #       object_id: 1
+  #     }
+  #     @data = @mints_user.sync_public_folders_for_object(data.to_json)
+  def sync_public_folders_for_object(data)
+    @client.raw('put', '/config/public-folders/sync_public-folders_for_object', nil, data)
+  end
+
+  # === Get public folders for object.
+  # Get public folders for object.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     options = {
+  #       object_type: "contacts",
+  #       object_id: 1
+  #     }
+  #     @data = @mints_user.get_public_folders_for_object(options)
+  def get_public_folders_for_object(options)
+    @client.raw('get', '/config/public-folders/get_public-folders_for_object', options)
+  end
+
+  # === Get public folders.
+  # Get a collection of public folders.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_public_folders
+  def get_public_folders(options = nil)
+    @client.raw('get', '/config/public-folders', options)
+  end
+
+  # === Create public folder.
+  # Create a public folder with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Public Folder',
+  #       slug: 'new-public-folder',
+  #       object_type: 'contacts',
+  #       visible: true
+  #     }
+  #     @data = @mints_user.create_public_folder(data.to_json)
+  def create_public_folder(data)
+    @client.raw('post', '/config/public-folders', nil, data)
+  end
 
-    # === Sync public folders for object.
-    # Sync public folders for object.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "object_type": "contacts",
-    #       "object_id": 1
-    #     }
-    #     @data = @mints_user.sync_public_folders_for_object(data.to_json)
-    def sync_public_folders_for_object(data)
-        @client.raw('put', "/config/public-folders/sync_public-folders_for_object", nil, data)
-    end
-    
-    # === Get public folders for object.
-    # Get public folders for object.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== Example
-    #     options = {
-    #       "object_type": "contacts",
-    #       "object_id": 1
-    #     }
-    #     @data = @mints_user.get_public_folders_for_object(options)
-    def get_public_folders_for_object(options)
-        @client.raw('get', "/config/public-folders/get_public-folders_for_object", options)
-    end
+  # === Update public folder.
+  # Update a public folder info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Public folder id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Public Folder Modified',
+  #       slug: 'new-public-folder',
+  #       object_type: 'contacts',
+  #       visible: true
+  #     }
+  #     @data = @mints_user.update_public_folder(20, data.to_json)
+  def update_public_folder(id, data)
+    @client.raw('put', "/config/public-folders/#{id}", nil, data)
+  end
 
-    # === Get public folders.
-    # Get a collection of public folders.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_public_folders
-    def get_public_folders(options = nil)
-        @client.raw('get', "/config/public-folders", options)
-    end
-    
-    # === Create public folder.
-    # Create a public folder with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       title: "New Public Folder",
-    #       slug: "new-public-folder",
-    #       "object_type": "contacts",
-    #       "visible": true
-    #     }
-    #     @data = @mints_user.create_public_folder(data.to_json)
-    def create_public_folder(data)
-        @client.raw('post', "/config/public-folders", nil, data)
-    end
+  # === Get public folder support data.
+  # Get support data used in a public folder.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Public folder id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_public_folder_support_data(1)
+  def get_public_folder_support_data(id)
+    @client.raw('get', "/config/public-folders/support-data/#{id}")
+  end
 
-    # === Update public folder.
-    # Update a public folder info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Public folder id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       title: "New Public Folder Modified",
-    #       slug: "new-public-folder",
-    #       "object_type": "contacts",
-    #       "visible": true
-    #     }
-    #     @data = @mints_user.update_public_folder(20, data.to_json)
-    def update_public_folder(id, data)
-        @client.raw('put', "/config/public-folders/#{id}", nil, data)
-    end
-    
-    # === Get public folder support data.
-    # Get support data used in a public folder.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Public folder id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_public_folder_support_data(1)
-    def get_public_folder_support_data(id)
-        @client.raw('get', "/config/public-folders/support-data/#{id}")
-    end
-    
-    # === Get public folder.
-    # Get a public folder info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Public folder id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== Example
-    #      @data = @mints_user.get_public_folder(3)
-    def get_public_folder(id)
-        @client.raw('get', "/config/public-folders/#{id}")
-    end
-end
+  # === Get public folder.
+  # Get a public folder info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Public folder id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #      @data = @mints_user.get_public_folder(3)
+  def get_public_folder(id)
+    @client.raw('get', "/config/public-folders/#{id}")
+  end
+end