Class: SuggestGrid::GetSimilarUsersBody

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/suggestgrid/models/get_similar_users_body.rb

Overview

Query for similar users.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(type = nil, types = nil, user_id = nil, user_ids = nil, from = nil, size = nil, fields = nil, filter = nil, except = nil) ⇒ GetSimilarUsersBody

Returns a new instance of GetSimilarUsersBody.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 66

def initialize(type = nil,
               types = nil,
               user_id = nil,
               user_ids = nil,
               from = nil,
               size = nil,
               fields = nil,
               filter = nil,
               except = nil)
  @type = type
  @types = types
  @user_id = user_id
  @user_ids = user_ids
  @from = from
  @size = size
  @fields = fields
  @filter = filter
  @except = except
end

Instance Attribute Details

#except ⇒ List of String

These user ids that will not be included in the response.

Returns:



49
50
51
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 49

def except
  @except
end

#fields ⇒ List of String

The metadata fields to be included in returned user objects.

Returns:



38
39
40
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 38

def fields
  @fields
end

#filter ⇒ Array<String, Boolean>

Contraints on the returned users or items. Filter structure is defined in [the filter parameter documentation](www.suggestgrid.com/docs/advanced-features#filters-p arameter).

Returns:



45
46
47
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 45

def filter
  @filter
end

#from ⇒ Integer

The number of most similar users to be skipped from the response. Defaults to 0.

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 29

def from
  @from
end

#size ⇒ Integer

The number of users requested. Defaults to 10. Must be between 1 and 10,000 inclusive.

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 34

def size
  @size
end

#type ⇒ String

The type of the query. Similarities will be calculated based on actions of this type.

Returns:



10
11
12
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 10

def type
  @type
end

#types ⇒ List of String

The types of the query. Exactly one of type or types parameters must be provided.

Returns:



15
16
17
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 15

def types
  @types
end

#user_id ⇒ String

The user id of the query.

Returns:



19
20
21
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 19

def user_id
  @user_id
end

#user_ids ⇒ List of String

The user ids of the query. Exactly one of user id or user ids parameters must be provided.

Returns:



24
25
26
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 24

def user_ids
  @user_ids
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 87

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  type = hash['type']
  types = hash['types']
  user_id = hash['user_id']
  user_ids = hash['user_ids']
  from = hash['from']
  size = hash['size']
  fields = hash['fields']
  filter = hash['filter']
  except = hash['except']

  # Create object from extracted values.
  GetSimilarUsersBody.new(type,
                          types,
                          user_id,
                          user_ids,
                          from,
                          size,
                          fields,
                          filter,
                          except)
end

.names ⇒ Object

A mapping from model property names to API property names.



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/suggestgrid/models/get_similar_users_body.rb', line 52

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['type'] = 'type'
  @_hash['types'] = 'types'
  @_hash['user_id'] = 'user_id'
  @_hash['user_ids'] = 'user_ids'
  @_hash['from'] = 'from'
  @_hash['size'] = 'size'
  @_hash['fields'] = 'fields'
  @_hash['filter'] = 'filter'
  @_hash['except'] = 'except'
  @_hash
end