mints 0.0.27 → 0.0.29

data/lib/user/helpers/object_folders.rb

@@ -1,82 +1,84 @@
+# frozen_string_literal: true
+
 module ObjectFolders
-    ##
-    # == Object Folders
-    #
+  ##
+  # == Object Folders
+  #
 
-    # === Get object folders.
-    # Get a collection of object folders.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_object_folders
-    #
-    # ==== Second Example
-    #     options = { "fields": "id" }
-    #     @data = @mints_user.get_object_folders(options)
-    def get_object_folders(options = nil)
-        @client.raw("get", "/helpers/object-folders", options)
-    end
+  # === Get object folders.
+  # Get a collection of object folders.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_object_folders
+  #
+  # ==== Second Example
+  #     options = { fields: "id" }
+  #     @data = @mints_user.get_object_folders(options)
+  def get_object_folders(options = nil)
+    @client.raw('get', '/helpers/object-folders', options)
+  end
 
-    # === Get object folder.
-    # Get an object folder info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Object folders id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_object_folder(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "id" }
-    #     @data = @mints_user.get_object_folder(1, options)
-    def get_object_folder(id, options = nil)
-        @client.raw("get", "/helpers/object-folders/#{id}", options)
-    end
+  # === Get object folder.
+  # Get an object folder info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Object folders id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_object_folder(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id' }
+  #     @data = @mints_user.get_object_folder(1, options)
+  def get_object_folder(id, options = nil)
+    @client.raw('get', "/helpers/object-folders/#{id}", options)
+  end
 
-    # === Create object folder.
-    # Create an object folder with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "folder_id": 1,
-    #       "object_id": 1
-    #     }
-    #     @data = @mints_user.create_object_folder(data)
-    def create_object_folder(data)
-        @client.raw("post", "/helpers/object-folders", nil, data_transform(data))
-    end
+  # === Create object folder.
+  # Create an object folder with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       folder_id: 1,
+  #       object_id: 1
+  #     }
+  #     @data = @mints_user.create_object_folder(data)
+  def create_object_folder(data)
+    @client.raw('post', '/helpers/object-folders', nil, data_transform(data))
+  end
 
-    # === Update object folder.
-    # Update an object folder info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Object folder id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "folder_id": 2
-    #     }
-    #     @data = @mints_user.update_object_folder(1, data)
-    def update_object_folder(id, data)
-        @client.raw("put", "/helpers/object-folders/#{id}", nil, data_transform(data))
-    end
+  # === Update object folder.
+  # Update an object folder info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Object folder id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       folder_id: 2
+  #     }
+  #     @data = @mints_user.update_object_folder(1, data)
+  def update_object_folder(id, data)
+    @client.raw('put', "/helpers/object-folders/#{id}", nil, data_transform(data))
+  end
 
-    # === Delete object folder.
-    # Delete an object folder.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Object folder id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_object_folder(2)
-    def delete_object_folder(id)
-        @client.raw("delete", "/helpers/object-folders/#{id}")
-    end
-end
+  # === Delete object folder.
+  # Delete an object folder.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Object folder id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_object_folder(2)
+  def delete_object_folder(id)
+    @client.raw('delete', "/helpers/object-folders/#{id}")
+  end
+end

data/lib/user/helpers/user_folders.rb

@@ -1,83 +1,85 @@
+# frozen_string_literal: true
+
 module UserFolders
-    ##
-    # == User Folders
-    #
+  ##
+  # == User Folders
+  #
 
-    # === Get user folders.
-    # Get a collection of user folders.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_user_folders
-    #
-    # ==== Second Example
-    #     options = { "fields": "folder" }
-    #     @data = @mints_user.get_user_folders(options)
-    def get_user_folders(options = nil)
-        @client.raw("get", "/helpers/folders", options)
-    end
+  # === Get user folders.
+  # Get a collection of user folders.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_user_folders
+  #
+  # ==== Second Example
+  #     options = { fields: 'folder' }
+  #     @data = @mints_user.get_user_folders(options)
+  def get_user_folders(options = nil)
+    @client.raw('get', '/helpers/folders', options)
+  end
 
-    # === Get user folder.
-    # Get an user folder info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- User folder id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_user_folder(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "user_id, folder" }
-    #     @data = @mints_user.get_user_folder(1, options)
-    def get_user_folder(id, options = nil)
-        @client.raw("get", "/helpers/folders/#{id}", options)
-    end
+  # === Get user folder.
+  # Get an user folder info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- User folder id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_user_folder(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'user_id, folder' }
+  #     @data = @mints_user.get_user_folder(1, options)
+  def get_user_folder(id, options = nil)
+    @client.raw('get', "/helpers/folders/#{id}", options)
+  end
 
-    # === Create user folder.
-    # Create an user folder with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "folder": "new-user-folder",
-    #       "object_type": "contacts"
-    #     }
-    #     @data = @mints_user.create_user_folder(data)
-    def create_user_folder(data)
-        @client.raw("post", "/helpers/folders", nil, data_transform(data))
-    end
+  # === Create user folder.
+  # Create an user folder with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       folder: 'new-user-folder',
+  #       object_type: 'contacts'
+  #     }
+  #     @data = @mints_user.create_user_folder(data)
+  def create_user_folder(data)
+    @client.raw('post', '/helpers/folders', nil, data_transform(data))
+  end
 
