basecrm 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: a9b11989ce99c253d1924a4cf9994e941d28c003d2f4af414224bc0b05990b82
-  data.tar.gz: 129afc0658fb9f5320fef56bc3f243651e4725ce485a94976c22b3c4c5f0c1f8
+SHA1:
+  metadata.gz: c69d41cdc396cd95c74e3bdd2f778aa78ac0cf2e
+  data.tar.gz: dc6e97c0e908d384fc7f7eb4ad3abe03f726ecfe
 SHA512:
-  metadata.gz: 5330a0039bced2ce1aca5bbb078f8698e495737a41d14a63682638d7cddf4633c9d290cd402ff8e03a34fbffce4c758d0f768bbb1c870fa54d23f6253808eaf8
-  data.tar.gz: d2bfcdf4ad1868f75bf24ca628c7cf2739391730f99173de9e8068932dec3b6420327e7413fc4a7238b559d043e88f6369ef64573d2e5c778135b650ee0ef0b0
+  metadata.gz: 1ce204616d05b6cb7a9ad00e90a910f23cf16e8ec7c4f3541e827bd7ddb9090225b1043c8717980e90e8cf35e6ee47c9960f16edc7cea28022cf1cf5c31fc8e7
+  data.tar.gz: ffa2c34f7aafc77cf05cefeffc3e174b4fd2729bafb91c30ea8b94acbffd52cefdf3b025fa60242d4d869646c7ee815cbdc8fbb0cc19bbdec69fa8eb2924c4ac

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2017 BaseCRM developers
+Copyright (c) 2015-2018 BaseCRM developers
 
 MIT License
 

data/README.md

@@ -230,6 +230,20 @@ Actions:
 * Update a source - `client.deal_sources.update`
 * Delete a source - `client.deal_sources.destroy`
 
+### DealUnqualifiedReason
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.deal_unqualified_reasons # => BaseCRM::DealUnqualifiedReasonsService
+```
+
+Actions:
+* Retrieve all deal unqualified reasons - `client.deal_unqualified_reasons.all`
+* Create a deal unqualified reason - `client.deal_unqualified_reasons.create`
+* Retrieve a single deal unqualified reason - `client.deal_unqualified_reasons.find`
+* Update a deal unqualified reason - `client.deal_unqualified_reasons.update`
+* Delete a deal unqualified reason - `client.deal_unqualified_reasons.destroy`
+
 ### Lead
 
 ```ruby
@@ -258,6 +272,16 @@ Actions:
 * Update a source - `client.lead_sources.update`
 * Delete a source - `client.lead_sources.destroy`
 
+### LeadUnqualifiedReason
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.lead_unqualified_reasons # => BaseCRM::LeadUnqualifiedReasonsService
+```
+
+Actions:
+* Retrieve all lead unqualified reasons - `client.lead_unqualified_reasons.all`
+
 ### LineItem
 
 ```ruby

data/lib/basecrm.rb

@@ -17,8 +17,10 @@ require 'basecrm/models/associated_contact'
 require 'basecrm/models/contact'
 require 'basecrm/models/deal'
 require 'basecrm/models/deal_source'
+require 'basecrm/models/deal_unqualified_reason'
 require 'basecrm/models/lead'
 require 'basecrm/models/lead_source'
+require 'basecrm/models/lead_unqualified_reason'
 require 'basecrm/models/line_item'
 require 'basecrm/models/loss_reason'
 require 'basecrm/models/note'
@@ -41,8 +43,10 @@ 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/deal_unqualified_reasons_service'
 require 'basecrm/services/leads_service'
 require 'basecrm/services/lead_sources_service'
+require 'basecrm/services/lead_unqualified_reasons_service'
 require 'basecrm/services/line_items_service'
 require 'basecrm/services/loss_reasons_service'
 require 'basecrm/services/notes_service'
@@ -131,6 +135,15 @@ module BaseCRM
       @deal_sources ||= DealSourcesService.new(@http_client)
     end
 
+    # Access all DealUnqualifiedReasons related actions.
+    # @see DealUnqualifiedReasonsService
+    # @see DealUnqualifiedReason
+    #
+    # @return [DealUnqualifiedReasonsService] Service object for  resources.
+    def deal_unqualified_reasons
+      @deal_unqualified_reasons ||= DealUnqualifiedReasonsService.new(@http_client)
+    end
+
     # Access all Leads related actions.
     # @see LeadsService
     # @see Lead
