basecrm 1.3.2 → 1.3.3

data/lib/basecrm/services/pipelines_service.rb

@@ -7,17 +7,17 @@ module BaseCRM
     end
 
     # Retrieve all pipelines
-    # 
+    #
     # get '/pipelines'
     #
     # If you want to use filtering or sorting (see #where).
-    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources.
     def all
       PaginatedResource.new(self)
     end
 
     # Retrieve all pipelines
-    # 
+    #
     # get '/pipelines'
     #
     # Returns all pipelines available to the user, according to the parameters provided
@@ -28,13 +28,13 @@ module BaseCRM
     # @option options [Integer] :page (1) The page number to start from. Page numbering starts at 1, and omitting the `page` parameter will return the first page.
     # @option options [Integer] :per_page (25) The number of records to be returned per page. The default limit is *25* and the maximum number that can be returned is *100*.
     # @option options [String] :sort_by (id:asc) Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. The **default** ordering is **ascending**. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=position:desc`. Unsupported for now.
-    # @return [Array<Pipeline>] The list of Pipelines for the first page, unless otherwise specified. 
+    # @return [Array<Pipeline>] The list of Pipelines for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/pipelines", options)
 
       root[:items].map{ |item| Pipeline.new(item[:data]) }
     end
-    
+
 
   private
     def validate_type!(pipeline)

data/lib/basecrm/services/sources_service.rb

@@ -9,17 +9,17 @@ module BaseCRM
     end
 
     # Retrieve all sources
-    # 
+    #
     # get '/sources'
     #
     # If you want to use filtering or sorting (see #where).
-    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources.
     def all
       PaginatedResource.new(self)
     end
 
     # Retrieve all sources
-    # 
+    #
     # get '/sources'
     #
     # Returns all deal sources available to the user according to the parameters provided
@@ -30,16 +30,16 @@ module BaseCRM
     # @option options [Integer] :page (1) Page number to start from. Page numbering starts at 1, and omitting the `page` parameter will return the first page.
     # @option options [Integer] :per_page (25) Number of records to return per page. The default limit is *25* and the maximum number that can be returned is *100*.
     # @option options [String] :sort_by (id:asc) A field to sort by. The **default** ordering is **ascending**. If you want to change the sort order to descending, append `:desc` to the field e.g. `sort_by=name:desc`.
-    # @return [Array<Source>] The list of Sources for the first page, unless otherwise specified. 
+    # @return [Array<Source>] The list of Sources for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/sources", options)
 
       root[:items].map{ |item| Source.new(item[:data]) }
     end
-    
+
 
     # Create a source
-    # 
+    #
     # post '/sources'
     #
     # Creates a new source
@@ -47,8 +47,8 @@ module BaseCRM
     # Source's name **must** be unique
     # </figure>
     #
-    # @param source [Source, Hash] Either object of the Source type or Hash. This object's attributes describe the object to be created. 
-    # @return [Source] The resulting object represting created resource. 
+    # @param source [Source, Hash] Either object of the Source type or Hash. This object's attributes describe the object to be created.
+    # @return [Source] The resulting object represting created resource.
     def create(source)
       validate_type!(source)
 
@@ -57,26 +57,26 @@ module BaseCRM
 
       Source.new(root[:data])
     end
-    
+
 
     # Retrieve a single source
-    # 
+    #
     # get '/sources/{id}'
     #
     # Returns a single source available to the user by the provided id
     # If a source with the supplied unique identifier does not exist it returns an error
     #
     # @param id [Integer] Unique identifier of a Source
-    # @return [Source] Searched resource object. 
+    # @return [Source] Searched resource object.
     def find(id)
       _, _, root = @client.get("/sources/#{id}")
 
       Source.new(root[:data])
     end
-    
+
 
     # Update a source
-    # 
+    #
     # put '/sources/{id}'
     #
     # Updates source information
@@ -85,8 +85,8 @@ module BaseCRM
     # If you want to update a source, you **must** make sure source's name is unique
     # </figure>
     #
-    # @param source [Source, Hash] Either object of the Source type or Hash. This object's attributes describe the object to be updated. 
-    # @return [Source] The resulting object represting updated resource. 
+    # @param source [Source, Hash] Either object of the Source type or Hash. This object's attributes describe the object to be updated.
+    # @return [Source] The resulting object represting updated resource.
     def update(source)
       validate_type!(source)
       params = extract_params!(source, :id)
@@ -97,10 +97,10 @@ module BaseCRM
 
       Source.new(root[:data])
     end
-    
+
 
     # Delete a source
-    # 
+    #
     # delete '/sources/{id}'
     #
     # Delete an existing source
