Class: Kendama::ResponseBody

Inherits:
Object
  • Object
show all
Defined in:
lib/kendama/models/response_body.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponseBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
96
97
98
99
100
101
 
# File 'lib/kendama/models/response_body.rb', line 67

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Kendama::ResponseBody` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Kendama::ResponseBody`. 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
  }

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

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

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

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

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

Instance Attribute Details

#announcement ⇒ Object

Returns the value of attribute announcement.



30
31
32
 
# File 'lib/kendama/models/response_body.rb', line 30

def announcement
  @announcement
end

#count ⇒ Object

総件数



22
23
24
 
# File 'lib/kendama/models/response_body.rb', line 22

def count
  @count
end

#divide_number ⇒ Object

分割番号



25
26
27
 
# File 'lib/kendama/models/response_body.rb', line 25

def divide_number
  @divide_number
end

#divide_size ⇒ Object

分割数



28
29
30
 
# File 'lib/kendama/models/response_body.rb', line 28

def divide_size
  @divide_size
end

#last_update_date ⇒ Object

最終更新年月日



19
20
21
 
# File 'lib/kendama/models/response_body.rb', line 19

def last_update_date
  @last_update_date
end

Class Method Details

._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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/kendama/models/response_body.rb', line 253

def self._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 = Kendama.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



44
45
46
 
# File 'lib/kendama/models/response_body.rb', line 44

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/kendama/models/response_body.rb', line 33

def self.attribute_map
  {
    :'last_update_date' => :'lastUpdateDate',
    :'count' => :'count',
    :'divide_number' => :'divideNumber',
    :'divide_size' => :'divideSize',
    :'announcement' => :'announcement'
  }
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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/kendama/models/response_body.rb', line 229

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



60
61
62
63
 
# File 'lib/kendama/models/response_body.rb', line 60

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

.openapi_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
 
# File 'lib/kendama/models/response_body.rb', line 49

def self.openapi_types
  {
    :'last_update_date' => :'Date',
    :'count' => :'String',
    :'divide_number' => :'String',
    :'divide_size' => :'String',
    :'announcement' => :'Array<Announcement>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



204
205
206
207
208
209
210
211
212
 
# File 'lib/kendama/models/response_body.rb', line 204

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      last_update_date == o.last_update_date &&
      count == o.count &&
      divide_number == o.divide_number &&
      divide_size == o.divide_size &&
      announcement == o.announcement
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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/kendama/models/response_body.rb', line 324

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


216
217
218
 
# File 'lib/kendama/models/response_body.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



222
223
224
 
# File 'lib/kendama/models/response_body.rb', line 222

def hash
  [last_update_date, count, divide_number, divide_size, announcement].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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/kendama/models/response_body.rb', line 105

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@count.nil? && @count.to_s.length > 8
    invalid_properties.push('invalid value for "count", the character length must be smaller than or equal to 8.')
  end

  if !@count.nil? && @count.to_s.length < 1
    invalid_properties.push('invalid value for "count", the character length must be great than or equal to 1.')
  end

  if !@divide_number.nil? && @divide_number.to_s.length > 6
    invalid_properties.push('invalid value for "divide_number", the character length must be smaller than or equal to 6.')
  end

  if !@divide_number.nil? && @divide_number.to_s.length < 1
    invalid_properties.push('invalid value for "divide_number", the character length must be great than or equal to 1.')
  end

  if !@divide_size.nil? && @divide_size.to_s.length > 6
    invalid_properties.push('invalid value for "divide_size", the character length must be smaller than or equal to 6.')
  end

  if !@divide_size.nil? && @divide_size.to_s.length < 1
    invalid_properties.push('invalid value for "divide_size", the character length must be great than or equal to 1.')
  end

  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



300
301
302
 
# File 'lib/kendama/models/response_body.rb', line 300

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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/kendama/models/response_body.rb', line 306

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



294
295
296
 
# File 'lib/kendama/models/response_body.rb', line 294

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



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/kendama/models/response_body.rb', line 137

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@count.nil? && @count.to_s.length > 8
  return false if !@count.nil? && @count.to_s.length < 1
  return false if !@divide_number.nil? && @divide_number.to_s.length > 6
  return false if !@divide_number.nil? && @divide_number.to_s.length < 1
  return false if !@divide_size.nil? && @divide_size.to_s.length > 6
  return false if !@divide_size.nil? && @divide_size.to_s.length < 1
  true
end