mints 0.0.26 → 0.0.28

data/lib/user/content/content_templates.rb

@@ -1,111 +1,111 @@
 module ContentTemplates
-    ##
-    # == Content templates
-    #
+  ##
+  # == Content templates
+  #
 
-    # === Get content template instances.
-    # Get instances of a content template.
-    #
-    # ==== Parameters
-    # templateId:: (Integer) -- Template id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_content_template_instances(1)
-    def get_content_template_instances(templateId)
-        return @client.raw("get", "/content/templates/#{templateId}/instances")
-    end
+  # === Get content template instances.
+  # Get instances of a content template.
+  #
+  # ==== Parameters
+  # templateId:: (Integer) -- Template id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_content_template_instances(1)
+  def get_content_template_instances(template_id)
+    @client.raw('get', "/content/templates/#{template_id}/instances")
+  end
 
-    # === Duplicate content template.
-    # Duplicate a content template.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Content template id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_content_template(1)
-    def duplicate_content_template(id)
-        return @client.raw("post", "/content/templates/#{id}/duplicate/")
-    end
+  # === Duplicate content template.
+  # Duplicate a content template.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Content template id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_content_template(1)
+  def duplicate_content_template(id)
+    @client.raw('post', "/content/templates/#{id}/duplicate/")
+  end
 
-    # === Get content templates.
-    # Get a collection of content templates.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_content_templates
-    #
-    # ==== Second Example
-    #     options = { "sort": "title" }
-    #     @data = @mints_user.get_content_templates(options)
-    def get_content_templates(options = nil)
-        return @client.raw("get", "/content/templates", options)
-    end
+  # === Get content templates.
+  # Get a collection of content templates.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_content_templates
+  #
+  # ==== Second Example
+  #     options = { sort: "title" }
+  #     @data = @mints_user.get_content_templates(options)
+  def get_content_templates(options = nil)
+    @client.raw('get', '/content/templates', options)
+  end
 
-    # === Get content template.
-    # Get a content template.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Content template id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_content_template(1)
-    def get_content_template(id)
-        return @client.raw("get", "/content/templates/#{id}")
-    end
+  # === Get content template.
+  # Get a content template.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Content template id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_content_template(1)
+  def get_content_template(id)
+    @client.raw('get', "/content/templates/#{id}")
+  end
 
-    # === Create content template.
-    # Create a content template with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "template": {
-    #         "title": "New Content Template",
-    #         "slug": "new-content-template-slug",
-    #         "description": "New Content Template Description"
-    #       }
-    #     }
-    #     @data = @mints_user.create_content_template(data.to_json)
-    def create_content_template(data)
-        #TODO: Inform ContentTemplateController.store method has been modified
-        return @client.raw("post", "/content/templates", nil, data)
-    end
+  # === Create content template.
+  # Create a content template with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       template: {
+  #         title: 'New Content Template',
+  #         slug: 'new-content-template-slug',
+  #         description: 'New Content Template Description'
+  #       }
+  #     }
+  #     @data = @mints_user.create_content_template(data.to_json)
+  def create_content_template(data)
+    # TODO: Inform ContentTemplateController.store method has been modified
+    @client.raw('post', '/content/templates', nil, data)
+  end
 
-    # === Update content template.
-    # Update a content template info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Content template id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "template": {
-    #         "title": "New Content Template Modified",
-    #         "slug": "new-content-template-slug",
-    #         "description": "New Content Template Description"
-    #       }
-    #     }
-    #     @data = @mints_user.update_content_template(7, data.to_json)
-    def update_content_template(id, data)
-         #TODO: Inform ContentTemplateController.update method has been modified
-        return @client.raw("put", "/content/templates/#{id}", nil, data)
-    end
+  # === Update content template.
+  # Update a content template info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Content template id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       template: {
+  #         title: 'New Content Template Modified',
+  #         slug: 'new-content-template-slug',
+  #         description: 'New Content Template Description'
+  #       }
+  #     }
+  #     @data = @mints_user.update_content_template(7, data.to_json)
+  def update_content_template(id, data)
+    # TODO: Inform ContentTemplateController.update method has been modified
+    @client.raw('put', "/content/templates/#{id}", nil, data)
+  end
 
