mints 0.0.26 → 0.0.28

data/lib/user/crm/deals.rb

@@ -1,111 +1,111 @@
 module Deals
-    ##
-    # == Deals
-    #
+  ##
+  # == Deals
+  #
 
-    ##
-    # === Get deal permits.
-    # Get permits of a deal.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Deal id.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_deal_permits(7)
-    def get_deal_permits(id)
-        return @client.raw("get", "/crm/deals/#{id}/permits")
-    end
+  ##
+  # === Get deal permits.
+  # Get permits of a deal.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Deal id.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_deal_permits(7)
+  def get_deal_permits(id)
+    @client.raw('get', "/crm/deals/#{id}/permits")
+  end
 
-    ##
-    # === Get deal support data.
-    # Get support data of deals.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_deal_support_data
-    def get_deal_support_data
-        return @client.raw("get", "/crm/deals/support-data")
-    end
+  ##
+  # === Get deal support data.
+  # Get support data of deals.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_deal_support_data
+  def get_deal_support_data
+    @client.raw('get', '/crm/deals/support-data')
+  end
 
-    ##
-    # === Get deal currencies.
-    # Get currencies of deals.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_deal_currencies
-    def get_deal_currencies
-        return @client.raw("get", "/crm/deal/currencies")
-    end
+  ##
+  # === Get deal currencies.
+  # Get currencies of deals.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_deal_currencies
+  def get_deal_currencies
+    @client.raw('get', '/crm/deal/currencies')
+  end
 
-    # === Get deals.
-    # Get a collection of deals.
-    #
-    # ==== 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_deals
-    #
-    # ==== Second Example
-    #     options = { "fields": "id, title" }
-    #     @data = @mints_user.get_deals(options)
-    #
-    # ==== Third Example
-    #     options = { "fields": "id, title" }
-    #     @data = @mints_user.get_deals(options, false)
-    def get_deals(options = nil, use_post = true)
-        return get_query_results("/crm/deals", options, use_post)
-    end
+  # === Get deals.
+  # Get a collection of deals.
+  #
+  # ==== 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_deals
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @mints_user.get_deals(options)
+  #
+  # ==== Third Example
+  #     options = { fields: 'id, title' }
+  #     @data = @mints_user.get_deals(options, false)
+  def get_deals(options = nil, use_post = true)
+    get_query_results('/crm/deals', options, use_post)
+  end
 
-    # === Get deal.
-    # Get a deal info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Deal id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_deal(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "id, title" }
-    #     @data = @mints_user.get_deal(1, options)
-    def get_deal(id, options = nil)
-        return @client.raw("get", "/crm/deals/#{id}", options)
-    end
+  # === Get deal.
+  # Get a deal info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Deal id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_deal(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @mints_user.get_deal(1, options)
+  def get_deal(id, options = nil)
+    @client.raw('get', "/crm/deals/#{id}", options)
+  end
 
-    # === Create deal.
-    # Create a deal with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "dealData": {
-    #         "title": "New deal",
-    #         "stepId": 1,
-    #         "value": 10500
-    #       }
-    #     }
-    #     @data = @mints_user.create_deal(data.to_json)
-    def create_deal(data, options = nil)
-        return @client.raw("post", "/crm/deals", options, data)
-    end
+  # === Create deal.
+  # Create a deal with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       dealData: {
+  #         title: 'New deal',
+  #         stepId: 1,
+  #         value: 10500
+  #       }
+  #     }
+  #     @data = @mints_user.create_deal(data.to_json)
+  def create_deal(data, options = nil)
+    @client.raw('post', '/crm/deals', options, data)
+  end
 
-    # === Update deal.
-    # Update a deal data.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Deal id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = {
-    #       "title": "New Deal Modified"
-    #     }
-    #     @data = @mints_user.update_deal(102, data.to_json)
-    def update_deal(id, data, options = nil)
-        return @client.raw("put", "/crm/deals/#{id}", options, data)
-    end
-end
+  # === Update deal.
+  # Update a deal data.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Deal id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Deal Modified'
+  #     }
+  #     @data = @mints_user.update_deal(102, data.to_json)
+  def update_deal(id, data, options = nil)
+    @client.raw('put', "/crm/deals/#{id}", options, data)
+  end
+end

