basecrm 1.3.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c69d41cdc396cd95c74e3bdd2f778aa78ac0cf2e
-  data.tar.gz: dc6e97c0e908d384fc7f7eb4ad3abe03f726ecfe
+  metadata.gz: 5e621bfe41a88f35c122a699674160402813de8b
+  data.tar.gz: 920db4f000725a80af23bfa9a77c1075580da116
 SHA512:
-  metadata.gz: 1ce204616d05b6cb7a9ad00e90a910f23cf16e8ec7c4f3541e827bd7ddb9090225b1043c8717980e90e8cf35e6ee47c9960f16edc7cea28022cf1cf5c31fc8e7
-  data.tar.gz: ffa2c34f7aafc77cf05cefeffc3e174b4fd2729bafb91c30ea8b94acbffd52cefdf3b025fa60242d4d869646c7ee815cbdc8fbb0cc19bbdec69fa8eb2924c4ac
+  metadata.gz: 75bbebdc011bea3940a6d2103fcff88e7e48fd78f9b35de41230c98c959fffd33063b8d56f17c6ac201b65609cec27d23f3f2900b9b64f89efa4208652928dee
+  data.tar.gz: 784f33b5bc21b7635887c8a29f99904d7d4dacac0f7ce5969a44172e4ebb0b5f7412db3e1018fb74f29c6cf56decbbb7fe26c99b9ac4b499ae07fe142c02cf5f

data/README.md

@@ -174,6 +174,30 @@ Actions:
 * Create an associated contact - `client.associated_contacts.create`
 * Remove an associated contact - `client.associated_contacts.destroy`
 
