mints 0.0.17 → 0.0.21

data/lib/user/content/content.rb

@@ -0,0 +1,235 @@
+require_relative './assets.rb'
+require_relative './content_instances.rb'
+require_relative './content_templates.rb'
+require_relative './conversations.rb'
+require_relative './dam.rb'
+require_relative './forms.rb'
+require_relative './message_templates.rb'
+require_relative './messages.rb'
+require_relative './pages.rb'
+require_relative './stories.rb'
+require_relative './story_templates.rb'
+
+module Content
+    include Assets
+    include ContentInstances
+    include ContentTemplates
+    include Conversations
+    include DAM
+    include Forms
+    include MessageTemplates
+    include Messages
+    include Pages
+    include Stories
+    include StoryTemplates
+
+    # === Get public images url.
+    # Get public images url.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_public_images_url
+    def get_public_images_url
+        return @client.raw("get", "/content/public-images-url")
+    end
+
+    ##
+    # == Authors
+    #
+
+    # === Get authors.
+    # Get authors.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_authors
+    def get_authors
+        return @client.raw("get", "/content/authors")
+    end
+
+
+    # === Get author.
+    # Get an author.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Author id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_author(1)
+    def get_author(id)
+        return @client.raw("get", "/content/authors/#{id}")
+    end
+
+    # === Create author.
+    # Create an author with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "Howard Phillips Lovecraft",
+    #       "slug": "howard-phillips-lovecraft"
+    #     }
+    #     @data = @mints_user.create_author(data.to_json)
+    def create_author(data)
+        return @client.raw("post", "/content/authors", nil, data)
+    end
+
+    # === Update author.
+    # Update an author info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Author id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     
+    def update_author(id, data)
+        #FIXME: Author controller doesnt receive data
+        return @client.raw("put", "/content/authors/#{id}", nil, data)
+    end
+
+    ##
+    # == Keywords
+    #
+
+    # === Get keywords.
+    # Get a collection of keywords.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_keywords
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_keywords(options)
+    def get_keywords(options = nil)
+        return @client.raw("get", "/content/keywords", options)
+    end
+    
+    # === Get keyword.
+    # Get a keyword.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Keyword id.
+    #
+    def get_keyword(id)
+        return @client.raw("get", "/content/keywords/#{id}")
+    end
+
+    # === Create keyword.
+    # Create a keyword with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Keyword"
+    #     }
+    #     @data = @mints_user.create_keyword(data.to_json)
+    def create_keyword(data)
+        return @client.raw("post", "/content/keywords", nil, data)
+    end
+
+    # === Update keyword.
+    # Update a keyword info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Keyword id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     
+    def update_keyword(id, data)
+        #FIXME: Keyword controller doesnt receive data
+        return @client.raw("put", "/content/keywords/#{id}", nil, data)
+    end
+
+    ##
+    # == Stages
+    #    
+
+    # === Get stages.
+    # Get a collection of stages.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_stages
+    #
+    # ==== Second Example
+    #     options = { "fields": "title" }
+    #     @data = @mints_user.get_stages(options)
+    def get_stages(options = nil)
+        return @client.raw("get", "/content/stages", options)
+    end
+
+    # === Get stage.
+    # Get a stage.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Stage id.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_stage(1)
+    def get_stage(id)
+        return @client.raw("get", "/content/stages/#{id}")
+    end
+
+    # === Create stage.
+    # Create a stage with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     config_json = {
+    #       "count": 1
+    #     }
+    #     event_json = {
+    #       "rset": "DTSTART:20190214T000000Z",
+    #       "duration": 1
+    #     }
+    #     data = {
+    #       "title": "New Stage",
+    #       "description": "New Stage Description",
+    #       "config_json": config_json.to_json,
+    #       "event_json": event_json.to_json
+    #     }
+    #     @data = @mints_user.create_stage(data.to_json)
+    def create_stage(data)
+        return @client.raw("post", "/content/stages", nil, data)
+    end
+
+    # === Update stage.
+    # Update a stage info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Stage id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     config_json = {
+    #       "count": 2
+    #     }
+    #     event_json = {
+    #       "rset": "DTSTART:20190214T000000Z",
+    #       "duration": 2
+    #     }
+    #     data = {
+    #       "stageProps": { 
+    #         "title": "New Stage Modified",
+    #         "description": "New Stage Description Modified"
+    #       },
+    #       "config_json": config_json.to_json,
+    #       "event_json": event_json.to_json
+    #     }
+    #     @data = @mints_user.update_stage(3, data.to_json)
+    def update_stage(id, data)
+        #TODO: Inform StageController.update method has been modified
+        return @client.raw("put", "/content/stages/#{id}", nil, data)
+    end
+end