-    # === Update user folder.
-    # Update an user folder info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- User folder id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "folder": "new-user-folder-modified",
-    #       "object_type": "contacts"
-    #     }
-    #     @data = @mints_user.update_user_folder(289, data)
-    def update_user_folder(id, data)
-        @client.raw("put", "/helpers/folders/#{id}", nil, data_transform(data))
-    end
+  # === Update user folder.
+  # Update an user folder info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- User folder id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       folder:'new-user-folder-modifier',
+  #       object_type:'contact'
+  #     }
+  #     @data = @mints_user.update_user_folder(289, data)
+  def update_user_folder(id, data)
+    @client.raw('put', "/helpers/folders/#{id}", nil, data_transform(data))
+  end
 
-    # === Delete user folder.
-    # Delete an user folder.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- User folder id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_user_folder(289)
-    def delete_user_folder(id)
-        @client.raw("delete", "/helpers/folders/#{id}")
-    end
-end
+  # === Delete user folder.
+  # Delete an user folder.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- User folder id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_user_folder(289)
+  def delete_user_folder(id)
+    @client.raw('delete', "/helpers/folders/#{id}")
+  end
+end

data/lib/user/marketing/marketing.rb

@@ -1,120 +1,123 @@
+# frozen_string_literal: true
+
 module Marketing
-    ##
-    # == Automation
-    #
+  ##
+  # == Automation
+  #
+
+  # === Get automations.
+  # Get a collection of automations.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_automations
+  #
+  # ==== Second Example
+  #       options = {
+  #         fields: 'title'
+  #       }
+  #       @data = @mints_user.get_automations(options)
+  def get_automations(options = nil)
+    @client.raw('get', '/marketing/automation', options)
+  end
+
+  # === Get automation.
+  # Get an automation info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_automation(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'title, id'
+  #     }
+  #     @data = @mints_user.get_automation(1, options)
+  def get_automation(id, options = nil)
+    @client.raw('get', "/marketing/automation/#{id}", options)
+  end
 
-    # === Get automations.
-    # Get a collection of automations.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_automations
-    #
-    # ==== Second Example
-    #       options = {
-    #         "fields": "title"
-    #       }
-    #       @data = @mints_user.get_automations(options)
-    def get_automations(options = nil)
-        @client.raw("get", "/marketing/automation", options)
-    end
+  # === Create automation.
+  # Create an automation with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Automation'
+  #     }
+  #     @data = @mints_user.create_automation(data)
+  def create_automation(data)
+    @client.raw('post', '/marketing/automation/', nil, data_transform(data))
+  end
 
-    # === Get automation.
-    # Get an automation info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Automation id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_automation(1)
-    #
-    # ==== Second Example
-    #     options = {
-    #       "fields": "title, id"
-    #     }
-    #     @data = @mints_user.get_automation(1, options)
-    def get_automation(id, options = nil)
-        @client.raw("get", "/marketing/automation/#{id}", options)
-    end
+  # === Update automation.
+  # Update an automation info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  def update_automation(id, data)
+    # FIXME: Method doesn't work.
+    @client.raw('put', "/marketing/automation/#{id}", nil, data_transform(data))
+  end
 
-    # === Create automation.
-    # Create an automation with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Automation"
-    #     }
-    #     @data = @mints_user.create_automation(data)
-    def create_automation(data)
-        @client.raw("post", "/marketing/automation/", nil, data_transform(data))
-    end
+  # === Delete automation.
+  # Delete an automation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_automation(5)
+  def delete_automation(id)
+    @client.raw('delete', "/marketing/automation/#{id}")
+  end
 
-    # === Update automation.
-    # Update an automation info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Automation id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    def update_automation(id, data) #FIXME: Method doesn't work.
-        @client.raw("put", "/marketing/automation/#{id}", nil, data_transform(data))
-    end
+  # === Get automation executions.
+  # Get executions of an automation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_automation_executions(1)
+  def get_automation_executions(id)
+    @client.raw('get', "/marketing/automation/#{id}/executions")
+  end
 
-    # === Delete automation.
-    # Delete an automation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Automation id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_automation(5)
-    def delete_automation(id)
-        @client.raw("delete", "/marketing/automation/#{id}")
-    end
+  # === Reset automation.
+  # Reset an automation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  #
+  # ==== Example
+  #     @data = @mints_user.reset_automation(1)
+  def reset_automation(id)
+    @client.raw('post', "/marketing/automation/#{id}/reset")
+  end
 
-    # === Get automation executions.
-    # Get executions of an automation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Automation id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_automation_executions(1)
-    def get_automation_executions(id)
-        @client.raw("get", "/marketing/automation/#{id}/executions")
-    end
-    
-    # === Reset automation.
-    # Reset an automation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Automation id.
-    #
-    # ==== Example
-    #     @data = @mints_user.reset_automation(1)
-    def reset_automation(id)
-        @client.raw("post", "/marketing/automation/#{id}/reset")
-    end
-    
-    # === Duplicate automation.
-    # Duplicate an automation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Automation id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "options": [] 
-    #     }
-    #     @data = @mints_user.duplicate_automation(1, data.to_json)
-    def duplicate_automation(id, data)
-        @client.raw("post", "/marketing/automation/#{id}/duplicate", nil, data)
-    end
-end
+  # === Duplicate automation.
+  # Duplicate an automation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Automation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       options: []
+  #     }
+  #     @data = @mints_user.duplicate_automation(1, data.to_json)
+  def duplicate_automation(id, data)
+    @client.raw('post', "/marketing/automation/#{id}/duplicate", nil, data)
+  end
+end