Class: Kuapir::FilmSearchResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/kuapir/models/film_search_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilmSearchResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/kuapir/models/film_search_response.rb', line 42

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          "The input argument (attributes) must be a hash in `Kuapir::FilmSearchResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `Kuapir::FilmSearchResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end

    h[k.to_sym] = v
  end

  self.keyword = attributes[:keyword] if attributes.key?(:keyword)

  self.pages_count = attributes[:pages_count] if attributes.key?(:pages_count)

  if attributes.key?(:search_films_count_result)
    self.search_films_count_result = attributes[:search_films_count_result]
  end

  if attributes.key?(:films) && (value = attributes[:films]).is_a?(Array)
    self.films = value
  end
end

Instance Attribute Details

#films ⇒ Object

Returns the value of attribute films.



8
9
10
 
# File 'lib/kuapir/models/film_search_response.rb', line 8

def films
  @films
end

#keyword ⇒ Object

Returns the value of attribute keyword.



8
9
10
 
# File 'lib/kuapir/models/film_search_response.rb', line 8

def keyword
  @keyword
end

#pages_count ⇒ Object

Returns the value of attribute pages_count.



8
9
10
 
# File 'lib/kuapir/models/film_search_response.rb', line 8

def pages_count
  @pages_count
end

#search_films_count_result ⇒ Object

Returns the value of attribute search_films_count_result.



8
9
10
 
# File 'lib/kuapir/models/film_search_response.rb', line 8

def search_films_count_result
  @search_films_count_result
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



21
22
23
 
# File 'lib/kuapir/models/film_search_response.rb', line 21

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



11
12
13
14
15
16
17
18
 
# File 'lib/kuapir/models/film_search_response.rb', line 11

def self.attribute_map
  {
    'keyword':                   :keyword,
    'pages_count':               :pagesCount,
    'search_films_count_result': :searchFilmsCountResult,
    'films':                     :films
  }
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



126
127
128
 
# File 'lib/kuapir/models/film_search_response.rb', line 126

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



36
37
38
 
# File 'lib/kuapir/models/film_search_response.rb', line 36

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



26
27
28
29
30
31
32
33
 
# File 'lib/kuapir/models/film_search_response.rb', line 26

def self.openapi_types
  {
    'keyword':                   :String,
    'pages_count':               :Integer,
    'search_films_count_result': :Integer,
    'films':                     :'Array<FilmSearchResponseFilms>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



101
102
103
104
105
106
107
108
109
 
# File 'lib/kuapir/models/film_search_response.rb', line 101

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    keyword == other.keyword &&
    pages_count == other.pages_count &&
    search_films_count_result == other.search_films_count_result &&
    films == other.films
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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/kuapir/models/film_search_response.rb', line 159

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Kuapir.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/kuapir/models/film_search_response.rb', line 230

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/kuapir/models/film_search_response.rb', line 133

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


113
114
115
 
# File 'lib/kuapir/models/film_search_response.rb', line 113

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



119
120
121
 
# File 'lib/kuapir/models/film_search_response.rb', line 119

def hash
  [keyword, pages_count, search_films_count_result, films].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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/kuapir/models/film_search_response.rb', line 73

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "keyword", keyword cannot be nil.') if @keyword.nil?

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

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

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

  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



206
207
208
 
# File 'lib/kuapir/models/film_search_response.rb', line 206

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



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/kuapir/models/film_search_response.rb', line 212

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



200
201
202
 
# File 'lib/kuapir/models/film_search_response.rb', line 200

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



90
91
92
93
94
95
96
97
 
# File 'lib/kuapir/models/film_search_response.rb', line 90

def valid?
  return false if @keyword.nil?
  return false if @pages_count.nil?
  return false if @search_films_count_result.nil?
  return false if @films.nil?

  true
end