basecrm 0.1.2 → 1.0.0

data/lib/basecrm/services/associated_contacts_service.rb

@@ -0,0 +1,91 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class AssociatedContactsService
+    OPTS_KEYS_TO_PERSIST = Set[:contact_id, :role]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve deal's associated contacts
+    # 
+    # get '/deals/{deal_id}/associated_contacts'
+    #
+    # 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(deal_id)
+      PaginatedResource.new(self, deal_id)
+    end
+
+    # Retrieve deal's associated contacts
+    # 
+    # get '/deals/{deal_id}/associated_contacts'
+    #
+    # Returns all deal associated contacts
+    #
+    # @param deal_id [Integer] Unique identifier of a Deal
+    # @param options [Hash] Search options
+    # @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. Default limit is *25* and the maximum number that can be returned is *100*.
+    # @return [Array<AssociatedContact>] The list of AssociatedContacts for the first page, unless otherwise specified. 
+    def where(deal_id, options = {})
+      _, _, root = @client.get("/deals/#{deal_id}/associated_contacts", options)
+
+      root[:items].map{ |item| AssociatedContact.new(item[:data]) }
+    end
+    
+
+    # Create an associated contact
+    # 
+    # post '/deals/{deal_id}/associated_contacts'
+    #
+    # Creates a deal's associated contact and its role
+    # If the specified deal or contact does not exist, the request will return an error
+    #
+    # @param deal_id [Integer] Unique identifier of a Deal
+    # @param associated_contact [AssociatedContact, Hash] Either object of the AssociatedContact type or Hash. This object's attributes describe the object to be created. 
+    # @return [AssociatedContact] The resulting object represting created resource. 
+    def create(deal_id, associated_contact)
+      validate_type!(associated_contact)
+
+      attributes = sanitize(associated_contact)
+      _, _, root = @client.post("/deals/#{deal_id}/associated_contacts", attributes)
+
+      AssociatedContact.new(root[:data])
+    end
+    
+
+    # Remove an associated contact
+    # 
+    # delete '/deals/{deal_id}/associated_contacts/{contact_id}'
+    #
+    # Remove a deal's associated contact
+    # If a deal with the supplied unique identifier does not exist, it returns an error
+    # This operation cannot be undone
+    #
+    # @param deal_id [Integer] Unique identifier of a Deal
+    # @param contact_id [Integer] Unique identifier of a Contact
+    # @return [Boolean] Status of the operation.
+    def destroy(deal_id, contact_id)
+      status, _, _ = @client.delete("/deals/#{deal_id}/associated_contacts/#{contact_id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(associated_contact)
+      raise TypeError unless associated_contact.is_a?(AssociatedContact) || associated_contact.is_a?(Hash)
+    end
+
+    def extract_params!(associated_contact, *args)
+      params = associated_contact.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
+       
+    def sanitize(associated_contact)
+      associated_contact.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/services/contacts_service.rb

@@ -0,0 +1,138 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class ContactsService
+    OPTS_KEYS_TO_PERSIST = Set[:address, :contact_id, :custom_fields, :customer_status, :description, :email, :facebook, :fax, :first_name, :industry, :is_organization, :last_name, :linkedin, :mobile, :name, :owner_id, :phone, :prospect_status, :skype, :tags, :title, :twitter, :website]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all contacts
+    # 
+    # get '/contacts'
+    #
+    # 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 contacts
+    # 
+    # get '/contacts'
+    #
+    # Returns all contacts available to the user according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :"address[city]" City name.
+    # @option options [String] :"address[country]" Country name.
+    # @option options [String] :"address[postal_code]" Zip code or equivalent
+    # @option options [Integer] :contact_id The unique identifier of the organization that the contact belongs to.
+    # @option options [String] :email Email address of the contact.
+    # @option options [String] :first_name First name of the contact.
+    # @option options [String] :ids Comma-separated list of the IDs for the contacts you want to be returned in your request.
+    # @option options [Boolean] :is_organization Indicates whether or not this contact refers to an organization or an individual.
+    # @option options [String] :last_name Last name of the contact.
+    # @option options [String] :name Name of the contact.
+    # @option options [Integer] :page (1) The page number to start from. Page numbering is 1-based and omitting the `page` parameter will return the first page.
+    # @option options [Integer] :per_page (25) The 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 (last_name:asc) A field to sort by. **Default** ordering is **ascending**. If you want to change the sort order to descending, append `:desc` to the field e.g. `sort_by=last_name:desc`.
+    # @return [Array<Contact>] The list of Contacts for the first page, unless otherwise specified. 
+    def where(options = {})
+      _, _, root = @client.get("/contacts", options)
+
+      root[:items].map{ |item| Contact.new(item[:data]) }
+    end
+    
+
+    # Create a contact
+    # 
+    # post '/contacts'
+    #
+    # Create a new contact
+    # A contact may represent a single individual or an organization
+    #
+    # @param contact [Contact, Hash] Either object of the Contact type or Hash. This object's attributes describe the object to be created. 
+    # @return [Contact] The resulting object represting created resource. 
+    def create(contact)
+      validate_type!(contact)
+
+      attributes = sanitize(contact)
+      _, _, root = @client.post("/contacts", attributes)
+
+      Contact.new(root[:data])
+    end
+    
+
+    # Retrieve a single contact
+    # 
+    # get '/contacts/{id}'
+    #
+    # Returns a single contact available to the user, according to the unique contact ID provided
+    # If the specified contact does not exist, the request will return an error
+    #
+    # @param id [Integer] Unique identifier of a Contact
+    # @return [Contact] Searched resource object. 
+    def find(id)
+      _, _, root = @client.get("/contacts/#{id}")
+
+      Contact.new(root[:data])
+    end
+    
+
+    # Update a contact
+    # 
+    # put '/contacts/{id}'
+    #
+    # Updates contact information
+    # If the specified contact does not exist, the request will return an error
+    # **Notice** When updating contact tags, you need to provide all tags
+    # Any missing tag will be removed from a contact's tags
+    #
+    # @param contact [Contact, Hash] Either object of the Contact type or Hash. This object's attributes describe the object to be updated. 
+    # @return [Contact] The resulting object represting updated resource. 
+    def update(contact)
+      validate_type!(contact)
+      params = extract_params!(contact, :id)
+      id = params[:id]
+
+      attributes = sanitize(contact)
+      _, _, root = @client.put("/contacts/#{id}", attributes)
+
+      Contact.new(root[:data])
+    end
+    
+
+    # Delete a contact
+    # 
+    # delete '/contacts/{id}'
+    #
+    # Delete an existing contact
+    # If the specified contact does not exist, the request will return an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a Contact
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/contacts/#{id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(contact)
+      raise TypeError unless contact.is_a?(Contact) || contact.is_a?(Hash)
+    end
+
+    def extract_params!(contact, *args)
+      params = contact.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
+       
+    def sanitize(contact)
+      contact.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/services/deals_service.rb

@@ -0,0 +1,137 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class DealsService
+    OPTS_KEYS_TO_PERSIST = Set[:contact_id, :currency, :custom_fields, :hot, :loss_reason_id, :name, :owner_id, :source_id, :stage_id, :tags, :value]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all deals
+    # 
+    # get '/deals'
+    #
+    # 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 deals
+    # 
+    # get '/deals'
+    #
+    # Returns all deals available to the user according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [Integer] :contact_id Unique identifier of a primary contact.
+    # @option options [Integer] :creator_id Unique identifier of the user the deal was created by. Returns all deals created by the user.
+    # @option options [Boolean] :hot Indicator of whether or not the deal is hot.
+    # @option options [String] :ids Comma-separated list of deal IDs to be returned in a request.
+    # @option options [Integer] :organization_id Unique identifier of an organization.
+    # @option options [Integer] :owner_id Unique identifier of the user the deal is owned by. Returns all deals owned by the user.
+    # @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. 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. **Default** ordering is **ascending**. If you want to change the sort ordering to descending, append `:desc` to the field e.g. `sort_by=value:desc`.
+    # @option options [Integer] :source_id Id of the Source.
+    # @option options [Integer] :stage_id Id of the Stage.
+    # @return [Array<Deal>] The list of Deals for the first page, unless otherwise specified. 
+    def where(options = {})
+      _, _, root = @client.get("/deals", options)
+
+      root[:items].map{ |item| Deal.new(item[:data]) }
+    end
+    
+
+    # Create a deal
+    # 
+    # post '/deals'
+    #
+    # Create a new deal
+    #
+    # @param deal [Deal, Hash] Either object of the Deal type or Hash. This object's attributes describe the object to be created. 
+    # @return [Deal] The resulting object represting created resource. 
+    def create(deal)
+      validate_type!(deal)
+
+      attributes = sanitize(deal)
+      _, _, root = @client.post("/deals", attributes)
+
+      Deal.new(root[:data])
+    end
+    
+
+    # Retrieve a single deal
+    # 
+    # get '/deals/{id}'
+    #
+    # Returns a single deal available to the user, according to the unique deal ID provided
+    # If the specified deal does not exist, the request will return an error
+    #
+    # @param id [Integer] Unique identifier of a Deal
+    # @return [Deal] Searched resource object. 
+    def find(id)
+      _, _, root = @client.get("/deals/#{id}")
+
+      Deal.new(root[:data])
+    end
+    
+
+    # Update a deal
+    # 
+    # put '/deals/{id}'
+    #
+    # Updates deal information
+    # If the specified deal does not exist, the request will return an error
+    # <figure class="notice">
+    # In order to modify tags used on a record, you need to supply the entire set
+    # `tags` are replaced every time they are used in a request
+    # </figure>
+    #
+    # @param deal [Deal, Hash] Either object of the Deal type or Hash. This object's attributes describe the object to be updated. 
+    # @return [Deal] The resulting object represting updated resource. 
+    def update(deal)
+      validate_type!(deal)
+      params = extract_params!(deal, :id)
+      id = params[:id]
+
+      attributes = sanitize(deal)
+      _, _, root = @client.put("/deals/#{id}", attributes)
+
+      Deal.new(root[:data])
+    end
+    
+
+    # Delete a deal
+    # 
+    # delete '/deals/{id}'
+    #
+    # Delete an existing deal and remove all of the associated contacts from the deal in a single call
+    # If the specified deal does not exist, the request will return an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a Deal
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/deals/#{id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(deal)
+      raise TypeError unless deal.is_a?(Deal) || deal.is_a?(Hash)
+    end
+
+    def extract_params!(deal, *args)
+      params = deal.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
+       
+    def sanitize(deal)
+      deal.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/services/leads_service.rb

@@ -0,0 +1,140 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class LeadsService
+    OPTS_KEYS_TO_PERSIST = Set[:address, :custom_fields, :description, :email, :facebook, :fax, :first_name, :industry, :last_name, :linkedin, :mobile, :organization_name, :owner_id, :phone, :skype, :status, :tags, :title, :twitter, :website]
+
+    def initialize(client)
+      @client = client
+    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. 
+    def all
+      PaginatedResource.new(self)
+    end
+
+    # Retrieve all leads
+    # 
+    # get '/leads'
+    #
+    # Returns all leads available to the user, according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :"address[city]" City name.
+    # @option options [String] :"address[country]" Country name.
+    # @option options [String] :"address[postal_code]" Zip or Postal code
+    # @option options [Integer] :creator_id User ID. Returns all leads created by that user.
+    # @option options [String] :first_name First name of the lead.
+    # @option options [String] :ids Comma-separated list of lead IDs to be returned in a request.
+    # @option options [String] :last_name Last name of the lead.
+    # @option options [String] :organization_name Organization name of the lead.
+    # @option options [Integer] :owner_id User ID. Returns all leads owned by that user.
+    # @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 (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. 
+    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. 
+    def create(lead)
+      validate_type!(lead)
+
+      attributes = sanitize(lead)
+      _, _, root = @client.post("/leads", attributes)
+
+      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. 
+    def find(id)
+      _, _, root = @client.get("/leads/#{id}")
+
+      Lead.new(root[:data])
+    end
+    
+
+    # Update a lead
+    # 
+    # put '/leads/{id}'
+    #
+    # Updates lead information
+    # If the specified lead does not exist, this query returns an error
+    # <figure class="notice">
+    # In order to modify tags, you need to supply the entire set of tags
+    # `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. 
+    def update(lead)
+      validate_type!(lead)
+      params = extract_params!(lead, :id)
+      id = params[:id]
+
+      attributes = sanitize(lead)
+      _, _, root = @client.put("/leads/#{id}", attributes)
+
+      Lead.new(root[:data])
+    end
+    
+
+    # Delete a lead
+    # 
+    # delete '/leads/{id}'
+    #
+    # Delete an existing lead
+    # If the specified lead does not exist, this query returns an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a Lead
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/leads/#{id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(lead)
+      raise TypeError unless lead.is_a?(Lead) || lead.is_a?(Hash)
+    end
+
+    def extract_params!(lead, *args)
+      params = lead.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
+       
+    def sanitize(lead)
+      lead.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end