mints 0.0.16 → 0.0.20

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

data/lib/user/content/dam.rb

@@ -0,0 +1,88 @@
+module DAM
+    ##
+    # == dam
+    #
+
+    # === Get dam loadtree.
+    # Get dam loadtree.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_dam_loadtree
+    def get_dam_loadtree
+        return @client.raw("get", "/content/dam/loadtree")
+    end
+
+    # === Get dam asset locations.
+    # Get an asset locations in dam.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_dam_asset_locations(options)
+    def get_dam_asset_locations(options)
+        return @client.raw("get", "/content/dam/asset-locations", options)
+    end
+    
+    def paste_dam(data) #FIXME: Controller detect object array like a single array.
+        return @client.raw("post", "/content/dam/paste", nil, data)
+    end
+
+    # === Rename dam.
+    # Rename folder or asset in dam.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "itemType": "asset",
+    #       "id": 21,
+    #       "title": "accusantium",
+    #       "description": "Ea cupiditate",
+    #       "slug": "accusantium"
+    #     }
+    #     @data = @mints_user.rename_dam(data.to_json)
+    def rename_dam(data)
+        return @client.raw("post", "/content/dam/rename", nil, data)
+    end
+
+    # === Search dam.
+    # Search folder or asset in dam.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "searchFor": "accusantium"
+    #     }
+    #     @data = @mints_user.search_dam(data.to_json)
+    def search_dam(data)
+        return @client.raw("post", "/content/dam/search", nil, data)
+    end
+
+    def send_to_trash_dam(data) #FIXME: Invalid argument supplied for foreach()
+        return @client.raw("post", "/content/dam/sendToTrash", nil, data)
+    end
+
+    def delete_dam(data) #FIXME: Invalid argument supplied for foreach()
+        return @client.raw("post", "/content/dam/delete", nil, data)
+    end
+
+    # === Create dam folder.
+    # Create a folder in dam.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "folder_name": "New Dam Folder",
+    #       "slug": "new-dam-folder"
+    #     }
+    #     @data = @mints_user.create_dam_folder(data.to_json)
+    def create_dam_folder(data)
+        return @client.raw("post", "/content/folders/create", nil, data)
+    end
+end

data/lib/user/content/forms.rb

@@ -0,0 +1,168 @@
+module Forms
+    ##
+    # == Forms
+    #
+
+    # === Get forms.
+    # Get a collection of forms.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_forms
+    #
+    # ==== Second Example
+    #     options = { "sort": "id", "fields": "title" }
+    #     @data = @mints_user.get_forms(options)
+    def get_forms(options = nil)
+        return @client.raw("get", "/content/forms", options)
+    end
+
+    # === Publish form.
+    # Publish a form.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "data": {
+    #         "slug": "new-publish"
+    #       }
+    #     }
+    #     @data = @mints_user.publish_form(1, data.to_json)
+    def publish_form(id, data) #FIXME: Output cannot be processed. response cannot be converted to json.
+        return @client.raw("put", "/content/forms/#{id}/publish", nil, data)
+    end
+
+    # === Schedule form.
+    # Schedule a form in a specified date.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "data": {
+    #         "scheduled_at": "2021-09-06T20:29:16+00:00"
+    #       }
+    #     }
+    #     @data = @mints_user.schedule_form(1, data.to_json)
+    def schedule_form(id, data) #FIXME: Output cannot be processed. response cannot be converted to json.
+        return @client.raw("put", "/content/forms/#{id}/schedule", nil, data)
+    end
+
+    # === Revert published form.
+    # Revert a published form.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form id.
+    #
+    # ==== Example
+    #     @data = @mints_user.revert_published_form(1)
+    def revert_published_form(id)
+        return @client.raw("get", "/content/forms/#{id}/revert-published-data")
+    end
+
+    # === Duplicate form.
+    # Duplicate a form.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form id.
+    #
+    # ==== Example
+    #     @data = @mints_user.duplicate_form(3)
+    def duplicate_form(id)
+        return @client.raw("post", "/content/forms/#{id}/duplicate")
+    end
+
+    # === Get form support data.
+    # Get form support data.
+    #
+    # ==== Example
+    #     @data = @mints_user.get_form_support_data
+    def get_form_support_data
+        return @client.raw("get", "/content/forms/support-data")
+    end
+
+    # === Get form submissions.
+    # Get form submissions.
+    #
+    # ==== Parameters
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_form_submissions
+    #
+    # ==== Second Example
+    #     options = { "fields": "id" }
+    #     @data = @mints_user.get_form_submissions(options)
+    def get_form_submissions(options = nil)
+        return @client.raw("get", "/content/forms/submissions", options)
+    end
+
+    # === Get form.
+    # Get a form info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form id.
+    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+    #
+    # ==== First Example
+    #     @data = @mints_user.get_form(9)
+    #
+    # ==== Second Example
+    #     options = { "sort": "id", "fields": "title" }
+    #     @data = @mints_user.get_form(2, options)
+    def get_form(id, options = nil)
+        return @client.raw("get", "/content/forms/#{id}", options)
+    end
+
+    # === Create form.
+    # Create a form with data.
+    #
+    # ==== Parameters
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Form",
+    #       "slug": "new-form-slug"
+    #     }
+    #     @data = @mints_user.create_form(data)
+    def create_form(data)
+        return @client.raw("post", "/content/forms", nil, data_transform(data))
+    end
+
+    # === Update form.
+    # Update a form info.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form id.
+    # data:: (Hash) -- Data to be submited.
+    #
+    # ==== Example
+    #     data = {
+    #       "title": "New Form Modified",
+    #       "slug": "new-form-slug"
+    #     }
+    #     @data = @mints_user.update_form(3, data)
+    def update_form(id, data)
+        return @client.raw("put", "/content/forms/#{id}", nil, data_transform(data))
+    end
+
+    # === Delete form.
+    # Delete a form.
+    #
+    # ==== Parameters
+    # id:: (Integer) -- Form id.
+    #
+    # ==== Example
+    #     @data = @mints_user.delete_form(9)
+    def delete_form(id)
+        return @client.raw("delete", "/content/forms/#{id}")
+    end
+end