basecrm 1.3.2 → 1.3.3

data/lib/basecrm/services/lead_sources_service.rb

@@ -9,17 +9,17 @@ module BaseCRM
     end
 
     # Retrieve all sources
-    # 
+    #
     # get '/lead_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 '/lead_sources'
     #
     # Returns all lead 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<LeadSource>] The list of LeadSources for the first page, unless otherwise specified. 
+    # @return [Array<LeadSource>] The list of LeadSources for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/lead_sources", options)
 
       root[:items].map{ |item| LeadSource.new(item[:data]) }
     end
-    
+
 
     # Create a new source
-    # 
+    #
     # post '/lead_sources'
     #
     # Creates a new source
@@ -47,8 +47,8 @@ module BaseCRM
     # Source's name **must** be unique
     # </figure>
     #
-    # @param lead_source [LeadSource, Hash] Either object of the LeadSource type or Hash. This object's attributes describe the object to be created. 
-    # @return [LeadSource] The resulting object represting created resource. 
+    # @param lead_source [LeadSource, Hash] Either object of the LeadSource type or Hash. This object's attributes describe the object to be created.
+    # @return [LeadSource] The resulting object represting created resource.
     def create(lead_source)
       validate_type!(lead_source)
 
@@ -57,26 +57,26 @@ module BaseCRM
 
       LeadSource.new(root[:data])
     end
-    
+
 
     # Retrieve a single source
-    # 
+    #
     # get '/lead_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 LeadSource
-    # @return [LeadSource] Searched resource object. 
+    # @return [LeadSource] Searched resource object.
     def find(id)
       _, _, root = @client.get("/lead_sources/#{id}")
 
       LeadSource.new(root[:data])
     end
-    
+
 
     # Update a source
-    # 
+    #
     # put '/lead_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 lead_source [LeadSource, Hash] Either object of the LeadSource type or Hash. This object's attributes describe the object to be updated. 
-    # @return [LeadSource] The resulting object represting updated resource. 
+    # @param lead_source [LeadSource, Hash] Either object of the LeadSource type or Hash. This object's attributes describe the object to be updated.
+    # @return [LeadSource] The resulting object represting updated resource.
     def update(lead_source)
       validate_type!(lead_source)
       params = extract_params!(lead_source, :id)
@@ -97,10 +97,10 @@ module BaseCRM
 
       LeadSource.new(root[:data])
     end
-    
+
 
     # Delete a source
-    # 
+    #
     # delete '/lead_sources/{id}'
     #
     # Delete an existing source
