Add Text messages and Visits and Visit Outcomes models to the client

Author: struniu

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

lib/basecrm.rb

@@ -34,7 +34,10 @@
 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/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 @@ def tasks
       @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 @@ def users
       @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
     #

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

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

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

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

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

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

spec/factories/text_message.rb

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