mints 0.0.27 → 0.0.28

data/lib/user/content/story_versions.rb

@@ -1,124 +1,122 @@
 module StoryVersions
-    # === Get story versions.
-    # Get a collection of story versions.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_story_versions
-    #
-    # ==== Second Example
-    #     options = {
-    #       "fields": "id, title"
-    #     }
-    #     @data = @mints_user.get_story_versions(options)
-    #
-    # ==== Third Example
-    #     options = {
-    #       "fields": "id, title"
-    #     }
-    #     @data = @mints_user.get_story_versions(options, true)
-    def get_story_versions(options = nil, use_post = true)
-        return get_query_results("/content/story-versions", options, use_post)
-    end
+  # === Get story versions.
+  # Get a collection of story versions.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_story_versions
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @mints_user.get_story_versions(options)
+  #
+  # ==== Third Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @mints_user.get_story_versions(options, true)
+  def get_story_versions(options = nil, use_post = true)
+    get_query_results('/content/story-versions', options, use_post)
+  end
 
-    # === Get story version.
-    # Get a story version info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Story version id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_story_version(1)
-    #
-    # ==== Second Example
-    #     options = {
-    #       "fields": "id, title"
-    #     }
-    #     @data = @mints_user.get_story_version(1, options)
-    def get_story_version(id, options = nil)
-        @client.raw("get", "/content/story-versions/#{id}", options)
-    end
+  # === Get story version.
+  # Get a story version info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story version id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_story_version(1)
+  #
+  # ==== Second Example
+  #     options = {
+  #       fields: 'id, title'
+  #     }
+  #     @data = @mints_user.get_story_version(1, options)
+  def get_story_version(id, options = nil)
+    @client.raw('get', "/content/story-versions/#{id}", options)
+  end
 
-    # === Create story version.
-    # Create a story version with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Story",
-    #       "slug": "new-story",
-    #       "social_metadata": "social metadata"
-    #     }
-    #     @data = @mints_user.create_story_version(data)
-    def create_story_version(data, options = nil)
-        @client.raw("post", "/content/story-versions", options, data_transform(data))
-    end
+  # === Create story version.
+  # Create a story version with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Story',
+  #       slug: 'new-story',
+  #       social_metadata: 'social metadata'
+  #     }
+  #     @data = @mints_user.create_story_version(data)
+  def create_story_version(data, options = nil)
+    @client.raw('post', '/content/story-versions', options, data_transform(data))
+  end
 
-    # === Update story version.
-    # Update a story version info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Story version id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Story Modified",
-    #       "slug": "new-story"
-    #     }
-    #     @data = @mints_user.update_story_version(5, data)
-    def update_story_version(id, data, options = nil)
-        @client.raw("put", "/content/story-versions/#{id}", options, data_transform(data))
-    end
+  # === Update story version.
+  # Update a story version info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story version id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Story Modified',
+  #       slug: 'new-story'
+  #     }
+  #     @data = @mints_user.update_story_version(5, data)
+  def update_story_version(id, data, options = nil)
+    @client.raw('put', "/content/story-versions/#{id}", options, data_transform(data))
+  end
 
-    # === Delete story version.
-    # Delete a story version.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Story version id.
-    #
-    # ==== Example
-    #     @data = @mints_user.delete_story_version(6)
-    def delete_story_version(id)
-        @client.raw("delete", "/content/story-versions/#{id}")
-    end
+  # === Delete story version.
+  # Delete a story version.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story version id.
+  #
+  # ==== Example
+  #     @data = @mints_user.delete_story_version(6)
+  def delete_story_version(id)
+    @client.raw('delete', "/content/story-versions/#{id}")
+  end
 
-    # === Duplicate story version.
-    # Duplicate a story version.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Story version id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "options": []
-    #     }
-    #     @data = @mints_user.duplicate_story_version(1, data.to_json)
-    def duplicate_story_version(id, data)
-        @client.raw("post", "/content/story-versions/#{id}/duplicate", nil, data)
-    end
+  # === Duplicate story version.
+  # Duplicate a story version.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story version id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { options: [] }
+  #     @data = @mints_user.duplicate_story_version(1, data.to_json)
+  def duplicate_story_version(id, data)
+    @client.raw('post', "/content/story-versions/#{id}/duplicate", nil, data)
+  end
 
-    # === Publish story version.
-    # Publish a story version.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Story version id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Story Modified",
-    #       "slug": "new-story"
-    #     }
-    #     @data = @mints_user.publish_story_version(1, data.to_json)
-    def publish_story_version(id, data)
-        @client.raw("put", "/content/story-versions/#{id}/publish", nil, data)
-    end
-end
+  # === Publish story version.
+  # Publish a story version.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Story version id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Story Modified',
+  #       slug: 'new-story'
+  #     }
+  #     @data = @mints_user.publish_story_version(1, data.to_json)
+  def publish_story_version(id, data)
+    @client.raw('put', "/content/story-versions/#{id}/publish", nil, data)
+  end
+end

