basecrm 0.1.2 → 1.0.0

data/lib/basecrm/services/loss_reasons_service.rb

@@ -0,0 +1,133 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class LossReasonsService
+    OPTS_KEYS_TO_PERSIST = Set[:name]
+
+    def initialize(client)
+      @client = client
+    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. 
+    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
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :ids Comma separated list of deal loss reasons unique identifiers to be returned in a request.
+    # @option options [String] :name Name of the loss reason to search for. This parameter is used in a strict sense.
+    # @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. 
+    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
+    # <figure class="notice">
+    # 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. 
+    def create(loss_reason)
+      validate_type!(loss_reason)
+
+      attributes = sanitize(loss_reason)
+      _, _, root = @client.post("/loss_reasons", attributes)
+
+      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. 
+    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
+    # If the specified loss reason does not exist, the request will return an error
+    # <figure class="notice">
+    # 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. 
+    def update(loss_reason)
+      validate_type!(loss_reason)
+      params = extract_params!(loss_reason, :id)
+      id = params[:id]
+
+      attributes = sanitize(loss_reason)
+      _, _, root = @client.put("/loss_reasons/#{id}", attributes)
+
+      LossReason.new(root[:data])
+    end
+    
+
+    # Delete a reason
+    # 
+    # delete '/loss_reasons/{id}'
+    #
+    # Delete an existing loss reason
+    # If the reason with supplied unique identifier does not exist it returns an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a LossReason
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/loss_reasons/#{id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(loss_reason)
+      raise TypeError unless loss_reason.is_a?(LossReason) || loss_reason.is_a?(Hash)
+    end
+
+    def extract_params!(loss_reason, *args)
+      params = loss_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
+       
+    def sanitize(loss_reason)
+      loss_reason.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/services/notes_service.rb

@@ -0,0 +1,134 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class NotesService
+    OPTS_KEYS_TO_PERSIST = Set[:content, :resource_id, :resource_type]
+
+    def initialize(client)
+      @client = client
+    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. 
+    def all
+      PaginatedResource.new(self)
+    end
+
+    # Retrieve all notes
+    # 
+    # get '/notes'
+    #
+    # Returns all notes available to the user, according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [Integer] :creator_id Unique identifier of the user. Returns all notes created by the user.
+    # @option options [String] :ids Comma-separated list of note IDs to be returned in a request.
+    # @option options [String] :includes Comma-separated list of one or more resources related to the note. **Not supported at the moment**.
+    # @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 at one time is *100*.
+    # @option options [String] :q A query string to search for. Performs a full text search on the `content` field.
+    # @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. 
+    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:
+    # * [Leads](/docs/rest/reference/leads)
+    # * [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. 
+    def create(note)
+      validate_type!(note)
+
+      attributes = sanitize(note)
+      _, _, root = @client.post("/notes", attributes)
+
+      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. 
+    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. 
+    def update(note)
+      validate_type!(note)
+      params = extract_params!(note, :id)
+      id = params[:id]
+
+      attributes = sanitize(note)
+      _, _, root = @client.put("/notes/#{id}", attributes)
+
+      Note.new(root[:data])
+    end
+    
+
+    # Delete a note
+    # 
+    # delete '/notes/{id}'
+    #
+    # Delete an existing note
+    # If the note ID does not exist, this request will return an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a Note
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/notes/#{id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(note)
+      raise TypeError unless note.is_a?(Note) || note.is_a?(Hash)
+    end
+
+    def extract_params!(note, *args)
+      params = note.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(note)
+      note.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/services/pipelines_service.rb

@@ -0,0 +1,50 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class PipelinesService
+    def initialize(client)
+      @client = client
+    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. 
+    def all
+      PaginatedResource.new(self)
+    end
+
+    # Retrieve all pipelines
+    # 
+    # get '/pipelines'
+    #
+    # Returns all pipelines available to the user, according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :ids Comma-separated list of pipeline IDs to be returned in a request.
+    # @option options [String] :name Name of the pipeline to search for. This parameter is used in a strict sense. Unsupported for now.
+    # @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. 
+    def where(options = {})
+      _, _, root = @client.get("/pipelines", options)
+
+      root[:items].map{ |item| Pipeline.new(item[:data]) }
+    end
+    
+
+  private
+    def validate_type!(pipeline)
+      raise TypeError unless pipeline.is_a?(Pipeline) || pipeline.is_a?(Hash)
+    end
+
+    def extract_params!(pipeline, *args)
+      params = pipeline.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/sources_service.rb

@@ -0,0 +1,133 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class SourcesService
+    OPTS_KEYS_TO_PERSIST = Set[:name]
+
+    def initialize(client)
+      @client = client
+    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. 
+    def all
+      PaginatedResource.new(self)
+    end
+
+    # Retrieve all sources
+    # 
+    # get '/sources'
+    #
+    # Returns all deal sources available to the user according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :ids Comma-separated list of deal source IDs to be returned in a request.
+    # @option options [String] :name Name of the source to search for. This parameter is used in a strict sense.
+    # @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. 
+    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
+    # <figure class="notice">
+    # 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. 
+    def create(source)
+      validate_type!(source)
+
+      attributes = sanitize(source)
+      _, _, root = @client.post("/sources", attributes)
+
+      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. 
+    def find(id)
+      _, _, root = @client.get("/sources/#{id}")
+
+      Source.new(root[:data])
+    end
+    
+
+    # Update a source
+    # 
+    # put '/sources/{id}'
+    #
+    # Updates source information
+    # If the specified source does not exist, the request will return an error
+    # <figure class="notice">
+    # 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. 
+    def update(source)
+      validate_type!(source)
+      params = extract_params!(source, :id)
+      id = params[:id]
+
+      attributes = sanitize(source)
+      _, _, root = @client.put("/sources/#{id}", attributes)
+
+      Source.new(root[:data])
+    end
+    
+
+    # Delete a source
+    # 
+    # delete '/sources/{id}'
+    #
+    # Delete an existing source
+    # If the specified source does not exist, the request will return an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a Source
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/sources/#{id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(source)
+      raise TypeError unless source.is_a?(Source) || source.is_a?(Hash)
+    end
+
+    def extract_params!(source, *args)
+      params = source.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(source)
+      source.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end