basecrm 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0b22919c8d438aa9b4da0f1aaa32c2036b44940
-  data.tar.gz: e40c299088f7f4571d2603bfc493615e4d30ea7d
+  metadata.gz: b8926293016d60459867e6e9ebf95d981b4c05b1
+  data.tar.gz: b1893e2462cd97f6133945ac6ee2bea1586317b6
 SHA512:
-  metadata.gz: c96aa403415298f79e1ddd8fe519ef42be3fe1aec5c6ed8d464b7293ba778b5ee9388ca60e249a315dc860685afca21a13545f8cb65042abb5abb7b0912eb6f2
-  data.tar.gz: 32d7764d318c2bffcd01efa4496b8a290ced851b1c9cd793e3893ba8ee91c6cb11418dca824801f8ddaade87899f2b3ebc260aacc6c8bd8b9ea62c8f69d18067
+  metadata.gz: 27725431587ba2b68687a559ad14efdcb7bd64d45232102e26708cbd967983c2d5612cf88f486db172071fdee1675f2a20f224185f05cf58ac53e0b76f157b5f
+  data.tar.gz: e86129dcf65d434cfecbd98a664e36e9125d84356efc2b8ebbfe979fe2256dfc832ef9455d8dfbc59d33fcd7348783e3253a62c43b420747597e3760a3dc1178

data/README.md

@@ -216,6 +216,20 @@ You should not be using floats as it may result in precision loss.
 deal.value = 1000.98
 ```
 
+### DealSource
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.deal_sources # => BaseCRM::DealSourcesService
+```
+
+Actions:
+* Retrieve all sources - `client.deal_sources.all`
+* Create a new source - `client.deal_sources.create`
+* Retrieve a single source - `client.deal_sources.find`
+* Update a source - `client.deal_sources.update`
+* Delete a source - `client.deal_sources.destroy`
+
 ### Lead
 
 ```ruby
@@ -230,6 +244,33 @@ Actions:
 * Update a lead - `client.leads.update`
 * Delete a lead - `client.leads.destroy`
 
+### LeadSource
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.lead_sources # => BaseCRM::LeadSourcesService
+```
+
+Actions:
+* Retrieve all sources - `client.lead_sources.all`
+* Create a new source - `client.lead_sources.create`
+* Retrieve a single source - `client.lead_sources.find`
+* Update a source - `client.lead_sources.update`
+* Delete a source - `client.lead_sources.destroy`
+
+### LineItem
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.line_items # => BaseCRM::LineItemsService
+```
+
+Actions:
+* Retrieve order's line items - `client.line_items.all`
+* Create a line item - `client.line_items.create`
+* Retrieve a single line item - `client.line_items.find`
+* Delete a line item - `client.line_items.destroy`
+
 ### LossReason
 
 ```ruby
@@ -258,6 +299,20 @@ Actions:
 * Update a note - `client.notes.update`
 * Delete a note - `client.notes.destroy`
 
+### Order
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.orders # => BaseCRM::OrdersService
+```
+
+Actions:
+* Retrieve all orders - `client.orders.all`
+* Create an order - `client.orders.create`
+* Retrieve a single order - `client.orders.find`
+* Update an order - `client.orders.update`
+* Delete an order - `client.orders.destroy`
+
 ### Pipeline
 
 ```ruby
@@ -268,7 +323,21 @@ client.pipelines # => BaseCRM::PipelinesService
 Actions:
 * Retrieve all pipelines - `client.pipelines.all`
 
-### Source
+### Product
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.products # => BaseCRM::ProductsService
+```
+
+Actions:
+* Retrieve all products - `client.products.all`
+* Create a product - `client.products.create`
+* Retrieve a single product - `client.products.find`
+* Update a product - `client.products.update`
+* Delete a product - `client.products.destroy`
+
+### Source (Deprecated, use LeadSource or DealSource instead)
 
 ```ruby
 client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")

data/lib/basecrm.rb

@@ -7,7 +7,7 @@ require 'basecrm/envelope'
 require 'basecrm/configuration'
 require 'basecrm/http_client'
 
-require 'basecrm/utils/coercion.rb'
+require 'basecrm/utils/coercion'
 
 require 'basecrm/model'
 require 'basecrm/models/meta'