data/lib/user/crm/companies.rb

@@ -1,111 +1,109 @@
 module Companies
-    ##
-    # == Companies
-    #
+  ##
+  # == Companies
+  #
 
-    ##
-    # === Get companies support data.
-    # Get support data of companies.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_companies_support_data
-    def get_companies_support_data
-        @client.raw("get", "/crm/companies/support-data")
-    end
-  
-    # === Get companies.
-    # Get a collection of companies.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_companies
-    #
-    # ==== Second Example
-    #     options = { "fields": "id, title", "sort": "-id" }
-    #     @data = @mints_user.get_companies(options)
-    #
-    # ==== Third Example
-    #     options = { "fields": "id, title", "sort": "-id" }
-    #     @data = @mints_user.get_companies(options, false)
-    def get_companies(options = nil, use_post = true)
-        return get_query_results("/crm/companies", options, use_post)
-    end
-  
-    # === Get company.
-    # Get a company info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Company id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_company(21)
-    #
-    # ==== Second Example
-    #     options = { "fields": "id, title" }
-    #     @data = @mints_user.get_company(21, options)
-    def get_company(id, options = nil)
-        @client.raw("get", "/crm/companies/#{id}", options)
-    end
-  
-    # === Create company.
-    # Create a company with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #         "title": "Company Title",
-    #         "alias": "Alias",
-    #         "website": "www.company.example.com",
-    #         "street1": "Company St",
-    #         "city": "Company City",
-    #         "region": "Company Region",
-    #         "postal_code": "12345",
-    #         "country_id": 144,
-    #         "tax_identifier": nil
-    #     }
-    #     @data = @mints_user.create_company(data)
-    def create_company(data, options = nil)
-        @client.raw("post", "/crm/companies/", options, data_transform(data))
-    end
+  ##
+  # === Get companies support data.
+  # Get support data of companies.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_companies_support_data
+  def get_companies_support_data
+    @client.raw('get', '/crm/companies/support-data')
+  end
 
-    # === Update company.
-    # Update a company info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Company id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       "title": "Company Title Modified"
-    #     }
-    #     @data = @mints_user.update_company(23, data)
-    def update_company(id, data, options = nil)
-        @client.raw("put", "/crm/companies/#{id}", options, data_transform(data))
-    end
+  # === Get companies.
+  # Get a collection of companies.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  # use_post:: (Boolean) -- Variable to determine if the request is by 'post' or 'get' functions.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_companies
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @mints_user.get_companies(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'id, title', sort: '-id' }
+  #     @data = @mints_user.get_companies(options, false)
+  def get_companies(options = nil, use_post = true)
+    get_query_results('/crm/companies', options, use_post)
+  end
 
-    ##
-    # == Companies Bulk Actions
-    #
+  # === Get company.
+  # Get a company info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Company id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_company(21)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @mints_user.get_company(21, options)
+  def get_company(id, options = nil)
+    @client.raw('get', "/crm/companies/#{id}", options)
+  end
 
-    # === Delete Companies.
-    # Delete a group of companies.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "ids": [ 21, 22 ]
-    #     }
-    #     @data = @mints_user.delete_companies(data)
-    def delete_companies(data)
-        @client.raw("delete", "/crm/companies/delete", nil, data_transform(data))
-    end
+  # === Create company.
+  # Create a company with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #         title: 'Company Title',
+  #         alias: 'Alias',
+  #         website: 'www.company.example.com',
+  #         street1: 'Company St',
+  #         city: 'Company City',
+  #         region: 'Company Region',
+  #         postal_code: '12345',
+  #         country_id: 144,
+  #         tax_identifier: nil
+  #     }
+  #     @data = @mints_user.create_company(data)
+  def create_company(data, options = nil)
+    @client.raw('post', '/crm/companies/', options, data_transform(data))
+  end
+
+  # === Update company.
+  # Update a company info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Company id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'Company Title Modified'
+  #     }
+  #     @data = @mints_user.update_company(23, data)
+  def update_company(id, data, options = nil)
+    @client.raw('put', "/crm/companies/#{id}", options, data_transform(data))
+  end
+
+  ##
+  # == Companies Bulk Actions
+  #
+
+  # === Delete Companies.
+  # Delete a group of companies.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { ids: %w[21 22] }
+  #     @data = @mints_user.delete_companies(data)
+  def delete_companies(data)
+    @client.raw('delete', '/crm/companies/delete', nil, data_transform(data))
+  end
 end