Sha256: 86a385d4273a69008003722be9966c83bc96f3ee733c14c4f19491eea74b5bcd

Contents?: true

Size: 1.14 KB

Versions: 11

Compression:

Stored size: 1.14 KB

Contents

module Hubspot
  module Helpers
    module GetAllHelper
      MAX_PAGE_SIZE = 100
      # List
      # Read all contacts. Control what is returned via the `properties` query param.
      # @param [Hash] opts the optional parameters
      # @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
      # @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
      # @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false)
      # @return Array
      def get_all(opts = {})
        after = nil
        objects = []
        opts[:limit] ||= MAX_PAGE_SIZE
        loop do
          page_opts = opts.merge(after: after)
          page = get_page(page_opts)
          objects.concat(page.results)
          break objects if page.paging.nil?

          after = page.paging._next.after
        end

      end
    end
  end
end

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
hubspot-api-client-19.0.0 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-18.0.0 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-17.2.0 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-17.1.1 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-17.1.0 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-17.0.0 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-17.0.0.pre.beta.4 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-17.0.0.pre.beta.3 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-17.0.0.pre.beta.2 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-17.0.0.pre.beta.1 lib/hubspot/helpers/get_all_helper.rb
hubspot-api-client-16.4.0 lib/hubspot/helpers/get_all_helper.rb