-    # === Delete content template.
-    # Delete a content template.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Content template id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_content_template(1)
-    def delete_content_template(id)
-        #TODO: Inform ContentTemplateController.destroy method has been modified
-        return @client.raw("delete", "/content/templates/#{id}")
-    end
-end
+  # === Delete content template.
+  # Delete a content template.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Content template id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_content_template(1)
+  def delete_content_template(id)
+    # TODO: Inform ContentTemplateController.destroy method has been modified
+    @client.raw('delete', "/content/templates/#{id}")
+  end
+end

data/lib/user/content/conversations.rb

@@ -1,206 +1,206 @@
 module Conversations
-    ##
-    # == Conversations
-    #
+  ##
+  # == Conversations
+  #
 
-    ###
-    # === Get conversations.
-    # Get a collection of conversations.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_conversations
-    #
-    # ==== Second Example
-    #     options = { "fields": "title" }
-    #     @data = @mints_user.get_conversations(options)
-    def get_conversations(options = nil)
-        return @client.raw("get", "/content/conversations", options)
-    end
+  ###
+  # === Get conversations.
+  # Get a collection of conversations.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_conversations
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_user.get_conversations(options)
+  def get_conversations(options = nil)
+    @client.raw('get', '/content/conversations', options)
+  end
 
-    # === Get conversation.
-    # Get a conversation info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Conversation id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_conversation(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "title" }
-    #     @data = @mints_user.get_conversation(1, options)
-    def get_conversation(id, options = nil)
-        return @client.raw("get", "/content/conversations/#{id}", options)
-    end
+  # === Get conversation.
+  # Get a conversation info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_conversation(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'title' }
+  #     @data = @mints_user.get_conversation(1, options)
+  def get_conversation(id, options = nil)
+    @client.raw('get', "/content/conversations/#{id}", options)
+  end
 
-    # === Create conversation.
-    # Create a conversation with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Conversation"
-    #     }
-    #     @data = @mints_user.create_conversation(data)
-    def create_conversation(data, options = nil)
-        return @client.raw("post", "/content/conversations", options, data_transform(data))
-    end
+  # === Create conversation.
+  # Create a conversation with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Conversation'
+  #     }
+  #     @data = @mints_user.create_conversation(data)
+  def create_conversation(data, options = nil)
+    @client.raw('post', '/content/conversations', options, data_transform(data))
+  end
 
-    # === Update conversation.
-    # Update a conversation info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Conversation Modified"
-    #     }
-    #     @data = @mints_user.update_conversation(13, data)
-    def update_conversation(id, data, options = nil)
-        return @client.raw("put", "/content/conversations/#{id}", options, data_transform(data))
-    end
+  # === Update conversation.
+  # Update a conversation info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Conversation Modified'
+  #     }
+  #     @data = @mints_user.update_conversation(13, data)
+  def update_conversation(id, data, options = nil)
+    @client.raw('put', "/content/conversations/#{id}", options, data_transform(data))
+  end
 
-    # === Delete conversation.
-    # Delete a conversation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Conversation id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_conversation(11)
-    def delete_conversation(id)
-        return @client.raw("delete", "/content/conversations/#{id}")
-    end
-    
-    # === Update conversation status.
-    # Update a conversation status.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "status": "read"
-    #     }
-    #     @data = @mints_user.update_conversation_status(13, data)
-    def update_conversation_status(id, data)
-        return @client.raw("put", "/content/conversations/#{id}/status", nil, data_transform(data))
-    end
+  # === Delete conversation.
+  # Delete a conversation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_conversation(11)
+  def delete_conversation(id)
+    @client.raw('delete', "/content/conversations/#{id}")
+  end
 
-    # === Get conversation participants.
-    # Get participants in a conversation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Conversation id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_conversation_participants(1)
-    def get_conversation_participants(id)
-        return @client.raw("get", "/content/conversations/#{id}/participants")
-    end
+  # === Update conversation status.
+  # Update a conversation status.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       status: 'read'
+  #     }
+  #     @data = @mints_user.update_conversation_status(13, data)
+  def update_conversation_status(id, data)
+    @client.raw('put', "/content/conversations/#{id}/status", nil, data_transform(data))
+  end
 