@@ -16,10 +16,16 @@ require 'basecrm/models/address'
 require 'basecrm/models/associated_contact'
 require 'basecrm/models/contact'
 require 'basecrm/models/deal'
+require 'basecrm/models/deal_source'
 require 'basecrm/models/lead'
+require 'basecrm/models/lead_source'
+require 'basecrm/models/line_item'
 require 'basecrm/models/loss_reason'
 require 'basecrm/models/note'
+require 'basecrm/models/order'
 require 'basecrm/models/pipeline'
+require 'basecrm/models/price'
+require 'basecrm/models/product'
 require 'basecrm/models/source'
 require 'basecrm/models/stage'
 require 'basecrm/models/tag'
@@ -34,10 +40,15 @@ require 'basecrm/services/accounts_service'
 require 'basecrm/services/associated_contacts_service'
 require 'basecrm/services/contacts_service'
 require 'basecrm/services/deals_service'
+require 'basecrm/services/deal_sources_service'
 require 'basecrm/services/leads_service'
+require 'basecrm/services/lead_sources_service'
+require 'basecrm/services/line_items_service'
 require 'basecrm/services/loss_reasons_service'
 require 'basecrm/services/notes_service'
+require 'basecrm/services/orders_service'
 require 'basecrm/services/pipelines_service'
+require 'basecrm/services/products_service'
 require 'basecrm/services/sources_service'
 require 'basecrm/services/stages_service'
 require 'basecrm/services/tags_service'
@@ -111,6 +122,15 @@ module BaseCRM
       @deals ||= DealsService.new(@http_client)
     end
 
+    # Access all DealSources related actions.
+    # @see DealSourcesService
+    # @see DealSource
+    #
+    # @return [DealSourcesService] Service object for  resources.
+    def deal_sources
+      @deal_sources ||= DealSourcesService.new(@http_client)
+    end
+
     # Access all Leads related actions.
     # @see LeadsService
     # @see Lead
@@ -120,6 +140,24 @@ module BaseCRM
       @leads ||= LeadsService.new(@http_client)
     end
 
+    # Access all LeadSources related actions.
+    # @see LeadSourcesService
+    # @see LeadSource
+    #
+    # @return [LeadSourcesService] Service object for  resources.
+    def lead_sources
+      @lead_sources ||= LeadSourcesService.new(@http_client)
+    end
+
+    # Access all LineItems related actions.
+    # @see LineItemsService
+    # @see LineItem
+    #
+    # @return [LineItemsService] Service object for  resources.
+    def line_items
+      @line_items ||= LineItemsService.new(@http_client)
+    end
+
     # Access all LossReasons related actions.
     # @see LossReasonsService
     # @see LossReason
@@ -138,6 +176,15 @@ module BaseCRM
       @notes ||= NotesService.new(@http_client)
     end
 
+    # Access all Orders related actions.
+    # @see OrdersService
+    # @see Order
+    #
+    # @return [OrdersService] Service object for  resources.
+    def orders
+      @orders ||= OrdersService.new(@http_client)
+    end
+
     # Access all Pipelines related actions.
     # @see PipelinesService
     # @see Pipeline
@@ -147,6 +194,15 @@ module BaseCRM
       @pipelines ||= PipelinesService.new(@http_client)
     end
 
+    # Access all Products related actions.
+    # @see ProductsService
+    # @see Product
+    #
+    # @return [ProductsService] Service object for  resources.
+    def products
+      @products ||= ProductsService.new(@http_client)
+    end
+
     # Access all Sources related actions.
     # @see SourcesService
     # @see Source

data/lib/basecrm/models/deal.rb

@@ -8,9 +8,18 @@ module BaseCRM
     # @!attribute [r] creator_id
     #   @return [Integer] Unique identifier of the user who created the deal.
     # attr_reader :creator_id
+    # @!attribute [r] dropbox_email
+    #   @return [String] Dropbox email connected with the deal.
+    # attr_reader :dropbox_email
     # @!attribute [r] id
     #   @return [Integer] Unique identifier of the deal.
     # attr_reader :id