@@ -113,7 +113,7 @@ module BaseCRM
       status, _, _ = @client.delete("/lead_sources/#{id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(lead_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(lead_source)
       lead_source.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
     end

data/lib/basecrm/services/lead_unqualified_reasons_service.rb

@@ -0,0 +1,45 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class LeadUnqualifiedReasonsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all lead unqualified reasons
+    #
+    # get '/lead_unqualified_reasons'
+    #
+    # If you want to use filtering or sorting (see #where).
+    # @return [Enumerable] Paginated resource you can use to iterate over all the resources.
+    def all
+      PaginatedResource.new(self)
+    end
+
+    # Retrieve all lead unqualified reasons
+    #
+    # get '/lead_unqualified_reasons'
+    #
+    # Returns all lead unqualified reasons available to the user according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @return [Array<LeadUnqualifiedReason>] The list of LeadUnqualifiedReasons for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/lead_unqualified_reasons", options)
+
+      root[:items].map{ |item| LeadUnqualifiedReason.new(item[:data]) }
+    end
+
+
+  private
+    def validate_type!(lead_unqualified_reason)
+      raise TypeError unless lead_unqualified_reason.is_a?(LeadUnqualifiedReason) || lead_unqualified_reason.is_a?(Hash)
+    end
+
+    def extract_params!(lead_unqualified_reason, *args)
+      params = lead_unqualified_reason.to_h.select{ |k, _| args.include?(k) }
+      raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
+      params
+    end
+  end
+end

data/lib/basecrm/services/leads_service.rb

@@ -9,17 +9,17 @@ module BaseCRM
     end
 
     # Retrieve all leads
-    # 
+    #
     # get '/leads'
     #
     # 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 leads
-    # 
+    #
     # get '/leads'
     #
     # Returns all leads available to the user, according to the parameters provided
@@ -39,23 +39,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] :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=last_name:desc`.
     # @option options [String] :status Status of the lead.
-    # @return [Array<Lead>] The list of Leads for the first page, unless otherwise specified. 
+    # @return [Array<Lead>] The list of Leads for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/leads", options)
 
       root[:items].map{ |item| Lead.new(item[:data]) }
     end
-    
+
 
     # Create a lead
-    # 
+    #
     # post '/leads'
     #
     # Creates a new lead
     # A lead may represent a single individual or an organization
     #
-    # @param lead [Lead, Hash] Either object of the Lead type or Hash. This object's attributes describe the object to be created. 
-    # @return [Lead] The resulting object represting created resource. 
+    # @param lead [Lead, Hash] Either object of the Lead type or Hash. This object's attributes describe the object to be created.
+    # @return [Lead] The resulting object represting created resource.
     def create(lead)
       validate_type!(lead)
 
@@ -64,26 +64,26 @@ module BaseCRM
 
       Lead.new(root[:data])
     end
-    
+
 
     # Retrieve a single lead
-    # 
+    #
     # get '/leads/{id}'
     #
     # Returns a single lead available to the user, according to the unique lead ID provided
     # If the specified lead does not exist, this query returns an error
     #
     # @param id [Integer] Unique identifier of a Lead
-    # @return [Lead] Searched resource object. 
+    # @return [Lead] Searched resource object.
     def find(id)
       _, _, root = @client.get("/leads/#{id}")
 
       Lead.new(root[:data])
     end
-    
+
 
     # Update a lead
-    # 
+    #
     # put '/leads/{id}'
     #
     # Updates lead information
@@ -93,8 +93,8 @@ module BaseCRM
     # `tags` are replaced every time they are used in a request
     # </figure>
     #
-    # @param lead [Lead, Hash] Either object of the Lead type or Hash. This object's attributes describe the object to be updated. 
-    # @return [Lead] The resulting object represting updated resource. 
+    # @param lead [Lead, Hash] Either object of the Lead type or Hash. This object's attributes describe the object to be updated.
+    # @return [Lead] The resulting object represting updated resource.
     def update(lead)
       validate_type!(lead)
       params = extract_params!(lead, :id)
@@ -105,10 +105,10 @@ module BaseCRM
 
       Lead.new(root[:data])
     end
-    
+
 
     # Delete a lead
-    # 
+    #
     # delete '/leads/{id}'
     #
     # Delete an existing lead
@@ -121,7 +121,7 @@ module BaseCRM
       status, _, _ = @client.delete("/leads/#{id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(lead)
@@ -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(lead)
       lead.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
     end

data/lib/basecrm/services/loss_reasons_service.rb

@@ -9,17 +9,17 @@ module BaseCRM
     end
 
     # Retrieve all reasons
-    # 
+    #
     # get '/loss_reasons'
     #
     # 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 reasons
-    # 
+    #
     # get '/loss_reasons'
     #
     # Returns all deal loss reasons 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 is 1-based and omitting `page` parameter will return the first page.
     # @option options [Integer] :per_page (25) Number of records to return per page. Default limit is *25* and maximum number that can be returned is *100*.
     # @option options [String] :sort_by (id:asc) A field to sort by. **Default** ordering is **ascending**. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=name:desc`.
-    # @return [Array<LossReason>] The list of LossReasons for the first page, unless otherwise specified. 
+    # @return [Array<LossReason>] The list of LossReasons for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/loss_reasons", options)
 
       root[:items].map{ |item| LossReason.new(item[:data]) }
     end
-    
+
 
     # Create a loss reason
-    # 
+    #
     # post '/loss_reasons'
     #
     # Create a new loss reason
@@ -47,8 +47,8 @@ module BaseCRM
     # Loss reason's name **must** be unique
     # </figure>
     #
-    # @param loss_reason [LossReason, Hash] Either object of the LossReason type or Hash. This object's attributes describe the object to be created. 
-    # @return [LossReason] The resulting object represting created resource. 
+    # @param loss_reason [LossReason, Hash] Either object of the LossReason type or Hash. This object's attributes describe the object to be created.
+    # @return [LossReason] The resulting object represting created resource.
     def create(loss_reason)
       validate_type!(loss_reason)
 
@@ -57,26 +57,26 @@ module BaseCRM
 
       LossReason.new(root[:data])
     end
-    
+
 
     # Retrieve a single reason
-    # 
+    #
     # get '/loss_reasons/{id}'
     #
     # Returns a single loss reason available to the user by the provided id
     # If a loss reason with the supplied unique identifier does not exist, it returns an error
     #
     # @param id [Integer] Unique identifier of a LossReason
-    # @return [LossReason] Searched resource object. 
+    # @return [LossReason] Searched resource object.
     def find(id)
       _, _, root = @client.get("/loss_reasons/#{id}")
 
       LossReason.new(root[:data])
     end
