mints 0.0.16 → 0.0.20

data/lib/user/config/importers.rb

@@ -0,0 +1,184 @@
+module Importers
+    ##
+    # == Importers
+    #
+
+    # === Get importers results.
+    # Get a results of importers.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     options = { "ip_id": 1 }
+    #     @data = @mints_user.get_importers_results(options)
+    def get_importers_results(options) #FIXME: Query doesnt get results. Maybe no data in db.
+        return @client.raw("get", "/config/importers/results", options)
+    end
+    
+    # === Get importers configuration.
+    # Get configurations of importers.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_importers_configuration
+    def get_importers_configuration
+        return @client.raw("get", "/config/importers/configuration")
+    end
+
+    # === Get importing process status.
+    # Get importing process status by importer ids.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     options = {
+    #       "ids": "1,2,3"
+    #     }
+    #     @data = @mints_user.get_importing_process_status(options)
+    def get_importing_process_status(options = nil)
+        return @client.raw("get", "/config/importers/importing_process_status", options)
+    end
+
+    # === Get importers attributes.
+    # Get import attributes of modules in a table.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     options = {
+    #       "table": "contacts",
+    #       "module": "crm"
+    #     }
+    #     @data = @mints_user.get_importers_attributes(options)
+    def get_importers_attributes(options = nil)
+        return @client.raw("get", "/config/importers/attributes", options)
+    end
+
+    # === Upload importer.
+    # Upload to an importer.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Importer id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "csv": "archive.csv"
+    #     }
+    #     @data = @mints_user.upload_importer(1, data.to_json)
+    def upload_importer(id, data) #TODO: Search for csv archives
+        return @client.raw("post", "/config/importers/#{id}/upload", nil, data)
+    end
+
+    # === Import row.
+    # Import a row.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     
+    def import_row(data) #TODO: Research use
+        return @client.raw("post", "/config/importers/import_row", nil, data)
+    end
+    
+    # === Remove importers active process.
+    # Remove an active process in an importer.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     
+    def remove_importers_active_process(data) #FIXME: Cannot get property 'active_importing_process' of non-object. 
+        return @client.raw("post", "/config/importers/removeActiveProcess", nil, data_transform(data))
+    end
+    
+    # === Get importers.
+    # Get a collection of importers.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_importers
+    #
+    # ==== Second Example
+    #     options = { "fields": "name" }
+    #     @data = @mints_user.get_importers(options)
+    def get_importers(options = nil)
+        return @client.raw("get", "/config/importers", options)
+    end
+
+    # === Get importer.
+    # Get an importer info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Importer id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_importer(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "name" }
+    #     @data = @mints_user.get_importer(1, options)
+    def get_importer(id, options = nil)
+        return @client.raw("get", "/config/importers/#{id}", options)
+    end
+
+    # === Create importer.
+    # Create an importer with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "name": "New Importer",
+    #       "module": "crm"
+    #     }
+    #     @data = @mints_user.create_importer(data)
+    def create_importer(data)
+        return @client.raw("post", "/config/importers", nil, data_transform(data))
+    end
+
+    # === Update importer.
+    # Update an importer info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Importer id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "name": "New Importer Modified"
+    #     }
+    #     @data = @mints_user.update_importer(4, data)
+    def update_importer(id, data)
+        return @client.raw("put", "/config/importers/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete importer.
+    # Delete a importer.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Importer id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_importer(4)
+    def delete_importer(id)
+        return @client.raw("delete", "/config/importers/#{id}")
+    end
+    
+    # === Get importers pusher key.
+    # Get the pusher key of importers.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_importers_pusher_key
+    def get_importers_pusher_key
+        return @client.raw("get", "/config/pusher_key")
+    end
+end

data/lib/user/config/public_folders.rb

@@ -0,0 +1,108 @@
+module PublicFolders
+    ##
+    # == Public Folders
+    #
+
+    # === Sync public folders for object.
+    # Sync public folders for object.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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)
+        return @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)
+        return @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
+        return @client.raw("get", "/config/public-folders")
+    end
+    
+    # === Create public folder.
+    # Create a public folder with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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)
+        return @client.raw("post", "/config/public-folders", nil, data)
+    end
+
+    # === Update public folder.
+    # Update a public folder info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Public folder id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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)
+        return @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)
+        return @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)
+        return @client.raw("get", "/config/public-folders/#{id}")
+    end
+end