+    # @!attribute [r] last_stage_change_at
+    #   @return [DateTime] Date and time when the deal was moved into the current stage in UTC (ISO8601 format).
+    # attr_reader :last_stage_change_at
+    # @!attribute [r] last_stage_change_by_id
+    #   @return [Integer] Unique identifier of the user who moved the deal into the current stage.
+    # attr_reader :last_stage_change_by_id
     # @!attribute [r] organization_id
     #   @return [Integer] Unique identifier of an organization.
     # attr_reader :organization_id
@@ -27,9 +36,12 @@ module BaseCRM
     # @!attribute [rw] custom_fields
     #   @return [Hash] Custom fields are key-value data attached to a deal. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).
     # attr_accessor :custom_fields
-    # @!attribute [rw] dropbox_email
-    #   @return [String] Dropbox email connected with the deal.
-    # attr_accessor :dropbox_email
+    # @!attribute [rw] customized_win_likelihood
+    #   @return [Integer] User-provided win likelihood with value range 0–100.
+    # attr_accessor :customized_win_likelihood
+    # @!attribute [rw] estimated_close_date
+    #   @return [String] Estimated close date of the deal
+    # attr_accessor :estimated_close_date
     # @!attribute [rw] hot
     #   @return [Boolean] Indicator of whether or not the deal is hot.
     # attr_accessor :hot

data/lib/basecrm/models/deal_source.rb

@@ -0,0 +1,25 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class DealSource < Model
+    # @!attribute [r] created_at
+    #   @return [String] Date and time of creation in UTC (ISO 8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user that created the source.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the deal source.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [String] Date and time of the last update in UTC (ISO 8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] name
+    #   @return [String] Name of the source.
+    # attr_accessor :name
+    # @!attribute [rw] resource_type
+    #   @return [String] Type name of the resource the source is attached to. Possible values: deal
+    # attr_accessor :resource_type
+  end
+end

data/lib/basecrm/models/lead_source.rb

@@ -0,0 +1,25 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class LeadSource < Model
+    # @!attribute [r] created_at
+    #   @return [String] Date and time of creation in UTC (ISO 8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user that created the source.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the lead source.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [String] Date and time of the last update in UTC (ISO 8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] name
+    #   @return [String] Name of the source.
+    # attr_accessor :name
+    # @!attribute [rw] resource_type
+    #   @return [String] Type name of the resource the source is attached to. Possible values: lead
+    # attr_accessor :resource_type
+  end
+end

data/lib/basecrm/models/line_item.rb

@@ -0,0 +1,43 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class LineItem < Model
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the line item.
+    # attr_reader :id
+    # @!attribute [r] name
+    #   @return [String] Name of the product. Value is copied from the product.
+    # attr_reader :name
+    # @!attribute [r] sku
+    #   @return [String] Stock Keeping Unit identification code. Value is copied from the product.
+    # attr_reader :sku
+    # @!attribute [r] description
+    #   @return [String] Description of the product. Value is copied from the product.
+    # attr_reader :description
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time that the line item was created in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update on the line item in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] product_id
+    #   @return [Integer] Unique identifier of the product based on which line item is created. It is not available after creation.
+    # attr_accessor :product_id
+    # @!attribute [rw] value
+    #   @return [Integer] Value of one unit of the product. It is product’s price after applying markup.
+    # attr_accessor :value
+    # @!attribute [rw] variation
+    #   @return [Integer] Variation of the product’s price for this line item. Value of 5 means that 5% markup is added, -10 means there is a 10% discount.
+    # attr_accessor :variation
+    # @!attribute [rw] currency
+    #   @return [String] Currency of value and price, specified in 3-character currency code (ISO4217) format.
+    # attr_accessor :currency
+    # @!attribute [rw] quantity
+    #   @return [Integer] Quantity of the product included in this line item. Default value is 1.
+    # attr_accessor :quantity
+    # @!attribute [rw] price
+    #   @return [Integer] Price of one unit of the product. Value is copied from the product.
+    # attr_accessor :price
+  end
+end

data/lib/basecrm/models/order.rb

@@ -0,0 +1,22 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Order < Model
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the order.
+    # attr_reader :id
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time that the order was created in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update on the order in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] deal_id
+    #   @return [Integer] ID of the deal the order is associated to.
+    # attr_accessor :deal_id
+    # @!attribute [rw] discount
+    #   @return [Integer] Discount on the whole order in percents.
+    # attr_accessor :discount
+  end
+end

