basecrm 1.2.3 → 1.3.0

data/lib/basecrm/services/deals_service.rb

@@ -2,24 +2,24 @@
 
 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, :last_stage_change_at]
+    OPTS_KEYS_TO_PERSIST = Set[:contact_id, :currency, :custom_fields, :hot, :loss_reason_id, :name, :owner_id, :source_id, :stage_id, :tags, :value, :last_stage_change_at, :estimated_close_date, :customized_win_likelihood]
 
     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. 
+    # @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
@@ -36,22 +36,23 @@ module BaseCRM
     # @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. 
+    # @option options [String] :estimated_close_date of the deal.
+    # @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. 
+    # @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)
 
@@ -60,26 +61,26 @@ module BaseCRM
 
       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. 
+    # @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
@@ -89,8 +90,8 @@ module BaseCRM
     # `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. 
+    # @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)
@@ -101,10 +102,10 @@ module BaseCRM
 
       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
@@ -117,7 +118,7 @@ module BaseCRM
       status, _, _ = @client.delete("/deals/#{id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(deal)
@@ -129,7 +130,7 @@ module BaseCRM
       raise ArgumentError, "one of required attributes is missing. Expected: #{args.join(',')}" if params.count != args.length
       params
     end
-       
+
     def sanitize(deal)
       deal_hash = deal.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
       deal_hash[:value] = Coercion.to_string(deal_hash[:value])

data/lib/basecrm/services/lead_sources_service.rb

@@ -0,0 +1,133 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class LeadSourcesService
+    OPTS_KEYS_TO_PERSIST = Set[:name, :resource_type]
+
+    def initialize(client)
+      @client = client
+    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. 
+    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
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :ids Comma-separated list of lead 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<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
+    # <figure class="notice">
+    # 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. 
+    def create(lead_source)
+      validate_type!(lead_source)
+
+      attributes = sanitize(lead_source)
+      _, _, root = @client.post("/lead_sources", attributes)
+
+      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. 
+    def find(id)
+      _, _, root = @client.get("/lead_sources/#{id}")
+
+      LeadSource.new(root[:data])
+    end
+    
+
+    # Update a source
+    # 
+    # put '/lead_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 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)
+      id = params[:id]
+
+      attributes = sanitize(lead_source)
+      _, _, root = @client.put("/lead_sources/#{id}", attributes)
+
+      LeadSource.new(root[:data])
+    end
+    
+
+    # Delete a source
+    # 
+    # delete '/lead_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 LeadSource
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/lead_sources/#{id}")
+      status == 204
+    end
+    
+
+  private
+    def validate_type!(lead_source)
+      raise TypeError unless lead_source.is_a?(LeadSource) || lead_source.is_a?(Hash)
+    end
+
+    def extract_params!(lead_source, *args)
+      params = lead_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(lead_source)
+      lead_source.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/services/line_items_service.rb

@@ -0,0 +1,111 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class LineItemsService
+    OPTS_KEYS_TO_PERSIST = Set[:product_id, :value, :variation, :currency, :quantity]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve order's line items
+    #
+    # get '/orders/{order_id}/line_items'
+    #
+    # 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(order_id)
+      PaginatedResource.new(self, order_id)
+    end
+
+    # Retrieve order's line items
+    #
+    # get '/orders/{order_id}/line_items'
+    #
+    # Returns all line items associated to order
+    #
+    # @param order_id [Integer] Unique identifier of a Order
+    # @param options [Hash] Search options
+    # @option options [String] :ids Comma-separated list of line item IDs to be returned in a request.
+    # @option options [Integer] :quantity Quantity of line item.
+    # @option options [Integer] :value Value of line item.
+    # @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`.
+    # @return [Array<LineItem>] The list of LineItems for the first page, unless otherwise specified.
+    def where(order_id, options = {})
+      _, _, root = @client.get("/orders/#{order_id}/line_items", options)
+
+      root[:items].map{ |item| LineItem.new(item[:data]) }
+    end
+
+
+    # Create a line item
+    #
+    # post '/orders/{order_id}/line_items'
+    #
+    # Adds a new line item to an existing order
+    # Line items correspond to products in the catalog, so first you must create products
+    # Because products allow defining different prices in different currencies, when creating a line item, the parameter currency is required
+    #
+    # @param order_id [Integer] Unique identifier of a Order
+    # @param line_item [LineItem, Hash] Either object of the LineItem type or Hash. This object's attributes describe the object to be created.
+    # @return [LineItem] The resulting object represting created resource.
+    def create(order_id, line_item)
+      validate_type!(line_item)
+
+      attributes = sanitize(line_item)
+      _, _, root = @client.post("/orders/#{order_id}/line_items", attributes)
+
+      LineItem.new(root[:data])
+    end
+
+
+    # Retrieve a single line item
+    #
+    # get '/orders/{order_id}/line_items/{id}'
+    #
+    # Returns a single line item of an order, according to the unique line item ID provided
+    #
+    # @param order_id [Integer] Unique identifier of a Order
+    # @param id [Integer] Unique identifier of a LineItem
+    # @return [LineItem] Searched resource object.
+    def find(order_id, id)
+      _, _, root = @client.get("/orders/#{order_id}/line_items/#{id}")
+
+      LineItem.new(root[:data])
+    end
+
+
+    # Delete a line item
+    #
+    # delete '/orders/{order_id}/line_items/{id}'
+    #
+    # Remove an order’s line item
+    # This operation cannot be undone
+    #
+    # @param order_id [Integer] Unique identifier of a Order
+    # @param id [Integer] Unique identifier of a LineItem
+    # @return [Boolean] Status of the operation.
+    def destroy(order_id, id)
+      status, _, _ = @client.delete("/orders/#{order_id}/line_items/#{id}")
+      status == 204
+    end
+
+
+  private
+    def validate_type!(line_item)
+      raise TypeError unless line_item.is_a?(LineItem) || line_item.is_a?(Hash)
+    end
+
+    def extract_params!(line_item, *args)
+      params = line_item.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(line_item)
+      line_item.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/services/orders_service.rb

@@ -0,0 +1,129 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class OrdersService
+    OPTS_KEYS_TO_PERSIST = Set[:deal_id, :discount]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all orders
+    #
+    # get '/orders'
+    #
+    # 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 orders
+    #
+    # get '/orders'
+    #
+    # Returns all orders available to the user according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :ids Comma-separated list of order IDs to be returned in a request.
+    # @option options [Integer] :deal_id ID of the deal order is associated to.
+    # @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`.
+    # @return [Array<Order>] The list of Orders for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/orders", options)
+
+      root[:items].map{ |item| Order.new(item[:data]) }
+    end
+
+
+    # Create an order
+    #
+    # post '/orders'
+    #
+    # Create a new order for a deal
+    # User needs to have access to the deal to create an order
+    # Each deal can have at most one order and error is returned when attempting to create more
+    #
+    # @param order [Order, Hash] Either object of the Order type or Hash. This object's attributes describe the object to be created.
+    # @return [Order] The resulting object represting created resource.
+    def create(order)
+      validate_type!(order)
+
+      attributes = sanitize(order)
+      _, _, root = @client.post("/orders", attributes)
+
+      Order.new(root[:data])
+    end
+
+
+    # Retrieve a single order
+    #
+    # get '/orders/{id}'
+    #
+    # Returns a single order available to the user, according to the unique order ID provided
+    # If the specified order does not exist, the request will return an error
+    #
+    # @param id [Integer] Unique identifier of a Order
+    # @return [Order] Searched resource object.
+    def find(id)
+      _, _, root = @client.get("/orders/#{id}")
+
+      Order.new(root[:data])
+    end
+
+
+    # Update an order
+    #
+    # put '/orders/{id}'
+    #
+    # Updates order information
+    # If the specified order does not exist, the request will return an error
+    #
+    # @param order [Order, Hash] Either object of the Order type or Hash. This object's attributes describe the object to be updated.
+    # @return [Order] The resulting object represting updated resource.
+    def update(order)
+      validate_type!(order)
+      params = extract_params!(order, :id)
+      id = params[:id]
+
+      attributes = sanitize(order)
+      _, _, root = @client.put("/orders/#{id}", attributes)
+
+      Order.new(root[:data])
+    end
+
+
+    # Delete an order
+    #
+    # delete '/orders/{id}'
+    #
+    # Delete an existing order and remove all of the associated line items in a single call
+    # If the specified order does not exist, the request will return an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a Order
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/orders/#{id}")
+      status == 204
+    end
+
+
+  private
+    def validate_type!(order)
+      raise TypeError unless order.is_a?(Order) || order.is_a?(Hash)
+    end
+
+    def extract_params!(order, *args)
+      params = order.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(order)
+      order.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end