basecrm 1.3.4 → 1.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5e621bfe41a88f35c122a699674160402813de8b
-  data.tar.gz: 920db4f000725a80af23bfa9a77c1075580da116
+SHA256:
+  metadata.gz: afa9bee39abea53bd2f89300e5e50cb638021d64b31372c0de31f8658f52a21b
+  data.tar.gz: e2f9681713ab28c138f64355ea069f95774b705cb85466ff26b69874bd2a7200
 SHA512:
-  metadata.gz: 75bbebdc011bea3940a6d2103fcff88e7e48fd78f9b35de41230c98c959fffd33063b8d56f17c6ac201b65609cec27d23f3f2900b9b64f89efa4208652928dee
-  data.tar.gz: 784f33b5bc21b7635887c8a29f99904d7d4dacac0f7ce5969a44172e4ebb0b5f7412db3e1018fb74f29c6cf56decbbb7fe26c99b9ac4b499ae07fe142c02cf5f
+  metadata.gz: 43f0e183a4f134c48347cbad9866ea8dd7f59f9cbf7df06c185f9e22279c630673d9889a2efb10367564c6241914f38144cf6f322484ff9c244dca87dfb43786
+  data.tar.gz: 431333dce4e47268eb3f43d41b2206bb7befdadf60f7ca4dc152fa32c56b4cfeab18284876a81fa17bdfcc6450108c033693be823277a3adaa328dd949e57202

data/LICENSE

@@ -1,22 +1,201 @@
-Copyright (c) 2015-2018 BaseCRM developers
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2013 Zendesk
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -21,7 +21,7 @@ gem 'basecrm'
 To get the latest version, put this in your Gemfile:
 
 ```ruby
-gem 'basecrm', :git => 'git://github.com/basecrm/basecrm-ruby.git'
+gem 'basecrm', :git => 'git://github.com/zendesk/basecrm-ruby.git'
 ```
 
 ## Usage
@@ -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,12 +460,37 @@ 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
+```
 
-## License
-MIT
+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`
 
 ## Bug Reports