data/lib/user/crm/favorites.rb

@@ -1,17 +1,18 @@
 module Favorites
-    ##
-    # == Favorites #TODO: NOT CHECKED, NO DATA IN DB
-    #
+  ##
+  # == Favorites
+  # TODO: NOT CHECKED, NO DATA IN DB
+  #
 
-    def update_multiple_favorites(data)
-        return @client.raw("put", "/crm/favorites", nil, data)
-    end
+  def update_multiple_favorites(data)
+    @client.raw('put', '/crm/favorites', nil, data)
+  end
 
-    def get_favorites(options = nil)
-        return @client.raw("get", "/crm/favorites", options)
-    end
+  def get_favorites(options = nil)
+    @client.raw('get', '/crm/favorites', options)
+  end
 
-    def update_favorites(id, data)
-        return @client.raw("put", "/crm/favorites/#{id}", nil, data)
-    end
-end
+  def update_favorites(id, data)
+    @client.raw('put', "/crm/favorites/#{id}", nil, data)
+  end
+end

data/lib/user/crm/segments.rb

@@ -1,132 +1,130 @@
 module Segments
-    ##
-    # == Segments
-    #
+  ##
+  # == Segments
+  #
 
-    # === Get segments support data.
-    # Get segments support data.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_segments_support_data
-    def get_segments_support_data
-        return @client.raw("get", "/crm/segments/support-data")
-    end
+  # === Get segments support data.
+  # Get segments support data.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_segments_support_data
+  def get_segments_support_data
+    @client.raw('get', '/crm/segments/support-data')
+  end
 
-    # === Get segments attributes.
-    # Get segments attributes.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== Example
-    #     options = { "object_type": "contacts" }
-    #     @data = @mints_user.get_segments_attributes(options)
-    def get_segments_attributes(options = nil)
-        return @client.raw("get", "/crm/segments/attributes", options)
-    end
+  # === Get segments attributes.
+  # Get segments attributes.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== Example
+  #     options = { object_type: 'contacts' }
+  #     @data = @mints_user.get_segments_attributes(options)
+  def get_segments_attributes(options = nil)
+    @client.raw('get', '/crm/segments/attributes', options)
+  end
 
-    # === Get segment group.
-    # Get segment group.
-    #
-    # ==== Parameters
-    # groupId:: (String) -- Group's name.
-    #
-    # ==== Example
-    #     @data = @mints_user.get_segment_group("users")
-      def get_segment_group(groupId)
-        return @client.raw("get", "/crm/segments/groups/#{groupId}")
-    end
+  # === Get segment group.
+  # Get segment group.
+  #
+  # ==== Parameters
+  # group_id:: (String) -- Group's name.
+  #
+  # ==== Example
+  #     @data = @mints_user.get_segment_group("users")
+  def get_segment_group(group_id)
+    @client.raw('get', "/crm/segments/groups/#{group_id}")
+  end
 
-    # === Duplicate segment.
-    # Duplicate a segment.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Segment id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       "options": [] 
-    #     }
-    #     @data = @mints_user.duplicate_segment(107, data)
-    def duplicate_segment(id, data)
-        return @client.raw("post", "/crm/segments/#{id}/duplicate", nil, data)
-    end
-    
-    # === Get segments.
-    # Get a collection of segments.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_segments
-    #
-    # ==== Second Example
-    #     options = { "fields": "id", "sort": "-id" }
-    #     @data = @mints_user.get_segments(options)
-    def get_segments(options = nil)
-        return @client.raw("get", "/crm/segments", options)
-    end
+  # === Duplicate segment.
+  # Duplicate a segment.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Segment id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = { options: [] }
+  #     @data = @mints_user.duplicate_segment(107, data)
+  def duplicate_segment(id, data)
+    @client.raw('post', "/crm/segments/#{id}/duplicate", nil, data)
+  end
 
