Class: BoxxLoki::RecommendationRequestData

Inherits:
Object
  • Object
show all
Defined in:
lib/boxx_loki/models/recommendation_request_data.rb

Overview

recommendation request data

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecommendationRequestData

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 61

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.has_key?(:'access_token')
    self.access_token = attributes[:'access_token']
  end

  if attributes.has_key?(:'channel_id')
    self.channel_id = attributes[:'channel_id']
  end

  if attributes.has_key?(:'widget_type')
    self.widget_type = attributes[:'widget_type']
  end

  if attributes.has_key?(:'widget_instance')
    self.widget_instance = attributes[:'widget_instance']
  end

  if attributes.has_key?(:'page_url')
    self.page_url = attributes[:'page_url']
  end

  if attributes.has_key?(:'query')
    self.query = attributes[:'query']
  end

end

Instance Attribute Details

#access_token ⇒ Object

Returns the value of attribute access_token.



20
21
22
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 20

def access_token
  @access_token
end

#channel_id ⇒ Object

Returns the value of attribute channel_id.



22
23
24
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 22

def channel_id
  @channel_id
end

#client_id ⇒ Object

Returns the value of attribute client_id.



18
19
20
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 18

def client_id
  @client_id
end

#page_url ⇒ Object

Returns the value of attribute page_url.



28
29
30
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 28

def page_url
  @page_url
end

#query ⇒ Object

Returns the value of attribute query.



30
31
32
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 30

def query
  @query
end

#widget_instance ⇒ Object

Returns the value of attribute widget_instance.



26
27
28
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 26

def widget_instance
  @widget_instance
end

#widget_type ⇒ Object

Returns the value of attribute widget_type.



24
25
26
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 24

def widget_type
  @widget_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 34

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'access_token' => :'access_token',
    :'channel_id' => :'channel_id',
    :'widget_type' => :'widget_type',
    :'widget_instance' => :'widget_instance',
    :'page_url' => :'page_url',
    :'query' => :'query'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 47

def self.swagger_types
  {
    :'client_id' => :'String',
    :'access_token' => :'String',
    :'channel_id' => :'String',
    :'widget_type' => :'String',
    :'widget_instance' => :'String',
    :'page_url' => :'String',
    :'query' => :'RecommendationRequestDataQuery'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 132

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      access_token == o.access_token &&
      channel_id == o.channel_id &&
      widget_type == o.widget_type &&
      widget_instance == o.widget_instance &&
      page_url == o.page_url &&
      query == o.query
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 180

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = BoxxLoki.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 246

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 159

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


146
147
148
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 146

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 152

def hash
  [client_id, access_token, channel_id, widget_type, widget_instance, page_url, query].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 99

def list_invalid_properties
  invalid_properties = Array.new
  if @client_id.nil?
    invalid_properties.push("invalid value for 'client_id', client_id cannot be nil.")
  end

  if @access_token.nil?
    invalid_properties.push("invalid value for 'access_token', access_token cannot be nil.")
  end

  if @channel_id.nil?
    invalid_properties.push("invalid value for 'channel_id', channel_id cannot be nil.")
  end

  if @query.nil?
    invalid_properties.push("invalid value for 'query', query cannot be nil.")
  end

  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 226

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 232

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



220
221
222
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 220

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



122
123
124
125
126
127
128
 
# File 'lib/boxx_loki/models/recommendation_request_data.rb', line 122

def valid?
  return false if @client_id.nil?
  return false if @access_token.nil?
  return false if @channel_id.nil?
  return false if @query.nil?
  return true
end