-Report [here](https://github.com/basecrm/basecrm-ruby/issues).
+Report [here](https://github.com/zendesk/basecrm-ruby/issues).
+
+## Releasing new version of gem
+
+1. Update version [lib/basecrm/version.rb](lib/basecrm/version.rb) and [VERSION](VERSION) and push to `master`
+2. Create new GitHub release with tag name starting with `v` and the version, for example `v1.0.0`
+3. Gem will be automatically built and pushed to rubygems.org with GitHub Action
+
+## Copyright and license
+
+Copyright 2013 Zendesk
 
-## Contact
-BaseCRM developers (developers@getbase.com)
+Licensed under the [Apache License, Version 2.0](LICENSE)

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/contact.rb

@@ -22,7 +22,7 @@ module BaseCRM
     #   @return [Integer] The unique identifier of the organization the contact belongs to. The field will be set only if the contact is an individual.
     # attr_accessor :contact_id
     # @!attribute [rw] custom_fields
-    #   @return [Hash] Custom fields are a key-value pair attached to a contact. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields).
+    #   @return [Hash] Custom fields are a key-value pair attached to a contact. See more at [Custom Fields](/docs/rest/articles/requests#custom_fields). Note! You need to set Filterable on from Settings -> Contacts to be able to search by custom fields
     # attr_accessor :custom_fields
     # @!attribute [rw] customer_status
     #   @return [String] The customer status of the contact.

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/deals_service.rb

@@ -2,7 +2,7 @@
 
 module BaseCRM
   class DealsService
-    OPTS_KEYS_TO_PERSIST = Set[:contact_id, :currency, :custom_fields, :hot, :loss_reason_id, :name, :owner_id, :source_id, :stage_id, :tags, :value, :last_stage_change_at, :estimated_close_date, :customized_win_likelihood]
+    OPTS_KEYS_TO_PERSIST = Set[:contact_id, :currency, :custom_fields, :hot, :loss_reason_id, :unqualified_reason_id, :name, :owner_id, :source_id, :stage_id, :tags, :value, :last_stage_change_at, :estimated_close_date, :customized_win_likelihood]
 
     def initialize(client)
       @client = client

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/utils/coercion.rb

@@ -3,7 +3,7 @@ require "bigdecimal"
 module BaseCRM
   class Coercion
     def self.to_decimal_value(value)
-      BigDecimal.new((value || 0), 15)
+      BigDecimal((value || 0), 15)
     end
 
     def self.to_string(value)

data/lib/basecrm/version.rb

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

data/spec/factories/associated_contact.rb

@@ -1,7 +1,7 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :associated_contact, class: BaseCRM::AssociatedContact do
     # transient attributes, required in url
-    deal_id nil
+    deal_id { nil }
 
     role { "involved" }
 

data/spec/factories/call.rb

@@ -1,6 +1,6 @@
 require 'securerandom'
 
-FactoryGirl.define do
+FactoryBot.define do
   factory :call, class: BaseCRM::Call do
 
     summary { "Schedule another call." }

data/spec/factories/contact.rb

@@ -1,8 +1,8 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :contact, class: BaseCRM::Contact do
 
     description { "I know him via Tom" }
-    email { "mark@designservices.com" }
+    email { "mark#{SecureRandom.hex}@example.com" }
     facebook { "mjohnson" }
     fax { "+44-208-1234567" }
     first_name { Faker::Name.first_name }
@@ -17,7 +17,7 @@ FactoryGirl.define do
     tags { ["important"] }
     title { "CEO" }
     twitter { "mjohnson" }
-    website { "www.designservices.com" }
+    website { "www.example.com" }
 
 
     to_create do |contact|

data/spec/factories/deal.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :deal, class: BaseCRM::Deal do
 
     currency { "EUR" }

data/spec/factories/deal_source.rb

@@ -1,7 +1,7 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :deal_source, class: BaseCRM::DealSource do
 
-    name { Faker::Name.name }
+    name { "source#{SecureRandom.hex}" }
 
 
     to_create do |deal_source|

data/spec/factories/deal_unqualified_reason.rb

@@ -1,7 +1,7 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :deal_unqualified_reason, class: BaseCRM::DealUnqualifiedReason do
 
-    name { Faker::Name.name }
+    name { "unqualified_reason#{SecureRandom.hex}" }
 
 
     to_create do |deal_unqualified_reason|

data/spec/factories/lead.rb

@@ -1,8 +1,8 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :lead, class: BaseCRM::Lead do
 
     description { "I know him via Tom" }
-    email { "mark@designservices.com" }
+    email { "mark#{SecureRandom.hex}@example.com" }
     facebook { "mjohnson" }
     fax { "+44-208-1234567" }
     first_name { Faker::Name.first_name }
@@ -16,7 +16,7 @@ FactoryGirl.define do
     tags { ["important"] }
     title { "CEO" }
     twitter { "mjohnson" }
-    website { "www.designservices.com" }
+    website { "www.example.com" }
 
 
     to_create do |lead|

data/spec/factories/lead_source.rb

@@ -1,7 +1,7 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :lead_source, class: BaseCRM::LeadSource do
 
-    name { Faker::Name.name }
+    name { "source#{SecureRandom.hex}" }
 
 
     to_create do |lead_source|

data/spec/factories/line_item.rb

@@ -1,7 +1,7 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :line_item, class: BaseCRM::LineItem do
     # transient attributes, required in url
-    order_id nil
+    order_id { nil }
 
     product_id { 5 }
     value { 1599.99 }

data/spec/factories/loss_reason.rb

@@ -1,7 +1,7 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :loss_reason, class: BaseCRM::LossReason do
 
-    name { Faker::Name.name }
+    name { "loss_reason#{Time.now.to_i}" }
 
 
     to_create do |loss_reason|

data/spec/factories/note.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :note, class: BaseCRM::Note do
 
     content { "Highly important." }

data/spec/factories/order.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :order, class: BaseCRM::Order do
 
     deal_id { 5 }

data/spec/factories/product.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :product, class: BaseCRM::Product do
 
     name { Faker::Name.name }

data/spec/factories/source.rb

@@ -1,7 +1,7 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :source, class: BaseCRM::Source do
 
-    name { Faker::Name.name }
+    name { "source#{SecureRandom.hex}" }
 
 
     to_create do |source|

data/spec/factories/tag.rb

@@ -1,7 +1,7 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :tag, class: BaseCRM::Tag do
 
-    name { Faker::Name.name }
+    name { "tag#{SecureRandom.hex}" }
 
     resource_type { :contact }
 

data/spec/factories/task.rb

@@ -1,4 +1,4 @@
-FactoryGirl.define do
+FactoryBot.define do
   factory :task, class: BaseCRM::Task do
 
     content { "Contact Tom" }

data/spec/factories/text_message.rb

@@ -0,0 +1,7 @@
+FactoryBot.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

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
 require 'rspec/collection_matchers'
-require 'factory_girl'
+require 'factory_bot'
 require 'faker'
+require 'securerandom'
 
 require 'basecrm'
 
-module FactoryGirl
+module FactoryBot
   module Strategy
     class Create
       def result(evaluation)
@@ -15,10 +16,10 @@ module FactoryGirl
 end
 
 Dir[File.join(__dir__, "/support/**/*.rb")].each { |f| require f }
-FactoryGirl.find_definitions
+FactoryBot.find_definitions
 
 RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
+  config.include FactoryBot::Syntax::Methods
 
   config.expect_with :rspec do |expectations|
     # It makes the `description` and `failure_message` of custom matchers include text for helper methods

data/spec/support/client_helpers.rb

@@ -12,7 +12,7 @@ module ClientHelpers
   end
 
   def contact
-    @contact ||= FactoryGirl.create(:contact)
+    @contact ||= FactoryBot.create(:contact)
   end
 end
 
@@ -20,4 +20,4 @@ RSpec.configure do |config|
   include ClientHelpers
 end
 
-FactoryGirl::SyntaxRunner.send(:include, ClientHelpers)
+FactoryBot::SyntaxRunner.send(:include, ClientHelpers)

data/spec/utils/coercion.rb

@@ -5,7 +5,7 @@ describe BaseCRM::Coercion do
     it { expect(BaseCRM::Coercion.to_decimal_value(0)).to eql(0) }
     it { expect(BaseCRM::Coercion.to_decimal_value("0")).to eql(0) }
     it { expect(BaseCRM::Coercion.to_decimal_value(nil)).to eql(0) }
-    it { expect(BaseCRM::Coercion.to_decimal_value(1.1)).to eql(BigDecimal.new("1.1", 15)) }
-    it { expect(BaseCRM::Coercion.to_decimal_value("1.11")).to eql(BigDecimal.new("1.11", 15)) }
+    it { expect(BaseCRM::Coercion.to_decimal_value(1.1)).to eql(BigDecimal("1.1", 15)) }
+    it { expect(BaseCRM::Coercion.to_decimal_value("1.11")).to eql(BigDecimal("1.11", 15)) }
   end
 end

data/spec/utils/coercion_spec.rb

@@ -6,8 +6,8 @@ describe BaseCRM::Coercion do
     it { expect(BaseCRM::Coercion.to_decimal_value(0)).to eql(0) }
     it { expect(BaseCRM::Coercion.to_decimal_value("0")).to eql(0) }
     it { expect(BaseCRM::Coercion.to_decimal_value(nil)).to eql(0) }
-    it { expect(BaseCRM::Coercion.to_decimal_value(1.1)).to eql(BigDecimal.new("1.1", 15)) }
-    it { expect(BaseCRM::Coercion.to_decimal_value("1.11")).to eql(BigDecimal.new("1.11", 15)) }
+    it { expect(BaseCRM::Coercion.to_decimal_value(1.1)).to eql(BigDecimal("1.1", 15)) }
+    it { expect(BaseCRM::Coercion.to_decimal_value("1.11")).to eql(BigDecimal("1.11", 15)) }
   end
 
   describe "to_string" do

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: basecrm
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.9
 platform: ruby
 authors:
-- BaseCRM developers
+- Zendesk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -87,19 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '4.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.8'
+        version: '4.11'
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -114,9 +114,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description: BaseCRM Official API V2 library client for ruby
+description: Zendesk Sell Official API V2 library client for ruby
 email:
-- developers@getbase.com
+- opensource@zendesk.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -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,14 +235,17 @@ 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
 - spec/utils/coercion_spec.rb
-homepage: https://github.com/basecrm/basecrm-ruby
+homepage: https://github.com/zendesk/basecrm-ruby
 licenses:
-- MIT
+- Apache License Version 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -252,56 +262,59 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: BaseCRM Official API V2 library client for ruby
+summary: Zendesk Sell Official API V2 library client for ruby
 test_files:
-- spec/spec_helper.rb
-- spec/middlewares/raise_error_spec.rb
-- spec/utils/coercion_spec.rb
-- spec/utils/coercion.rb
-- spec/models/sync_meta_spec.rb
-- spec/support/client_helpers.rb
+- spec/factories/lead_source.rb
+- spec/factories/call.rb
 - spec/factories/note.rb
-- spec/factories/source.rb
 - spec/factories/tag.rb
+- spec/factories/associated_contact.rb
+- spec/factories/task.rb
+- spec/factories/lead.rb
+- spec/factories/product.rb
+- spec/factories/loss_reason.rb
+- spec/factories/source.rb
 - spec/factories/contact.rb
+- spec/factories/lead_unqualified_reason.rb
+- spec/factories/text_message.rb
+- spec/factories/order.rb
 - spec/factories/deal.rb
-- spec/factories/call.rb
-- spec/factories/product.rb
-- spec/factories/lead.rb
 - spec/factories/deal_unqualified_reason.rb
-- spec/factories/lead_unqualified_reason.rb
 - spec/factories/deal_source.rb
-- spec/factories/order.rb
-- spec/factories/lead_source.rb
-- spec/factories/associated_contact.rb
 - spec/factories/line_item.rb
-- spec/factories/loss_reason.rb
-- spec/factories/task.rb
 - spec/basecrm/sync_spec.rb
+- spec/support/client_helpers.rb
+- spec/utils/coercion_spec.rb
+- spec/utils/coercion.rb
+- spec/spec_helper.rb
+- spec/middlewares/raise_error_spec.rb
+- spec/services/deals_service_spec.rb
+- spec/services/sync_service_spec.rb
+- spec/services/loss_reasons_service_spec.rb
+- spec/services/stages_service_spec.rb
+- spec/services/products_service_spec.rb
+- spec/services/tasks_service_spec.rb
 - spec/services/notes_service_spec.rb
+- spec/services/lead_unqualified_reasons_service_spec.rb
+- spec/services/deal_sources_service_spec.rb
+- spec/services/visit_outcomes_service_spec.rb
 - spec/services/pipelines_service_spec.rb
 - spec/services/sources_service_spec.rb
-- spec/services/orders_service_spec.rb
-- spec/services/tasks_service_spec.rb
-- 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/tags_service_spec.rb
+- spec/services/contacts_service_spec.rb
 - spec/services/associated_contacts_service_spec.rb
-- spec/services/users_service_spec.rb
-- spec/services/leads_service_spec.rb
-- 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
+- spec/services/orders_service_spec.rb
+- spec/services/calls_service_spec.rb
+- spec/services/visits_service_spec.rb
+- spec/services/text_messages_service_spec.rb
 - spec/services/accounts_service_spec.rb
-- spec/services/contacts_service_spec.rb
-- spec/services/deals_service_spec.rb
+- spec/services/line_items_service_spec.rb
+- spec/services/call_outcomes_service_spec.rb
+- spec/services/users_service_spec.rb
+- spec/services/leads_service_spec.rb
+- spec/models/sync_meta_spec.rb