data/lib/basecrm/models/price.rb

@@ -0,0 +1,13 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Price < Model
+
+    # @!attribute [rw] amount
+    #   @return [Integer] Price amount
+    # attr_accessor :amount
+    # @!attribute [rw] currency
+    #   @return [String] Price currency
+    # attr_accessor :currency
+  end
+end

data/lib/basecrm/models/product.rb

@@ -0,0 +1,43 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Product < Model
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the product.
+    # attr_reader :id
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time that the product was created in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update on the product in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+    # @!attribute [rw] name
+    #   @return [String] Name of the product.
+    # attr_accessor :name
+    # @!attribute [rw] description
+    #   @return [String] Description of the product.
+    # attr_accessor :description
+    # @!attribute [rw] sku
+    #   @return [String] Stock Keeping Unit identification code.
+    # attr_accessor :sku
+    # @!attribute [rw] active
+    #   @return [Boolean] Indicator of whether the product is active. Line items cannot be created from inactive products.
+    # attr_accessor :active
+    # @!attribute [rw] max_discount
+    #   @return [Integer] Maximum discount that can be applied to the product in percents.
+    # attr_accessor :max_discount
+    # @!attribute [rw] max_markup
+    #   @return [Integer] Maximum markup that can be applied to the product in percents.
+    # attr_accessor :max_markup
+    # @!attribute [rw] cost
+    #   @return [Integer] Cost of the product. Visible only to account administrators.
+    # attr_accessor :cost
+    # @!attribute [rw] cost_currency
+    #   @return [String] Currency of the product cost, specified in 3-character currency code (ISO4217) format. Visible only to account administrators.
+    # attr_accessor :cost_currency
+    # @!attribute [rw] prices
+    #   @return [Array<Price>] Array specifying products prices in different currencies.
+    # attr_accessor :prices
+  end
+end

data/lib/basecrm/services/deal_sources_service.rb

@@ -0,0 +1,133 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class DealSourcesService
+    OPTS_KEYS_TO_PERSIST = Set[:name, :resource_type]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all sources
+    #
+    # get '/deal_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 '/deal_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<DealSource>] The list of DealSources for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/deal_sources", options)
+
+      root[:items].map{ |item| DealSource.new(item[:data]) }
+    end
+
+
+    # Create a new source
+    #
+    # post '/deal_sources'
+    #
+    # Creates a new source
+    # <figure class="notice">
+    # Source's name **must** be unique
+    # </figure>
+    #
+    # @param deal_source [DealSource, Hash] Either object of the DealSource type or Hash. This object's attributes describe the object to be created.
+    # @return [DealSource] The resulting object represting created resource.
+    def create(deal_source)
+      validate_type!(deal_source)
+
+      attributes = sanitize(deal_source)
+      _, _, root = @client.post("/deal_sources", attributes)
+
+      DealSource.new(root[:data])
+    end
+
+
+    # Retrieve a single source
+    #
+    # get '/deal_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 DealSource
+    # @return [DealSource] Searched resource object.
+    def find(id)
+      _, _, root = @client.get("/deal_sources/#{id}")
+
+      DealSource.new(root[:data])
+    end
+
+
+    # Update a source
+    #
+    # put '/deal_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 deal_source [DealSource, Hash] Either object of the DealSource type or Hash. This object's attributes describe the object to be updated.
+    # @return [DealSource] The resulting object represting updated resource.
+    def update(deal_source)
+      validate_type!(deal_source)
+      params = extract_params!(deal_source, :id)
+      id = params[:id]
+
+      attributes = sanitize(deal_source)
+      _, _, root = @client.put("/deal_sources/#{id}", attributes)
+
+      DealSource.new(root[:data])
+    end
+
+
+    # Delete a source
+    #
+    # delete '/deal_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 DealSource
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/deal_sources/#{id}")
+      status == 204
+    end
+
+
+  private
+    def validate_type!(deal_source)
+      raise TypeError unless deal_source.is_a?(DealSource) || deal_source.is_a?(Hash)
+    end
+
+    def extract_params!(deal_source, *args)
+      params = deal_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(deal_source)
+      deal_source.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end