basecrm 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e621bfe41a88f35c122a699674160402813de8b
-  data.tar.gz: 920db4f000725a80af23bfa9a77c1075580da116
+  metadata.gz: 3edd2e23d1f92a60d78428691fec6a7d7496b306
+  data.tar.gz: c3b879f523fc99539e444a6f50a16fc484152205
 SHA512:
-  metadata.gz: 75bbebdc011bea3940a6d2103fcff88e7e48fd78f9b35de41230c98c959fffd33063b8d56f17c6ac201b65609cec27d23f3f2900b9b64f89efa4208652928dee
-  data.tar.gz: 784f33b5bc21b7635887c8a29f99904d7d4dacac0f7ce5969a44172e4ebb0b5f7412db3e1018fb74f29c6cf56decbbb7fe26c99b9ac4b499ae07fe142c02cf5f
+  metadata.gz: 0e3009c58a14482b185a2359a68f90c90e6754c6babcf3db2077c0a491244c25443aba8b96659097e9ff5224de555378af9a7685c5d6118f146afe992901e223
+  data.tar.gz: 40a6886b9e548e7e6fe1fa69d4893bef923a07a101b66aae5aa1dba79430990d791741bce19f8a1361358aa8b9b7dfd336cbee04681df9a109dfb6a83cc2485d

data/README.md

@@ -437,6 +437,17 @@ Actions:
 * Update a task - `client.tasks.update`
 * Delete a task - `client.tasks.destroy`
 
+### TextMessage
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.text_messages # => BaseCRM::TextMessagesService
+```
+
+Actions:
+* Retrieve text messages - `client.text_messages.all`
+* Retrieve a single text message - `client.text_messages.find`
+
 ### User
 
 ```ruby
@@ -449,6 +460,26 @@ Actions:
 * Retrieve a single user - `client.users.find`
 * Retrieve an authenticating user - `client.users.self`
 