data/lib/user/content/content_instances.rb

@@ -0,0 +1,147 @@
+module ContentInstances
+    ##
+    # == Content Instances
+    #
+
+    # === Get content instances.
+    # Get a collection of content instances.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_content_instances
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_content_instances(options)
+    def get_content_instances(options = nil)
+        return @client.raw("get", "/content/instances", options)
+    end
+
+    # === Duplicate content instance.
+    # Duplicate a content instance.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Content instance id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "options": [] 
+    #     }
+    #     @data = @mints_user.duplicate_content_instance(1, data.to_json)
+    def duplicate_content_instance(id, data)
+        return @client.raw("post", "/content/instances/#{id}/duplicate", nil, data)
+    end
+    
+    # === Get content instance.
+    # Get a content instance info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Content instance id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_content_instance(1)
+    #
+    # ==== Second Example
+    #     options = { "fields": "id, title" }
+    #     @data = @mints_user.get_content_instance(1, options)
+    def get_content_instance(id, options = nil)
+        return @client.raw("get", "/content/instances/#{id}", options)
+    end
+
+    # === Publish content instance.
+    # Publish a content instance.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Content instance id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New publish",
+    #       "slug": "new-publish",
+    #       "content_template_id": 1
+    #     }
+    #     @data = @mints_user.publish_content_instance(2, data)
+    def publish_content_instance(id, data)
+        return @client.raw("put", "/content/instances/#{id}/publish", nil, data_transform(data))
+    end
+
+    # === Schedule content instance.
+    # Schedule a content instance in a specified date.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Content instance id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = { 
+    #       "scheduled_at": "2021-09-06T20:29:16+00:00"
+    #     }
+    #     @data = @mints_user.schedule_content_instance(1, data)
+    def schedule_content_instance(id, data)
+        return @client.raw("put", "/content/instances/#{id}/schedule", nil, data_transform(data))
+    end
+
+    # === Revert published content instance.
+    # Revert a published content instance.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Content instance id.
+    #
+    # ==== Example
+    #     @data = @mints_user.revert_published_content_instance(1)
+    def revert_published_content_instance(id)
+        return @client.raw("get", "/content/instances/#{id}/revert-published-data")
+    end
+
+    # === Create content instance.
+    # Create a content instance with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Content Instance",
+    #       "content_template_id": 1,
+    #       "slug": "new-content-instance-slug"
+    #     }
+    #     @data = @mints_user.create_content_instance(data)
+    def create_content_instance(data)
+        return @client.raw("post", "/content/instances",  nil, data_transform(data))
+    end
+
+    # === Update content instance.
+    # Update a content instance info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Content instance id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Content Instance Modified",
+    #       "content_template_id": 1,
+    #       "slug": "new-content-instance-slug"
+    #     }
+    #     @data = @mints_user.update_content_instance(18, data)
+    def update_content_instance(id, data)
+        return @client.raw("put", "/content/instances/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete content instance.
+    # Delete a content instance.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Content instance id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_content_instance(20)
+    def delete_content_instance(id)
+        return @client.raw("delete", "/content/instances/#{id}")
+    end
+end

data/lib/user/content/content_templates.rb

@@ -0,0 +1,111 @@
+module ContentTemplates
+    ##
+    # == 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
+
+    # === 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
+
+    # === 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 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
+
+    # === Create content template.
+    # Create a content template with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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
+
+    # === Update content template.
+    # Update a content template info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Content template id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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
+
+    # === 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

data/lib/user/content/conversations.rb

@@ -0,0 +1,174 @@
+module 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 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
+
+    # === Create conversation.
+    # Create a conversation with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Conversation"
+    #     }
+    #     @data = @mints_user.create_conversation(data)
+    def create_conversation(data)
+        return @client.raw("post", "/content/conversations", nil, data_transform(data))
+    end
+
+    # === Update conversation.
+    # Update a conversation info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Conversation id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Conversation Modified"
+    #     }
+    #     @data = @mints_user.update_conversation(13, data)
+    def update_conversation(id, data)
+        return @client.raw("put", "/content/conversations/#{id}", 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)
+        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 submited.
+    #
+    # ==== 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
+
+    # === 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
+
+    # === Attach user in conversation.
+    # Attach an user in a conversation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Conversation id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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
+
+    # === Detach user in conversation.
+    # Detach an user in a conversation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Conversation id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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 contact in conversation.
+    # Attach a contact in a conversation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Conversation id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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 contact in conversation.
+    # Detach a contact in a conversation.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Contact id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== 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
+end