@@ -149,6 +162,15 @@ module BaseCRM
       @lead_sources ||= LeadSourcesService.new(@http_client)
     end
 
+    # Access all LeadUnqualifiedReasons related actions.
+    # @see LeadUnqualifiedReasonsService
+    # @see LeadUnqualifiedReason
+    #
+    # @return [LeadUnqualifiedReasonsService] Service object for  resources.
+    def lead_unqualified_reasons
+      @lead_unqualified_reasons ||= LeadUnqualifiedReasonsService.new(@http_client)
+    end
+
     # Access all LineItems related actions.
     # @see LineItemsService
     # @see LineItem

data/lib/basecrm/models/deal.rb

@@ -14,9 +14,6 @@ module BaseCRM
     # @!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
@@ -45,6 +42,9 @@ module BaseCRM
     # @!attribute [rw] hot
     #   @return [Boolean] Indicator of whether or not the deal is hot.
     # attr_accessor :hot
+    # @!attribute [rw] last_stage_change_at
+    #   @return [DateTime] Date and time when the deal was moved into the current stage in UTC (ISO8601 format).
+    # attr_accessor :last_stage_change_at
     # @!attribute [rw] loss_reason_id
     #   @return [Integer] Reason why the deal was lost.
     # attr_accessor :loss_reason_id

data/lib/basecrm/models/deal_unqualified_reason.rb

@@ -0,0 +1,22 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class DealUnqualifiedReason < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC ISO8601 format.
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user the deal unqualified reason was created by.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the deal unqualified reason.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC ISO8601 format.
+    # attr_reader :updated_at
+
+    # @!attribute [rw] name
+    #   @return [String] Human-friendly unqualified reason explanation.
+    # attr_accessor :name
+  end
+end

data/lib/basecrm/models/lead_unqualified_reason.rb

@@ -0,0 +1,22 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class LeadUnqualifiedReason < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC ISO8601 format.
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user the lead unqualified reason was created by.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the lead unqualified reason.
+    # attr_reader :id
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC ISO8601 format.
+    # attr_reader :updated_at
+
+    # @!attribute [rw] name
+    #   @return [String] Human-friendly unqualified reason explanation.
+    # attr_accessor :name
+  end
+end

data/lib/basecrm/services/accounts_service.rb

@@ -5,14 +5,14 @@ module BaseCRM
     def initialize(client)
       @client = client
     end
-  
+
     # Retrieve account details
-    # 
+    #
     # get '/accounts/self'
     #
     # Returns detailed information about your account
     #
-    # @return [Account] Resource object. 
+    # @return [Account] Resource object.
     def self
       _, _, root = @client.get("/accounts/self")
       Account.new(root[:data])

data/lib/basecrm/services/associated_contacts_service.rb

@@ -9,17 +9,17 @@ module BaseCRM
     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. 
+    # @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
@@ -28,24 +28,24 @@ module BaseCRM
     # @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. 
+    # @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. 
+    # @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)
 
@@ -54,10 +54,10 @@ module BaseCRM
 
       AssociatedContact.new(root[:data])
     end
-    
+
 
     # Remove an associated contact
-    # 
+    #
     # delete '/deals/{deal_id}/associated_contacts/{contact_id}'
     #
     # Remove a deal's associated contact