+### Visit
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.visits # => BaseCRM::VisitsService
+```
+
+Actions:
+* Retrieve visits - `client.visits.all`
+
+### VisitOutcome
+
+```ruby
+client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
+client.visit_outcomes # => BaseCRM::VisitOutcomesService
+```
+
+Actions:
+* Retrieve visit outcomes - `client.visit_outcomes.all`
+
 
 ## License
 MIT

data/lib/basecrm.rb

@@ -34,7 +34,10 @@ require 'basecrm/models/source'
 require 'basecrm/models/stage'
 require 'basecrm/models/tag'
 require 'basecrm/models/task'
+require 'basecrm/models/text_message'
 require 'basecrm/models/user'
+require 'basecrm/models/visit'
+require 'basecrm/models/visit_outcome'
 require 'basecrm/models/sync_queue'
 require 'basecrm/models/sync_session'
 require 'basecrm/models/sync_meta'
@@ -61,7 +64,10 @@ require 'basecrm/services/sources_service'
 require 'basecrm/services/stages_service'
 require 'basecrm/services/tags_service'
 require 'basecrm/services/tasks_service'
+require 'basecrm/services/text_messages_service'
 require 'basecrm/services/users_service'
+require 'basecrm/services/visits_service'
+require 'basecrm/services/visit_outcomes_service'
 require 'basecrm/services/sync_service'
 
 require 'basecrm/sync'
@@ -283,6 +289,15 @@ module BaseCRM
       @tasks ||= TasksService.new(@http_client)
     end
 
+    # Access all TextMessages related actions.
+    # @see TextMessagesService
+    # @see TextMessage
+    #
+    # @return [TextMessagesService] Service object for  resources.
+    def text_messages
+      @text_messages ||= TextMessagesService.new(@http_client)
+    end
+
     # Access all Users related actions.
     # @see UsersService
     # @see User
@@ -292,6 +307,24 @@ module BaseCRM
       @users ||= UsersService.new(@http_client)
     end
 
+    # Access all Visits related actions.
+    # @see VisitsService
+    # @see Visit
+    #
+    # @return [VisitsService] Service object for  resources.
+    def visits
+      @visits ||= VisitsService.new(@http_client)
+    end
+
+    # Access all VisitOutcomes related actions.
+    # @see VisitOutcomesService
+    # @see VisitOutcome
+    #
+    # @return [VisitOutcomesService] Service object for  resources.
+    def visit_outcomes
+      @visit_outcomes ||= VisitOutcomesService.new(@http_client)
+    end
+
     # Access Sync API related low-level actions.
     # @see SyncService
     #

data/lib/basecrm/models/text_message.rb

@@ -0,0 +1,43 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class TextMessage < Model
+    # @!attribute [r] associated_deal_ids
+    #   @return [Array<Integer>] An array of ids of deals associated to the text message.
+    # attr_reader :associated_deal_ids
+    # @!attribute [r] content
+    #   @return [String] Content of the text message.
+    # attr_reader :content
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of the text_message.
+    # attr_reader :id
+    # @!attribute [r] incoming
+    #   @return [Boolean] Indicator of whether the text message was incoming or not.
+    # attr_reader :incoming
+    # @!attribute [r] resource_id
+    #   @return [Integer] Unique identifier of the resource the text message is attached to.
+    # attr_reader :resource_id
+    # @!attribute [r] resource_phone_number
+    #   @return [String] Phone number of a resource the text message was sent to/received by.
+    # attr_reader :resource_phone_number
+    # @!attribute [r] resource_type
+    #   @return [String] Name of a resource type the text message is attached to.
+    # attr_reader :resource_type
+    # @!attribute [r] sent_at
+    #   @return [DateTime] Date and time of the message send time in UTC (ISO8601 format).
+    # attr_reader :sent_at
+    # @!attribute [r] updated_at
+    #   @return [DateTime] Date and time of the last update in UTC (ISO8601 format).
+    # attr_reader :updated_at
+    # @!attribute [r] user_id
+    #   @return [Integer] Unique identifier of a user who sent/received a text message.
+    # attr_reader :user_id
+    # @!attribute [r] user_phone_number
+    #   @return [String] Phone number of a user who sent/received a text message.
+    # attr_reader :user_phone_number
+
+  end
+end

data/lib/basecrm/models/visit.rb

@@ -0,0 +1,37 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class Visit < 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 a user who created a visit.
+    # attr_reader :creator_id
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of a visit.
+    # attr_reader :id
+    # @!attribute [r] outcome_id
+    #   @return [Integer] Unique identifier of a visit outcome.
+    # attr_reader :outcome_id
+    # @!attribute [r] rep_location_verification_status
+    #   @return [String] The status of the location verification of the device that created the visit (sales representative).
+    # attr_reader :rep_location_verification_status
+    # @!attribute [r] resource_address
+    #   @return [String] Address of the visit
+    # attr_reader :resource_address
+    # @!attribute [r] resource_id
+    #   @return [Integer] The ID of the resource the visit is attached to. Requires the resource_type query param to be set as well.
+    # attr_reader :resource_id
+    # @!attribute [r] resource_type
+    #   @return [String] The type of the resource the visit is attached to.
+    # attr_reader :resource_type
+    # @!attribute [r] summary
+    #   @return [String] Summary of the visit.
+    # attr_reader :summary
+    # @!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/models/visit_outcome.rb

@@ -0,0 +1,19 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class VisitOutcome < Model
+    # @!attribute [r] created_at
+    #   @return [DateTime] Date and time of creation in UTC (ISO8601 format).
+    # attr_reader :created_at
+    # @!attribute [r] id
+    #   @return [Integer] Unique identifier of a visit outcome.
+    # attr_reader :id
+    # @!attribute [r] name
+    #   @return [String] Name of the visit 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/text_messages_service.rb

@@ -0,0 +1,67 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class TextMessagesService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve text messages
+    #
+    # get '/text_messages'
+    #
+    # 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 text messages
+    #
+    # get '/text_messages'
+    #
+    # Returns Text Messages, according to the parameters provided
+    #
+    # @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 text message IDs to be returned in request.
+    # @option options [Integer] :resource_id Unique identifier of a resource the text message is attached to. Requires also resource_type to be specified.
+    # @option options [String] :resource_type Name of a resource type the text message is attached to. Requires also resource_id to be specified.
+    # @option options [String] :sort_by (id:desc) Comma-separated list of fields to sort by. The sort criteria is applied in the order specified. The **default** ordering is **descending**. If you want to change the sort ordering to ascending, append `:asc` to the field e.g. `sort_by=id:asc`
+    # @return [Array<TextMessage>] The list of TextMessages for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/text_messages", options)
+
+      root[:items].map{ |item| TextMessage.new(item[:data]) }
+    end
+
+
+    # Retrieve a single text message
+    #
+    # get '/text_messages/{id}'
+    #
+    # Returns a single text message according to the unique  ID provided
+    # If the specified user does not exist, this query returns an error
+    #
+    # @param id [Integer] Unique identifier of a TextMessage
+    # @return [TextMessage] Searched resource object.
+    def find(id)
+      _, _, root = @client.get("/text_messages/#{id}")
+
+      TextMessage.new(root[:data])
+    end
+
+
+  private
+    def validate_type!(text_message)
+      raise TypeError unless text_message.is_a?(TextMessage) || text_message.is_a?(Hash)
+    end
+
+    def extract_params!(text_message, *args)
+      params = text_message.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/visit_outcomes_service.rb

@@ -0,0 +1,47 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class VisitOutcomesService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve visit outcomes
+    #
+    # get '/visit_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 visit outcomes
+    #
+    # get '/visit_outcomes'
+    #
+    # Returns Visit Outcomes, according to the parameters provided
+    #
+    # @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<VisitOutcome>] The list of VisitOutcomes for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/visit_outcomes", options)
+
+      root[:items].map{ |item| VisitOutcome.new(item[:data]) }
+    end
+
+
+  private
+    def validate_type!(visit_outcome)
+      raise TypeError unless visit_outcome.is_a?(VisitOutcome) || visit_outcome.is_a?(Hash)
+    end
+
+    def extract_params!(visit_outcome, *args)
+      params = visit_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/visits_service.rb

@@ -0,0 +1,53 @@
+# WARNING: This code is auto-generated from the BaseCRM API Discovery JSON Schema
+
+module BaseCRM
+  class VisitsService
+    def initialize(client)
+      @client = client
+    end
+
+    # Retrieve visits
+    #
+    # get '/visits'
+    #
+    # 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 visits
+    #
+    # get '/visits'
+    #
+    # Returns Visits, according to the parameters provided
+    #
+    # @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 [Integer] :outcome_id Unique identifier of a visit outcome.
+    # @option options [Integer] :creator_id Unique identifier of a user who created a visit.
+    # @option options [Integer] :resource_id Unique identifier of a resource the visit is attached to. Requires also resource_type to be specified.
+    # @option options [String] :resource_type Name of a resource type the visit is attached to. Requires also resource_id to be specified.
+    # @option options [String] :rep_location_verification_status The status of the location verification of the device that created the visit (sales representative).
+    # @option options [String] :sort_by (id:asc) A field to sort by. Default ordering is ascending. If you want to change the sort order to descending, append :desc to the filed e.g. sort_by=visited_at:desc.
+    # @return [Array<Visit>] The list of Visits for the first page, unless otherwise specified.
+    def where(options = {})
+      _, _, root = @client.get("/visits", options)
+
+      root[:items].map{ |item| Visit.new(item[:data]) }
+    end
+
+
+  private
+    def validate_type!(visit)
+      raise TypeError unless visit.is_a?(Visit) || visit.is_a?(Hash)
+    end
+
+    def extract_params!(visit, *args)
+      params = visit.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/version.rb

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

data/spec/factories/text_message.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :text_message, class: BaseCRM::TextMessage do
+
+
+
+  end
+end

data/spec/services/text_messages_service_spec.rb

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

data/spec/services/visit_outcomes_service_spec.rb

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

data/spec/services/visits_service_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basecrm
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - BaseCRM developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -158,7 +158,10 @@ files:
 - lib/basecrm/models/sync_session.rb
 - lib/basecrm/models/tag.rb
 - lib/basecrm/models/task.rb
+- lib/basecrm/models/text_message.rb
 - lib/basecrm/models/user.rb
+- lib/basecrm/models/visit.rb
+- lib/basecrm/models/visit_outcome.rb
 - lib/basecrm/paginated_resource.rb
 - lib/basecrm/services/accounts_service.rb
 - lib/basecrm/services/associated_contacts_service.rb
@@ -182,7 +185,10 @@ files:
 - lib/basecrm/services/sync_service.rb
 - lib/basecrm/services/tags_service.rb
 - lib/basecrm/services/tasks_service.rb
+- lib/basecrm/services/text_messages_service.rb
 - lib/basecrm/services/users_service.rb
+- lib/basecrm/services/visit_outcomes_service.rb
+- lib/basecrm/services/visits_service.rb
 - lib/basecrm/sync.rb
 - lib/basecrm/utils/coercion.rb
 - lib/basecrm/version.rb
@@ -204,6 +210,7 @@ files:
 - spec/factories/source.rb
 - spec/factories/tag.rb
 - spec/factories/task.rb
+- spec/factories/text_message.rb
 - spec/middlewares/raise_error_spec.rb
 - spec/models/sync_meta_spec.rb
 - spec/services/accounts_service_spec.rb
@@ -228,7 +235,10 @@ files:
 - spec/services/sync_service_spec.rb
 - spec/services/tags_service_spec.rb
 - spec/services/tasks_service_spec.rb
+- spec/services/text_messages_service_spec.rb
 - spec/services/users_service_spec.rb
+- spec/services/visit_outcomes_service_spec.rb
+- spec/services/visits_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/client_helpers.rb
 - spec/utils/coercion.rb
@@ -253,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: BaseCRM Official API V2 library client for ruby
@@ -271,6 +281,7 @@ test_files:
 - spec/factories/deal.rb
 - spec/factories/call.rb
 - spec/factories/product.rb
+- spec/factories/text_message.rb
 - spec/factories/lead.rb
 - spec/factories/deal_unqualified_reason.rb
 - spec/factories/lead_unqualified_reason.rb
@@ -283,6 +294,7 @@ test_files:
 - spec/factories/task.rb
 - spec/basecrm/sync_spec.rb
 - spec/services/notes_service_spec.rb
+- spec/services/text_messages_service_spec.rb
 - spec/services/pipelines_service_spec.rb
 - spec/services/sources_service_spec.rb
 - spec/services/orders_service_spec.rb
@@ -298,8 +310,10 @@ 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/visit_outcomes_service_spec.rb
 - spec/services/calls_service_spec.rb
 - spec/services/deal_unqualified_reasons_service_spec.rb
+- spec/services/visits_service_spec.rb
 - spec/services/sync_service_spec.rb
 - spec/services/lead_unqualified_reasons_service_spec.rb
 - spec/services/accounts_service_spec.rb