class RecombeeApiClient::ListUsers
Gets a list of IDs of users currently present in the catalog.
Attributes
Public Class Methods
Source
# File lib/recombee_api_client/api/list_users.rb, line 57 def initialize(optional = {}) optional = normalize_optional(optional) @filter = optional['filter'] @count = optional['count'] @offset = optional['offset'] @return_properties = optional['returnProperties'] @included_properties = optional['includedProperties'] @optional = optional @timeout = 100000 @ensure_https = false @optional.each do |par, _| fail UnknownOptionalParameter.new(par) unless ["filter","count","offset","returnProperties","includedProperties"].include? par end end
* *Optional arguments (given as hash optional)* - +filter+ -> Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter users to be listed. Only the users for which the expression is *true* will be returned. - +count+ -> The number of users to be listed. - +offset+ -> Specifies the number of users to skip (ordered by `userId`). - +returnProperties+ -> With `returnProperties=true`, property values of the listed users are returned along with their IDs in a JSON dictionary.
Example response: “‘
[ { "userId": "user-81", "country": "US", "sex": "M" }, { "userId": "user-314", "country": "CAN", "sex": "F" } ]
“‘
- +includedProperties+ -> Allows specifying which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list.
Example response for ‘includedProperties=country`: “`
[ { "userId": "user-81", "country": "US" }, { "userId": "user-314", "country": "CAN" } ]
“‘
Public Instance Methods
Source
# File lib/recombee_api_client/api/list_users.rb, line 78 def body_parameters p = Hash.new p end
Values of body parameters as a Hash
Source
# File lib/recombee_api_client/api/list_users.rb, line 73 def method :get end
HTTP method
Source
# File lib/recombee_api_client/api/list_users.rb, line 96 def path "/{databaseId}/users/list/" end
Relative path to the endpoint
Source
# File lib/recombee_api_client/api/list_users.rb, line 85 def query_parameters params = {} params['filter'] = @optional['filter'] if @optional['filter'] params['count'] = @optional['count'] if @optional['count'] params['offset'] = @optional['offset'] if @optional['offset'] params['returnProperties'] = @optional['returnProperties'] if @optional['returnProperties'] params['includedProperties'] = @optional['includedProperties'] if @optional['includedProperties'] params end
Values of query parameters as a Hash. name of parameter => value of the parameter