-    # === Get segment.
-    # Get a segment info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Segment id.
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_segment(1)
-    #
-    # ==== Second Example
-    #     options = { "fields": "id, title" }
-    #     @data = @mints_user.get_segment(1, options)
-    def get_segment(id, options = nil)
-        return @client.raw("get", "/crm/segments/#{id}", options)
-    end
+  # === Get segments.
+  # Get a collection of segments.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_segments
+  #
+  # ==== Second Example
+  #     options = { fields: 'id', sort: '-id' }
+  #     @data = @mints_user.get_segments(options)
+  def get_segments(options = nil)
+    @client.raw('get', '/crm/segments', options)
+  end
 
-    # === Create segment.
-    # Create a segment with data.
-    #
-    # ==== Parameters
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       "title": "New Segment",
-    #       "object_type": "deals"
-    #     }
-    #     @data = @mints_user.create_segment(data)
-    def create_segment(data)
-        return @client.raw("post", "/crm/segments", nil, data_transform(data))
-    end
+  # === Get segment.
+  # Get a segment info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Segment id.
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_segment(1)
+  #
+  # ==== Second Example
+  #     options = { fields: 'id, title' }
+  #     @data = @mints_user.get_segment(1, options)
+  def get_segment(id, options = nil)
+    @client.raw('get', "/crm/segments/#{id}", options)
+  end
 
-    # === Update segment.
-    # Update a segment info.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Segment id.
-    # data:: (Hash) -- Data to be submitted.
-    #
-    # ==== Example
-    #     data = { 
-    #       "title": "New Segment Modified"
-    #     }
-    #     @data = @mints_user.update_segment(118, data)
-    def update_segment(id, data)
-        return @client.raw("put", "/crm/segments/#{id}", nil, data_transform(data))
-    end
+  # === Create segment.
+  # Create a segment with data.
+  #
+  # ==== Parameters
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Segment',
+  #       object_type: 'deals'
+  #     }
+  #     @data = @mints_user.create_segment(data)
+  def create_segment(data)
+    @client.raw('post', '/crm/segments', nil, data_transform(data))
+  end
 
-    # === Delete segment.
-    # Delete a segment.
-    #
-    # ==== Parameters
-    # id:: (Integer) -- Segment id.
-    #
-    # ==== Example
-    #     @mints_user.delete_segment(113)
-    def delete_segment(id)
-        return @client.raw("delete", "/crm/segments/#{id}")
-    end
-end
+  # === Update segment.
+  # Update a segment info.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Segment id.
+  # data:: (Hash) -- Data to be submitted.
+  #
+  # ==== Example
+  #     data = {
+  #       title: 'New Segment Modified'
+  #     }
+  #     @data = @mints_user.update_segment(118, data)
+  def update_segment(id, data)
+    @client.raw('put', "/crm/segments/#{id}", nil, data_transform(data))
+  end
+
+  # === Delete segment.
+  # Delete a segment.
+  #
+  # ==== Parameters
+  # id:: (Integer) -- Segment id.
+  #
+  # ==== Example
+  #     @mints_user.delete_segment(113)
+  def delete_segment(id)
+    @client.raw('delete', "/crm/segments/#{id}")
+  end
+end

data/lib/user/crm/users.rb

@@ -1,22 +1,22 @@
 module Users
-    ##
-    # == Users
-    #
+  ##
+  # == Users
+  #
 
-    ###
-    # === Get crm users.
-    # Get users info in crm.
-    #
-    # ==== Parameters
-    # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
-    #
-    # ==== First Example
-    #     @data = @mints_user.get_crm_users
-    #
-    # ==== Second Example
-    #     options = { "sort": "id", "fields": "id, email" }
-    #     @data = @mints_user.get_crm_users(options)
-    def get_crm_users(options = nil)
-        return @client.raw("get", "/crm/users", options)
-    end
-end
+  ###
+  # === Get crm users.
+  # Get users info in crm.
+  #
+  # ==== Parameters
+  # options:: (Hash) -- List of Resource Collection Options shown above can be used as parameter.
+  #
+  # ==== First Example
+  #     @data = @mints_user.get_crm_users
+  #
+  # ==== Second Example
+  #     options = { sort: 'id', fields: 'id, email' }
+  #     @data = @mints_user.get_crm_users(options)
+  def get_crm_users(options = nil)
+    @client.raw('get', '/crm/users', options)
+  end
+end