data/lib/user/config/relationships.rb

@@ -0,0 +1,138 @@
+module Relationships
+    ##
+    # == Relationships
+    #
+    
+    # === Get relationships available for.
+    # Get relationships availables.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     options = {
+    #       "objectType": "contacts"
+    #     }
+    #     @data = @mints_user.get_relationships_available_for(options)
+    def get_relationships_available_for(options)
+        return @client.raw("get", "/config/relationships/available-for", options)
+    end
+    
+    # === Attach relationship.
+    # Attach a relationship.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     
+    def attach_relationship(data) #FIXME: Method doesn't work, RelationshipManager cannot access to id attribute.
+        return @client.raw("post", "/config/relationships/attach", nil, data)
+    end
+
+    # === Detach relationship.
+    # Detach a relationship.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     
+    def detach_relationship(data) #FIXME: Method doesn't work, RelationshipManager cannot access to id attribute.
+        return @client.raw("post", "/config/relationships/detach", nil, data)
+    end
+    
+    # === Relationship has objects.
+    # Get relationships that has objects.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Relationship id.
+    #
+    # ==== Example
+    #     @data = @mints_user.relationship_has_objects(1)
+    def relationship_has_objects(id)
+        return @client.raw("get", "/config/relationships/#{id}/hasObjects")
+    end
+    
+    # === Get relationships.
+    # Get a collection of relationships.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_relationships
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_relationships(options)
+    def get_relationships(options = nil)
+        return @client.raw("get", "/config/relationships", options)
+    end
+
+    # === Get relationship.
+    # Get a relationship info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Relationship id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_relationship(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_relationship(1, options)
+    def get_relationship(id, options = nil)
+        return @client.raw("get", "/config/relationships/#{id}", options)
+    end
+
+    # === Create relationship.
+    # Create a relationship with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "alias_1": "eventsCopy",
+    #       "alias_2": "ticketsCopy",
+    #       "object_model_1": "Story",
+    #       "object_model_2": "Product"
+    #     }
+    #     @data = @mints_user.create_relationship(data)
+    def create_relationship(data)
+        return @client.raw("post", "/config/relationships", nil, data_transform(data))
+    end
+
+    # === Update relationship.
+    # Update a relationship info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Relationship id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "alias_1": "eventsCopyModified",
+    #       "alias_2": "ticketsCopyModified",
+    #       "object_model_1": "Story",
+    #       "object_model_2": "Product"
+    #     }
+    #     @data = @mints_user.update_relationship(5, data)
+    def update_relationship(id, data)
+        return @client.raw("put", "/config/relationships/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete relationship.
+    # Delete a relationship.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Relationship id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_relationship(5)
+    def delete_relationship(id)
+        return @client.raw("delete", "/config/relationships/#{id}")
+    end
+end

data/lib/user/config/roles.rb

@@ -0,0 +1,84 @@
+module Roles
+    ##
+    # == Roles
+    #
+
+    #def get_roles_permissions #FIXME: RoleController doesnt have getPermissions method
+    #  return @client.raw("get", "/config/roles/get-permissions")
+    #end
+
+    # === Duplicate role.
+    # Duplicate a role.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Role id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "options": [] 
+    #     }
+    #     @data = @mints_user.duplicate_role(1, data.to_json)
+    def duplicate_role(id, data)
+        return @client.raw("post", "/config/roles/#{id}/duplicate", nil, data)
+    end
+    
+    # === Get roles.
+    # Get a collection of roles.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_roles
+    def get_roles
+        return @client.raw("get", "/config/roles")
+    end
+
+    # === Get role.
+    # Get a role info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Role id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_role(1)
+    def get_role(id)
+        return @client.raw("get", "/config/roles/#{id}")
+    end
+
+    # === Create role.
+    # Create a role with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "name": "new-role",
+    #       "display_name": "New Role",
+    #       "description": "Role description"
+    #     }
+    #     @data = @mints_user.create_role(data)
+    def create_role(data)
+        return @client.raw("post", "/config/roles", nil, data_transform(data))
+    end
+    
+    # === Update role.
+    # Update a role info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Role id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "name": "new-role",
+    #       "display_name": "New Role Display Name Modified",
+    #       "description": "Role description",
+    #       "permissions": 1
+    #     }
+    #     @data = @mints_user.update_role(8, data)
+    def update_role(id, data) #FIXME: This action is unauthorized
+        #TODO: Research permissions variable type. This would be the error's solution.
+        return @client.raw("put", "/config/roles/#{id}", nil, data_transform(data))
+    end
+end

data/lib/user/config/seeds.rb

@@ -0,0 +1,14 @@
+module Seeds
+    ##
+    # == Seeds
+    #
+
+    # === Apply seeds.
+    # Apply seeds.
+    #
+    # ==== Example
+    #
+    def apply_seeds(data) #TODO: Research use
+        return @client.raw("post", "/config/seeds", nil, data)
+    end
+end

data/lib/user/config/system_settings.rb

@@ -0,0 +1,53 @@
+module SystemSettings
+    ##
+    # == System Settings
+    #
+
+    # === Get settings by keys.
+    # Get a collection of settings using keys.
+    #
+    # ==== Example
+    #     options = {
+    #       "setting_keys": "email_transport_provider,email_template_provider,email_template_default_from_address"
+    #     }
+    #     @data = @mints_user.get_settings_by_keys(options)
+    def get_settings_by_keys(options)
+        return @client.raw("get", "/config/settings/by-keys", options)
+    end
+    
+    # === Get settings.
+    # Get a collection of settings.
+    #
+    # ====  Example
+    #     @data = @mints_user.get_settings
+    def get_settings
+        return @client.raw("get", "/config/settings")
+    end      
+
+    # === Create setting.
+    # Create a setting title with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "new_settings"
+    #     }
+    #     @data = @mints_user.create_setting(data)
+    def create_setting(data)
+        return @client.raw("post", "/config/settings", nil, data_transform(data))
+    end
+
+    # === Clear tag.
+    # Clar a tag info.
+    #
+    # ==== Parameters
+    # tag:: (Integer) -- Tag id.
+    #
+    # ==== Example
+    #     @data = @mints_user.clear_tag(1)
+    def clear_tag(tag)
+        return @client.raw("get", "/config/settings/tags/#{tag}/clear")
+    end
+end

data/lib/user/config/tags.rb

@@ -0,0 +1,63 @@
+module Tags
+    ##
+    # == Tags
+    #
+
+    # === Get tags.
+    # Get a collection of tags.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_tags
+    def get_tags
+        return @client.raw("get", "/config/tags")
+    end
+
+    # === Get tag.
+    # Get a tag info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Tag id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_tag(1)
+    def get_tag(id)
+        return @client.raw("get", "/config/tags/#{id}")
+    end
+
+    # === Create tag.
+    # Create a tag with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "tag": "new-tag",
+    #       "is_visible": true
+    #     }
+    #     @data = @mints_user.create_tag(data.to_json)
+    def create_tag(data)
+        return @client.raw("post", "/config/tags", nil, data)
+    end
+
+    # === Update tag.
+    # Update a tag info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Tag id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "tag": {
+    #         "tag": "new-tag",
+    #         "slug": "new-tag",
+    #         "is_visible": false
+    #       }
+    #     }
+    #     @data = @mints_user.update_tag(54, data.to_json)
+    def update_tag(id, data)
+        #TODO: Inform TagController.update method has been modified
+        return @client.raw("put", "/config/tags/#{id}", nil, data)
+    end
+end