mints 0.0.27 → 0.0.29

data/lib/user/content/content_instances.rb

@@ -1,147 +1,147 @@
+# frozen_string_literal: true
+
 module ContentInstances
-    ##
-    # == Content Instances
-    #
+  ##
+  # == 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)
+    @client.raw('get', '/content/instances', options)
+  end
 
-    # === 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)
-        @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 submitted.
+  #
+  # ==== Example
+  #     data = { options: [] }
+  #     @data = @mints_user.duplicate_content_instance(1, data.to_json)
+  def duplicate_content_instance(id, data)
+    @client.raw('post', "/content/instances/#{id}/duplicate", nil, data)
+  end
 
-    # === Duplicate content instance.
-    # Duplicate a content instance.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Content instance id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       "options": [] 
-    #     }
-    #     @data = @mints_user.duplicate_content_instance(1, data.to_json)
-    def duplicate_content_instance(id, data)
-        @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)
-        @client.raw("get", "/content/instances/#{id}", options)
-    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)
+    @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 submitted.
-    #
-    # ==== 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)
-        @client.raw("put", "/content/instances/#{id}/publish", nil, data_transform(data))
-    end
+  # === Publish content instance.
+  # Publish a content instance.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Content instance id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== 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)
+    @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 submitted.
-    #
-    # ==== 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)
-        @client.raw("put", "/content/instances/#{id}/schedule", 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 submitted.
+  #
+  # ==== 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)
+    @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)
-        @client.raw("get", "/content/instances/#{id}/revert-published-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)
+    @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 submitted.
-    #
-    # ==== 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)
-        @client.raw("post", "/content/instances",  nil, data_transform(data))
-    end
+  # === Create content instance.
+  # Create a content instance with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== 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)
+    @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 submitted.
-    #
-    # ==== 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)
-        @client.raw("put", "/content/instances/#{id}", nil, data_transform(data))
-    end
+  # === Update content instance.
+  # Update a content instance info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Content instance id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== 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)
+    @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)
-        @client.raw("delete", "/content/instances/#{id}")
-    end
-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)
+    @client.raw('delete', "/content/instances/#{id}")
+  end
+end

data/lib/user/content/content_templates.rb

@@ -1,111 +1,113 @@
+# frozen_string_literal: true
+
 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)
-        @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)
-        @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)
-        @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)
-        @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
-        @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
-        @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
-        @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