+### Call
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.calls # => BaseCRM::CallsService
+```
+
+Actions:
+* Retrieve all calls - `client.calls.all`
+* Create a call - `client.calls.create`
+* Retrieve a single call - `client.calls.find`
+* Update a call - `client.calls.update`
+* Delete a call - `client.calls.destroy`
+
+### CallOutcome
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.call_outcomes # => BaseCRM::CallOutcomesService
+```
+
+Actions:
+* Retrieve all call outcomes - `client.call_outcomes.all`
+
 ### Contact
 
 ```ruby

data/lib/basecrm.rb

@@ -14,6 +14,8 @@ require 'basecrm/models/meta'
 require 'basecrm/models/account'
 require 'basecrm/models/address'
 require 'basecrm/models/associated_contact'
+require 'basecrm/models/call'
+require 'basecrm/models/call_outcome'
 require 'basecrm/models/contact'
 require 'basecrm/models/deal'
 require 'basecrm/models/deal_source'
@@ -40,6 +42,8 @@ require 'basecrm/models/sync_meta'
 require 'basecrm/paginated_resource'
 require 'basecrm/services/accounts_service'
 require 'basecrm/services/associated_contacts_service'
+require 'basecrm/services/calls_service'
+require 'basecrm/services/call_outcomes_service'
 require 'basecrm/services/contacts_service'
 require 'basecrm/services/deals_service'
 require 'basecrm/services/deal_sources_service'
@@ -108,6 +112,24 @@ module BaseCRM
       @associated_contacts ||= AssociatedContactsService.new(@http_client)
     end
 
+    # Access all Calls related actions.
+    # @see CallsService
+    # @see Call
+    #
+    # @return [CallsService] Service object for  resources.
+    def calls
+      @calls ||= CallsService.new(@http_client)
+    end
+
+    # Access all CallOutcomes related actions.
+    # @see CallOutcomesService
+    # @see CallOutcome
+    #
+    # @return [CallOutcomesService] Service object for  resources.
+    def call_outcomes
+      @call_outcomes ||= CallOutcomesService.new(@http_client)
+    end
+
     # Access all Contacts related actions.
     # @see ContactsService
     # @see Contact

data/lib/basecrm/models/call.rb

@@ -0,0 +1,52 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Call < Model
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the call.
+    # attr_reader :id
+    # @!attribute [r] upated_at
+    #   @return [DateTime] Date and time of the last update in UTC (ISO8601 format).
+    # attr_reader :upated_at
+
+    # @!attribute [rw] associated_deal_ids
+    #   @return [Array<Integer>] An array of ids of deals associated to the call.
+    # attr_accessor :associated_deal_ids
+    # @!attribute [rw] duration
+    #   @return [Integer] Duration of the call in seconds.
+    # attr_accessor :duration
+    # @!attribute [rw] external_id
+    #   @return [String] Unique identifier of a call from an external system.
+    # attr_accessor :external_id
+    # @!attribute [rw] incoming
+    #   @return [Boolean] Phone number of the person with which the call was made.
+    # attr_accessor :incoming
+    # @!attribute [rw] made_at
+    #   @return [DateTime] Date and time of when the call was made (started) in UTC (ISO8601 format).
+    # attr_accessor :made_at
+    # @!attribute [rw] missed
+    #   @return [Boolean] Indicator of whether the call was missed (not answered) by the user or not.
+    # attr_accessor :missed
+    # @!attribute [rw] outcome_id
+    #   @return [Integer] Unique identifier of Call Outcome assigned to the call.
+    # attr_accessor :outcome_id
+    # @!attribute [rw] phone_number
+    #   @return [String] Indicator of whether the call was incoming or not.
+    # attr_accessor :phone_number
+    # @!attribute [rw] recording_url
+    #   @return [String] URL pointing to call recording.
+    # attr_accessor :recording_url
+    # @!attribute [rw] resource_id
+    #   @return [Integer] Unique identifier of the resource the call is attached to.
+    # attr_accessor :resource_id
+    # @!attribute [rw] resource_type
+    #   @return [String] Name of the resource type the call is attached to.
+    # attr_accessor :resource_type
+    # @!attribute [rw] summary
+    #   @return [String] Content of the note about this call.
+    # attr_accessor :summary
+    # @!attribute [rw] user_id
+    #   @return [Integer] Unique identifier of the user who performed the call.
+    # attr_accessor :user_id
+  end
+end

data/lib/basecrm/models/call_outcome.rb

@@ -0,0 +1,22 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class CallOutcome < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of when the call outcome was created in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] creator_id
+    #   @return [Integer] Unique identifier of the user who created the call outcome.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the call outcome.
+    # attr_reader :id
+    # @!attribute [r] name
+    #   @return [String] Name of the call outcome.
+    # attr_reader :name
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC (ISO8601 format).
+    # attr_reader :updated_at
+
+  end
+end

data/lib/basecrm/services/call_outcomes_service.rb

@@ -0,0 +1,48 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class CallOutcomesService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all call outcomes
+    #
+    # get '/call_outcomes'
+    #
+    # 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 call outcomes
+    #
+    # get '/call_outcomes'
+    #
+    # Returns all call outcomes available to the user, according to the parameters provided
+    # Call outcomes are always sorted by id in ascending order
+    #
+    # @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. The default limit is *25* and the maximum number that can be returned at one time is *100*.
+    # @return [Array<CallOutcome>] The list of CallOutcomes for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/call_outcomes", options)
+
+      root[:items].map{ |item| CallOutcome.new(item[:data]) }
+    end
+
+
+  private
+    def validate_type!(call_outcome)
+      raise TypeError unless call_outcome.is_a?(CallOutcome) || call_outcome.is_a?(Hash)
+    end
+
+    def extract_params!(call_outcome, *args)
+      params = call_outcome.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/calls_service.rb

@@ -0,0 +1,127 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class CallsService
+    OPTS_KEYS_TO_PERSIST = Set[:user_id, :summary, :recording_url, :outcome_id, :duration, :phone_number, :incoming, :missed, :external_id, :resource_id, :resource_type, :associated_deal_ids, :made_at]
+
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve all calls
+    #
+    # get '/calls'
+    #
+    # 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 calls
+    #
+    # get '/calls'
+    #
+    # Returns all calls available to the user, according to the parameters provided
+    # Calls are always sorted by made_at in descending order
+    #
+    # @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. The default limit is *25* and the maximum number that can be returned at one time is *100*.
+    # @option options [String] :ids Comma-separated list of call IDs to be returned in request.
+    # @option options [Integer] :resource_id Unique identifier of the resource the call is attached to.
+    # @option options [String] :resource_type Name of the resource type the call is attached to.
+    # @return [Array<Call>] The list of Calls for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/calls", options)
+
+      root[:items].map{ |item| Call.new(item[:data]) }
+    end
+
+
+    # Create a call
+    #
+    # post '/calls'
+    #
+    # Create a new call
+    #
+    # @param call [Call, Hash] Either object of the Call type or Hash. This object's attributes describe the object to be created.
+    # @return [Call] The resulting object represting created resource.
+    def create(call)
+      validate_type!(call)
+
+      attributes = sanitize(call)
+      _, _, root = @client.post("/calls", attributes)
+
+      Call.new(root[:data])
+    end
+
+
+    # Retrieve a single call
+    #
+    # get '/calls/{id}'
+    #
+    # Returns a single call available to the user, according to the unique call ID provided
+    # If the specified call does not exist, this query returns an error
+    #
+    # @param id [Integer] Unique identifier of a Call
+    # @return [Call] Searched resource object.
+    def find(id)
+      _, _, root = @client.get("/calls/#{id}")
+
+      Call.new(root[:data])
+    end
+
+
+    # Update a call
+    #
+    # put '/calls/{id}'
+    #
+    # Allows to attach a Contact or Lead to an existing Call, or change it’s current association
+    #
+    # @param call [Call, Hash] Either object of the Call type or Hash. This object's attributes describe the object to be updated.
+    # @return [Call] The resulting object represting updated resource.
+    def update(call)
+      validate_type!(call)
+      params = extract_params!(call, :id)
+      id = params[:id]
+
+      attributes = sanitize(call)
+      _, _, root = @client.put("/calls/#{id}", attributes)
+
+      Call.new(root[:data])
+    end
+
+
+    # Delete a call
+    #
+    # delete '/calls/{id}'
+    #
+    # Delete an existing call
+    # If the specified call does not exist, this query returns an error
+    # This operation cannot be undone
+    #
+    # @param id [Integer] Unique identifier of a Call
+    # @return [Boolean] Status of the operation.
+    def destroy(id)
+      status, _, _ = @client.delete("/calls/#{id}")
+      status == 204
+    end
+
+
+  private
+    def validate_type!(call)
+      raise TypeError unless call.is_a?(Call) || call.is_a?(Hash)
+    end
+
+    def extract_params!(call, *args)
+      params = call.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(call)
+      call.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
+    end
+  end
+end

data/lib/basecrm/version.rb

@@ -1,3 +1,3 @@
 module BaseCRM
-  VERSION = "1.3.3"
+  VERSION = "1.3.4"
 end

data/spec/factories/call.rb

@@ -0,0 +1,20 @@
+require 'securerandom'
+
+FactoryGirl.define do
+  factory :call, class: BaseCRM::Call do
+
+    summary { "Schedule another call." }
+    recording_url { "https://api.twilio.com/2010-04-01/Accounts/hAkjsahhd719e/Recordings/RKOHurusajda" }
+    duration { 44 }
+    phone_number { "+44-208-1234567" }
+    incoming { true }
+    missed { false }
+    external_id { SecureRandom.hex(32) }
+    made_at { "2014-09-27T16:32:56+00:00" }
+
+
+    to_create do |call|
+      client.calls.create(call)
+    end
+  end
+end

data/spec/services/call_outcomes_service_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe BaseCRM::CallOutcomesService do
+  describe 'Responds to' do
+    subject { client.call_outcomes  }
+
+    it { should respond_to :all }
+    it { should respond_to :where }
+  end
+
+  describe :all do
+    it "returns a PaginatedResource" do
+      expect(client.call_outcomes.all()).to be_instance_of BaseCRM::PaginatedResource
+    end
+  end
+
+  describe :where do
+    it "returns an array" do
+      expect(client.call_outcomes.where(page: 1)).to be_an Array
+    end
+  end
+end

data/spec/services/calls_service_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe BaseCRM::CallsService do
+  describe 'Responds to' do
+    subject { client.calls  }
+
+    it { should respond_to :all }
+    it { should respond_to :create }
+    it { should respond_to :destroy }
+    it { should respond_to :find }
+    it { should respond_to :update }
+    it { should respond_to :where }
+  end
+
+  describe :all do
+    it "returns a PaginatedResource" do
+      expect(client.calls.all()).to be_instance_of BaseCRM::PaginatedResource
+    end
+  end
+
+  describe :where do
+    it "returns an array" do
+      expect(client.calls.where(page: 1)).to be_an Array
+    end
+  end
+
+  describe :create do
+    it "returns instance of Call class" do
+      @call = build(:call)
+      expect(client.calls.create(@call)).to be_instance_of BaseCRM::Call
+    end
+  end
+
+  describe :find do
+    before :each do
+      @call = create(:call)
+    end
+
+    it "returns an instance of Call class" do
+      expect(client.calls.find(@call.id)).to be_instance_of BaseCRM::Call
+    end
+  end
+
+  describe :update do
+    it "returns an updated instance of Call class" do
+      @call = create(:call)
+      contact = create(:contact)
+
+      expect(client.calls.update(id: @call.id, resource_type: "contact", resource_id: contact.id)).to be_instance_of BaseCRM::Call
+    end
+  end
+
+  describe :destroy do
+    it "returns true on success" do
+      @call = create(:call)
+      expect(client.calls.destroy(@call.id)).to be_truthy
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basecrm
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.4
 platform: ruby
 authors:
 - BaseCRM developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -134,6 +134,8 @@ files:
 - lib/basecrm/models/account.rb
 - lib/basecrm/models/address.rb
 - lib/basecrm/models/associated_contact.rb
+- lib/basecrm/models/call.rb
+- lib/basecrm/models/call_outcome.rb
 - lib/basecrm/models/contact.rb
 - lib/basecrm/models/deal.rb
 - lib/basecrm/models/deal_source.rb
@@ -160,6 +162,8 @@ files:
 - lib/basecrm/paginated_resource.rb
 - lib/basecrm/services/accounts_service.rb
 - lib/basecrm/services/associated_contacts_service.rb
+- lib/basecrm/services/call_outcomes_service.rb
+- lib/basecrm/services/calls_service.rb
 - lib/basecrm/services/contacts_service.rb
 - lib/basecrm/services/deal_sources_service.rb
 - lib/basecrm/services/deal_unqualified_reasons_service.rb
@@ -184,6 +188,7 @@ files:
 - lib/basecrm/version.rb
 - spec/basecrm/sync_spec.rb
 - spec/factories/associated_contact.rb
+- spec/factories/call.rb
 - spec/factories/contact.rb
 - spec/factories/deal.rb
 - spec/factories/deal_source.rb
@@ -203,6 +208,8 @@ files:
 - spec/models/sync_meta_spec.rb
 - spec/services/accounts_service_spec.rb
 - spec/services/associated_contacts_service_spec.rb
+- spec/services/call_outcomes_service_spec.rb
+- spec/services/calls_service_spec.rb
 - spec/services/contacts_service_spec.rb
 - spec/services/deal_sources_service_spec.rb
 - spec/services/deal_unqualified_reasons_service_spec.rb
@@ -262,6 +269,7 @@ test_files:
 - spec/factories/tag.rb
 - spec/factories/contact.rb
 - spec/factories/deal.rb
+- spec/factories/call.rb
 - spec/factories/product.rb
 - spec/factories/lead.rb
 - spec/factories/deal_unqualified_reason.rb
@@ -282,6 +290,7 @@ test_files:
 - spec/services/stages_service_spec.rb
 - spec/services/tags_service_spec.rb
 - spec/services/products_service_spec.rb
+- spec/services/call_outcomes_service_spec.rb
 - spec/services/lead_sources_service_spec.rb
 - spec/services/associated_contacts_service_spec.rb
 - spec/services/users_service_spec.rb
@@ -289,6 +298,7 @@ test_files:
 - spec/services/line_items_service_spec.rb
 - spec/services/loss_reasons_service_spec.rb
 - spec/services/deal_sources_service_spec.rb
+- spec/services/calls_service_spec.rb
 - spec/services/deal_unqualified_reasons_service_spec.rb
 - spec/services/sync_service_spec.rb
 - spec/services/lead_unqualified_reasons_service_spec.rb