@@ -113,7 +113,7 @@ module BaseCRM
       status, _, _ = @client.delete("/sources/#{id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(source)
@@ -125,7 +125,7 @@ module BaseCRM
       raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
       params
     end
-       
+
     def sanitize(source)
       source.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
     end

data/lib/basecrm/services/stages_service.rb

@@ -7,17 +7,17 @@ module BaseCRM
     end
 
     # Retrieve all stages
-    # 
+    #
     # get '/stages'
     #
     # If you want to use filtering or sorting (see #where).
-    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources.
     def all
       PaginatedResource.new(self)
     end
 
     # Retrieve all stages
-    # 
+    #
     # get '/stages'
     #
     # Returns all stages available to the user, according to the parameters provided
@@ -30,13 +30,13 @@ module BaseCRM
     # @option options [Integer] :per_page (25) The number of records to return per page. The default limit is *25* and the maximum number that can be returned is *100*.
     # @option options [Integer] :pipeline_id (1) The unique identifier of the pipeline that contains this stage.
     # @option options [String] :sort_by (id:asc) Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. The **default** ordering is **ascending**. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=position:desc`. Unsupported for now.
-    # @return [Array<Stage>] The list of Stages for the first page, unless otherwise specified. 
+    # @return [Array<Stage>] The list of Stages for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/stages", options)
 
       root[:items].map{ |item| Stage.new(item[:data]) }
     end
-    
+
 
   private
     def validate_type!(stage)

data/lib/basecrm/services/tags_service.rb

@@ -9,17 +9,17 @@ module BaseCRM
     end
 
     # Retrieve all tags
-    # 
+    #
     # get '/tags'
     #
     # If you want to use filtering or sorting (see #where).
-    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources.
     def all
       PaginatedResource.new(self)
     end
 
     # Retrieve all tags
-    # 
+    #
     # get '/tags'
     #
     # Returns all tags available to the user, according to the parameters provided
@@ -32,23 +32,23 @@ module BaseCRM
     # @option options [Integer] :per_page (25) Number of records to return per page. The default limit is *25* and the maximum number that can be returned is *100*.
     # @option options [String] :resource_type Type name of resource to search for.
     # @option options [String] :sort_by (updated_at:asc) A field to sort by. The **default** order is **ascending**. If you want to change the sort order to descending, append `:desc` to the field e.g. `sort_by=name:desc`.
-    # @return [Array<Tag>] The list of Tags for the first page, unless otherwise specified. 
+    # @return [Array<Tag>] The list of Tags for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/tags", options)
 
       root[:items].map{ |item| Tag.new(item[:data]) }
     end
-    
+
 
     # Create a tag
-    # 
+    #
     # post '/tags'
     #
     # Creates a new tag
     # **Notice** the tag's name **must** be unique within the scope of the resource_type
     #
-    # @param tag [Tag, Hash] Either object of the Tag type or Hash. This object's attributes describe the object to be created. 
-    # @return [Tag] The resulting object represting created resource. 
+    # @param tag [Tag, Hash] Either object of the Tag type or Hash. This object's attributes describe the object to be created.
+    # @return [Tag] The resulting object represting created resource.
     def create(tag)
       validate_type!(tag)
 
@@ -57,34 +57,34 @@ module BaseCRM
 
       Tag.new(root[:data])
     end
-    
+
 
     # Retrieve a single tag
-    # 
+    #
     # get '/tags/{id}'
     #
     # Returns a single tag available to the user according to the unique ID provided
     # If the specified tag does not exist, this query will return an error
     #
     # @param id [Integer] Unique identifier of a Tag
-    # @return [Tag] Searched resource object. 
+    # @return [Tag] Searched resource object.
     def find(id)
       _, _, root = @client.get("/tags/#{id}")
 
       Tag.new(root[:data])
     end
-    
+
 
     # Update a tag
-    # 
+    #
     # put '/tags/{id}'
     #
     # Updates a tag's information
     # If the specified tag does not exist, this query will return an error
     # **Notice** if you want to update a tag, you **must** make sure the tag's name is unique within the scope of the specified resource
     #
-    # @param tag [Tag, Hash] Either object of the Tag type or Hash. This object's attributes describe the object to be updated. 
-    # @return [Tag] The resulting object represting updated resource. 
+    # @param tag [Tag, Hash] Either object of the Tag type or Hash. This object's attributes describe the object to be updated.
+    # @return [Tag] The resulting object represting updated resource.
     def update(tag)
       validate_type!(tag)
       params = extract_params!(tag, :id)
@@ -95,10 +95,10 @@ module BaseCRM
 
       Tag.new(root[:data])
     end
-    
+
 
     # Delete a tag
-    # 
+    #
     # delete '/tags/{id}'
     #
     # Deletes an existing tag
@@ -112,7 +112,7 @@ module BaseCRM
       status, _, _ = @client.delete("/tags/#{id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(tag)
@@ -124,7 +124,7 @@ module BaseCRM
       raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
       params
     end
-       
+
     def sanitize(tag)
       tag.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
     end

data/lib/basecrm/services/tasks_service.rb

@@ -9,17 +9,17 @@ module BaseCRM
     end
 
     # Retrieve all tasks
-    # 
+    #
     # get '/tasks'
     #
     # If you want to use filtering or sorting (see #where).
-    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources.
     def all
       PaginatedResource.new(self)
     end
 
     # Retrieve all tasks
-    # 
+    #
     # get '/tasks'
     #
     # Returns all tasks available to the user, according to the parameters provided
@@ -40,16 +40,16 @@ module BaseCRM
     # @option options [String] :resource_type Name of the resource type to search for.
     # @option options [String] :sort_by (updated_at:asc) A field to sort by. The **default** ordering is **ascending**. If you want to change the sort order to descending, append `:desc` to the field e.g. `sort_by=resource_type:desc`.
     # @option options [String] :type Type of tasks to search for.
-    # @return [Array<Task>] The list of Tasks for the first page, unless otherwise specified. 
+    # @return [Array<Task>] The list of Tasks for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/tasks", options)
 
       root[:items].map{ |item| Task.new(item[:data]) }
     end
-    
+
 
     # Create a task
-    # 
+    #
     # post '/tasks'
     #
     # Creates a new task
@@ -58,8 +58,8 @@ module BaseCRM
     # * [Contacts](/docs/rest/reference/contacts)
     # * [Deals](/docs/rest/reference/deals)
     #
-    # @param task [Task, Hash] Either object of the Task type or Hash. This object's attributes describe the object to be created. 
-    # @return [Task] The resulting object represting created resource. 
+    # @param task [Task, Hash] Either object of the Task type or Hash. This object's attributes describe the object to be created.
+    # @return [Task] The resulting object represting created resource.
     def create(task)
       validate_type!(task)
 
@@ -68,33 +68,33 @@ module BaseCRM
 
       Task.new(root[:data])
     end
-    
+
 
     # Retrieve a single task
-    # 
+    #
     # get '/tasks/{id}'
     #
     # Returns a single task available to the user according to the unique task ID provided
     # If the specified task does not exist, this query will return an error
     #
     # @param id [Integer] Unique identifier of a Task
-    # @return [Task] Searched resource object. 
+    # @return [Task] Searched resource object.
     def find(id)
       _, _, root = @client.get("/tasks/#{id}")
 
       Task.new(root[:data])
     end
-    
+
 
     # Update a task
-    # 
+    #
     # put '/tasks/{id}'
     #
     # Updates task information
     # If the specified task does not exist, this query will return an error
     #
-    # @param task [Task, Hash] Either object of the Task type or Hash. This object's attributes describe the object to be updated. 
-    # @return [Task] The resulting object represting updated resource. 
+    # @param task [Task, Hash] Either object of the Task type or Hash. This object's attributes describe the object to be updated.
+    # @return [Task] The resulting object represting updated resource.
     def update(task)
       validate_type!(task)
       params = extract_params!(task, :id)
@@ -105,10 +105,10 @@ module BaseCRM
 
       Task.new(root[:data])
     end
-    
+
 
     # Delete a task
-    # 
+    #
     # delete '/tasks/{id}'
     #
     # Delete an existing task
@@ -121,7 +121,7 @@ module BaseCRM
       status, _, _ = @client.delete("/tasks/#{id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(task)
@@ -133,7 +133,7 @@ module BaseCRM
       raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
       params
     end
-       
+
     def sanitize(task)
       task.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
     end

data/lib/basecrm/services/users_service.rb

@@ -7,17 +7,17 @@ module BaseCRM
     end
 
     # Retrieve all users
-    # 
+    #
     # get '/users'
     #
     # If you want to use filtering or sorting (see #where).
-    # @return [Enumerable] Paginated resource you can use to iterate over all the resources. 
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources.
     def all
       PaginatedResource.new(self)
     end
 
     # Retrieve all users
-    # 
+    #
     # get '/users'
     #
     # Returns all users, according to the parameters provided
@@ -32,37 +32,37 @@ module BaseCRM
     # @option options [String] :role Role of user to search for.
     # @option options [String] :sort_by (id:asc) A field to sort by. The **default** order is **ascending**. If you want to change the sort order to descending, append `:desc` to the field e.g. `sort_by=name:desc`.
     # @option options [String] :status Status of user accounts to search for.
-    # @return [Array<User>] The list of Users for the first page, unless otherwise specified. 
+    # @return [Array<User>] The list of Users for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/users", options)
 
       root[:items].map{ |item| User.new(item[:data]) }
     end
-    
+
 
     # Retrieve a single user
-    # 
+    #
     # get '/users/{id}'
     #
     # Returns a single user according to the unique user ID provided
     # If the specified user does not exist, this query returns an error
     #
     # @param id [Integer] Unique identifier of a User
-    # @return [User] Searched resource object. 
+    # @return [User] Searched resource object.
     def find(id)
       _, _, root = @client.get("/users/#{id}")
 
       User.new(root[:data])
     end
-    
-  
+
+
     # Retrieve an authenticating user
-    # 
+    #
     # get '/users/self'
     #
     # Returns a single authenticating user, according to the authentication credentials provided
     #
-    # @return [User] Resource object. 
+    # @return [User] Resource object.
     def self
       _, _, root = @client.get("/users/self")
       User.new(root[:data])