-    
+
 
     # Update a loss reason
-    # 
+    #
     # put '/loss_reasons/{id}'
     #
     # Updates a loss reason information
@@ -85,8 +85,8 @@ module BaseCRM
     # If you want to update loss reason you **must** make sure name of the reason is unique
     # </figure>
     #
-    # @param loss_reason [LossReason, Hash] Either object of the LossReason type or Hash. This object's attributes describe the object to be updated. 
-    # @return [LossReason] The resulting object represting updated resource. 
+    # @param loss_reason [LossReason, Hash] Either object of the LossReason type or Hash. This object's attributes describe the object to be updated.
+    # @return [LossReason] The resulting object represting updated resource.
     def update(loss_reason)
       validate_type!(loss_reason)
       params = extract_params!(loss_reason, :id)
@@ -97,10 +97,10 @@ module BaseCRM
 
       LossReason.new(root[:data])
     end
-    
+
 
     # Delete a reason
-    # 
+    #
     # delete '/loss_reasons/{id}'
     #
     # Delete an existing loss reason
@@ -113,7 +113,7 @@ module BaseCRM
       status, _, _ = @client.delete("/loss_reasons/#{id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(loss_reason)
@@ -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(loss_reason)
       loss_reason.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
     end

data/lib/basecrm/services/notes_service.rb

@@ -9,17 +9,17 @@ module BaseCRM
     end
 
     # Retrieve all notes
-    # 
+    #
     # get '/notes'
     #
     # 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 notes
-    # 
+    #
     # get '/notes'
     #
     # Returns all notes available to the user, according to the parameters provided
@@ -34,16 +34,16 @@ module BaseCRM
     # @option options [Integer] :resource_id Unique identifier of the resource to search for.
     # @option options [String] :resource_type Name of the type of resource to search for.
     # @option options [String] :sort_by (updated_at:asc) A field to sort by. **Default** ordering is **ascending**. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=resource_type:desc`.
-    # @return [Array<Note>] The list of Notes for the first page, unless otherwise specified. 
+    # @return [Array<Note>] The list of Notes for the first page, unless otherwise specified.
     def where(options = {})
       _, _, root = @client.get("/notes", options)
 
       root[:items].map{ |item| Note.new(item[:data]) }
     end
-    
+
 
     # Create a note
-    # 
+    #
     # post '/notes'
     #
     # Create a new note and associate it with one of the resources listed below:
@@ -51,8 +51,8 @@ module BaseCRM
     # * [Contacts](/docs/rest/reference/contacts)
     # * [Deals](/docs/rest/reference/deals)
     #
-    # @param note [Note, Hash] Either object of the Note type or Hash. This object's attributes describe the object to be created. 
-    # @return [Note] The resulting object represting created resource. 
+    # @param note [Note, Hash] Either object of the Note type or Hash. This object's attributes describe the object to be created.
+    # @return [Note] The resulting object represting created resource.
     def create(note)
       validate_type!(note)
 
@@ -61,33 +61,33 @@ module BaseCRM
 
       Note.new(root[:data])
     end
-    
+
 
     # Retrieve a single note
-    # 
+    #
     # get '/notes/{id}'
     #
     # Returns a single note available to the user, according to the unique note ID provided
     # If the note ID does not exist, this request will return an error
     #
     # @param id [Integer] Unique identifier of a Note
-    # @return [Note] Searched resource object. 
+    # @return [Note] Searched resource object.
     def find(id)
       _, _, root = @client.get("/notes/#{id}")
 
       Note.new(root[:data])
     end
-    
+
 
     # Update a note
-    # 
+    #
     # put '/notes/{id}'
     #
     # Updates note information
     # If the note ID does not exist, this request will return an error
     #
-    # @param note [Note, Hash] Either object of the Note type or Hash. This object's attributes describe the object to be updated. 
-    # @return [Note] The resulting object represting updated resource. 
+    # @param note [Note, Hash] Either object of the Note type or Hash. This object's attributes describe the object to be updated.
+    # @return [Note] The resulting object represting updated resource.
     def update(note)
       validate_type!(note)
       params = extract_params!(note, :id)
@@ -98,10 +98,10 @@ module BaseCRM
 
       Note.new(root[:data])
     end
-    
+
 
     # Delete a note
-    # 
+    #
     # delete '/notes/{id}'
     #
     # Delete an existing note
@@ -114,7 +114,7 @@ module BaseCRM
       status, _, _ = @client.delete("/notes/#{id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(note)
@@ -126,7 +126,7 @@ module BaseCRM
       raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
       params
     end
-       
+
     def sanitize(note)
       note.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
     end