@@ -71,7 +71,7 @@ module BaseCRM
       status, _, _ = @client.delete("/deals/#{deal_id}/associated_contacts/#{contact_id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(associated_contact)
@@ -83,7 +83,7 @@ module BaseCRM
       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

data/lib/basecrm/services/contacts_service.rb

@@ -9,17 +9,17 @@ module BaseCRM
     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. 
+    # @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
@@ -38,23 +38,23 @@ module BaseCRM
     # @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. 
+    # @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. 
+    # @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)
 
@@ -63,26 +63,26 @@ module BaseCRM
 
       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. 
+    # @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
@@ -90,8 +90,8 @@ module BaseCRM
     # **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. 
+    # @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)
@@ -102,10 +102,10 @@ module BaseCRM
 
       Contact.new(root[:data])
     end
-    
+
 
     # Delete a contact
-    # 
+    #
     # delete '/contacts/{id}'
     #
     # Delete an existing contact
@@ -118,7 +118,7 @@ module BaseCRM
       status, _, _ = @client.delete("/contacts/#{id}")
       status == 204
     end
-    
+
 
   private
     def validate_type!(contact)
@@ -130,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(contact)
       contact.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
     end

data/lib/basecrm/services/deal_unqualified_reasons_service.rb

@@ -0,0 +1,133 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class DealUnqualifiedReasonsService
+    OPTS_KEYS_TO_PERSIST = Set[:name]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all deal unqualified reasons
+    #
+    # get '/deal_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 deal unqualified reasons
+    #
+    # get '/deal_unqualified_reasons'
+    #
+    # Returns all deal unqualified reasons available to the user according to the parameters provided
+    #
+    # @param options [Hash] Search options
+    # @option options [String] :ids Comma separated list of deal unqualified reasons unique identifiers to be returned in a request.
+    # @option options [String] :name Name of the deal unqualified 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<DealUnqualifiedReason>] The list of DealUnqualifiedReasons for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/deal_unqualified_reasons", options)
+
+      root[:items].map{ |item| DealUnqualifiedReason.new(item[:data]) }
+    end
+
+
+    # Create a deal unqualified reason
+    #
+    # post '/deal_unqualified_reasons'
+    #
+    # Create a new deal unqualified reason
+    # <figure class="notice">
+    # Deal unqualified reason's name **must** be unique
+    # </figure>
+    #
+    # @param deal_unqualified_reason [DealUnqualifiedReason, Hash] Either object of the DealUnqualifiedReason type or Hash. This object's attributes describe the object to be created.
+    # @return [DealUnqualifiedReason] The resulting object represting created resource.
+    def create(deal_unqualified_reason)
+      validate_type!(deal_unqualified_reason)
+
+      attributes = sanitize(deal_unqualified_reason)
+      _, _, root = @client.post("/deal_unqualified_reasons", attributes)
+
+      DealUnqualifiedReason.new(root[:data])
+    end
+
+
+    # Retrieve a single deal unqualified reason
+    #
+    # get '/deal_unqualified_reasons/{id}'
+    #
+    # Returns a single deal unqualified 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 DealUnqualifiedReason
+    # @return [DealUnqualifiedReason] Searched resource object.
+    def find(id)
+      _, _, root = @client.get("/deal_unqualified_reasons/#{id}")
+
+      DealUnqualifiedReason.new(root[:data])
+    end
+
+
+    # Update a deal unqualified reason
+    #
+    # put '/deal_unqualified_reasons/{id}'
+    #
+    # Updates a deal unqualified reason information
+    # If the specified deal unqualified reason does not exist, the request will return an error
+    # <figure class="notice">
+    # If you want to update deal unqualified reason you **must** make sure name of the reason is unique
+    # </figure>
+    #
+    # @param deal_unqualified_reason [DealUnqualifiedReason, Hash] Either object of the DealUnqualifiedReason type or Hash. This object's attributes describe the object to be updated.
+    # @return [DealUnqualifiedReason] The resulting object represting updated resource.
+    def update(deal_unqualified_reason)
+      validate_type!(deal_unqualified_reason)
+      params = extract_params!(deal_unqualified_reason, :id)
+      id = params[:id]
+
+      attributes = sanitize(deal_unqualified_reason)
+      _, _, root = @client.put("/deal_unqualified_reasons/#{id}", attributes)
+
+      DealUnqualifiedReason.new(root[:data])
+    end
+
+
+    # Delete a deal unqualified reason
+    #
+    # delete '/deal_unqualified_reasons/{id}'
+    #
+    # Delete an existing deal unqualified 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 DealUnqualifiedReason
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/deal_unqualified_reasons/#{id}")
+      status == 204
+    end
+
+
+  private
+    def validate_type!(deal_unqualified_reason)
+      raise TypeError unless deal_unqualified_reason.is_a?(DealUnqualifiedReason) || deal_unqualified_reason.is_a?(Hash)
+    end
+
+    def extract_params!(deal_unqualified_reason, *args)
+      params = deal_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
+
+    def sanitize(deal_unqualified_reason)
+      deal_unqualified_reason.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end