Class: SuggestGrid::GetSimilarItemsBody

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

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, item_id = nil, item_ids = nil, from = nil, size = nil, fields = nil, filter = nil, except = nil) ⇒ GetSimilarItemsBody

Returns a new instance of GetSimilarItemsBody.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 59

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

Instance Attribute Details

#except ⇒ List of String

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

Returns:



40
41
42
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 40

def except
  @except
end

#fields ⇒ List of String

The metadata fields to be included in returned item objects.

Returns:



31
32
33
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 31

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-parameter).

Returns:



36
37
38
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 36

def filter
  @filter
end

#from ⇒ Integer

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

Returns:

  • (Integer) 


23
24
25
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 23

def from
  @from
end

#item_id ⇒ String

The item id of the query. Get similar items to given item id. Either item id or item ids must be provided.

Returns:



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

def item_id
  @item_id
end

#item_ids ⇒ List of String

The item ids of the query. Exactly one of item id or item ids parameters must be provided. Get similar items to given item ids. Either item id or item ids must be provided.

Returns:



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

def item_ids
  @item_ids
end

#size ⇒ Integer

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

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 27

def size
  @size
end

#type ⇒ String

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

Returns:



7
8
9
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 7

def type
  @type
end

#types ⇒ List of String

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

Returns:



11
12
13
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 11

def types
  @types
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 80

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash
  type = hash['type']
  types = hash['types']
  item_id = hash['item_id']
  item_ids = hash['item_ids']
  from = hash['from']
  size = hash['size']
  fields = hash['fields']
  filter = hash['filter']
  except = hash['except']

  # Create object from extracted values
  GetSimilarItemsBody.new(type,
                          types,
                          item_id,
                          item_ids,
                          from,
                          size,
                          fields,
                          filter,
                          except)
end

.names ⇒ Object

A mapping from model property names to API property names



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/suggestgrid/models/get_similar_items_body.rb', line 43

def self.names
  if @_hash.nil?
    @_hash = {}
    @_hash["type"] = "type"
    @_hash["types"] = "types"
    @_hash["item_id"] = "item_id"
    @_hash["item_ids"] = "item_ids"
    @_hash["from"] = "from"
    @_hash["size"] = "size"
    @_hash["fields"] = "fields"
    @_hash["filter"] = "filter"
    @_hash["except"] = "except"
  end
  @_hash
end