-    # === Attach user in conversation.
-    # Attach an user in a conversation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "user_id": 2
-    #     }
-    #     @data = @mints_user.attach_user_in_conversation(13, data)
-    def attach_user_in_conversation(id, data)
-        return @client.raw("post", "/content/conversations/#{id}/attach-user", nil, data_transform(data))
-    end
+  # === Get conversation participants.
+  # Get participants in a conversation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_conversation_participants(1)
+  def get_conversation_participants(id)
+    @client.raw('get', "/content/conversations/#{id}/participants")
+  end
 
-    # === Detach user in conversation.
-    # Detach an user in a conversation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "user_id": 2
-    #     }
-    #     @data = @mints_user.detach_user_in_conversation(13, data)
-    def detach_user_in_conversation(id, data)
-        return @client.raw("post", "/content/conversations/#{id}/detach-user", nil, data_transform(data))
-    end
+  # === Attach user in conversation.
+  # Attach an user in a conversation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 2
+  #     }
+  #     @data = @mints_user.attach_user_in_conversation(13, data)
+  def attach_user_in_conversation(id, data)
+    @client.raw('post', "/content/conversations/#{id}/attach-user", nil, data_transform(data))
+  end
 
-    # === Attach contact in conversation.
-    # Attach a contact in a conversation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "contact_id": 2
-    #     }
-    #     @data = @mints_user.attach_contact_in_conversation(1, data)
-    def attach_contact_in_conversation(id, data)
-        return @client.raw("post", "/content/conversations/#{id}/attach-contact", nil, data_transform(data))
-    end
+  # === Detach user in conversation.
+  # Detach an user in a conversation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       user_id: 2
+  #     }
+  #     @data = @mints_user.detach_user_in_conversation(13, data)
+  def detach_user_in_conversation(id, data)
+    @client.raw('post', "/content/conversations/#{id}/detach-user", nil, data_transform(data))
+  end
 
-    # === Detach contact in conversation.
-    # Detach a contact in a conversation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Contact id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "contact_id": 2
-    #     }
-    #     @data = @mints_user.detach_contact_in_conversation(1, data)
-    def detach_contact_in_conversation(id, data)
-        return @client.raw("post", "/content/conversations/#{id}/detach-contact", nil, data_transform(data))
-    end
+  # === Attach contact in conversation.
+  # Attach a contact in a conversation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       contact_id: 2
+  #     }
+  #     @data = @mints_user.attach_contact_in_conversation(1, data)
+  def attach_contact_in_conversation(id, data)
+    @client.raw('post', "/content/conversations/#{id}/attach-contact", nil, data_transform(data))
+  end
 
-    # === Attach form in conversation.
-    # Attach a form in a conversation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Conversation id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "form_id": 2
-    #     }
-    #     @data = @mints_user.attach_form_in_conversation(1, data)
-    def attach_form_in_conversation(id, data)
-        return @client.raw("post", "/content/conversations/#{id}/attach-form", nil, data_transform(data))
-    end
+  # === Detach contact in conversation.
+  # Detach a contact in a conversation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Contact id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       contact_id: 2
+  #     }
+  #     @data = @mints_user.detach_contact_in_conversation(1, data)
+  def detach_contact_in_conversation(id, data)
+    @client.raw('post', "/content/conversations/#{id}/detach-contact", nil, data_transform(data))
+  end
 
-    # === Detach form in conversation.
-    # Detach a form in a conversation.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Contact id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "form_id": 2
-    #     }
-    #     @data = @mints_user.detach_form_in_conversation(1, data)
-    def detach_form_in_conversation(id, data)
-        return @client.raw("post", "/content/conversations/#{id}/detach-form", nil, data_transform(data))
-    end
-end
+  # === Attach form in conversation.
+  # Attach a form in a conversation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Conversation id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       form_id: 2
+  #     }
+  #     @data = @mints_user.attach_form_in_conversation(1, data)
+  def attach_form_in_conversation(id, data)
+    @client.raw('post', "/content/conversations/#{id}/attach-form", nil, data_transform(data))
+  end
+
+  # === Detach form in conversation.
+  # Detach a form in a conversation.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Contact id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       form_id: 2
+  #     }
+  #     @data = @mints_user.detach_form_in_conversation(1, data)
+  def detach_form_in_conversation(id, data)
+    @client.raw('post', "/content/conversations/#{id}/detach-form", nil, data_transform(data))
+  end
+end