Class: KoronaCloudClient::EndOfDayStatement

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-client/models/end_of_day_statement.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndOfDayStatement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 84

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `KoronaCloudClient::EndOfDayStatement` 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 `KoronaCloudClient::EndOfDayStatement`. 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?(:'active')
    self.active = attributes[:'active']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#activeObject

indicates whether the object is active for use or not



19
20
21
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 19

def active
  @active
end

#finish_timeObject

Format: yyyy-MM-dd’T’HH:mm:ssXXX



31
32
33
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 31

def finish_time
  @finish_time
end

#idObject

global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)



22
23
24
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 22

def id
  @id
end

#numberObject

number of the object, like it is set in backoffice; will be removed when active=false



28
29
30
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 28

def number
  @number
end

#receipt_countObject

Returns the value of attribute receipt_count.



33
34
35
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 33

def receipt_count
  @receipt_count
end

#revisionObject

the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers.



25
26
27
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 25

def revision
  @revision
end

#successfully_checkedObject

Returns the value of attribute successfully_checked.



35
36
37
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 35

def successfully_checked
  @successfully_checked
end

#summariesObject

Returns the value of attribute summaries.



37
38
39
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 37

def summaries
  @summaries
end

#z_countObject

Returns the value of attribute z_count.



39
40
41
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 39

def z_count
  @z_count
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



57
58
59
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 42

def self.attribute_map
  {
    :'active' => :'active',
    :'id' => :'id',
    :'revision' => :'revision',
    :'number' => :'number',
    :'finish_time' => :'finishTime',
    :'receipt_count' => :'receiptCount',
    :'successfully_checked' => :'successfullyChecked',
    :'summaries' => :'summaries',
    :'z_count' => :'zCount'
  }
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



178
179
180
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 178

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

.openapi_nullableObject

List of attributes with nullable: true



77
78
79
80
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 77

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

.openapi_typesObject

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 62

def self.openapi_types
  {
    :'active' => :'Boolean',
    :'id' => :'String',
    :'revision' => :'Integer',
    :'number' => :'String',
    :'finish_time' => :'Time',
    :'receipt_count' => :'Integer',
    :'successfully_checked' => :'Boolean',
    :'summaries' => :'EndOfDayStatementSummary',
    :'z_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



149
150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      id == o.id &&
      revision == o.revision &&
      number == o.number &&
      finish_time == o.finish_time &&
      receipt_count == o.receipt_count &&
      successfully_checked == o.successfully_checked &&
      summaries == o.summaries &&
      z_count == o.z_count
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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 209

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 = KoronaCloudClient.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



280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 280

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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 185

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.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)
        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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


165
166
167
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 165

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



171
172
173
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 171

def hash
  [active, id, revision, number, finish_time, receipt_count, successfully_checked, summaries, z_count].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



136
137
138
139
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



256
257
258
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 256

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 262

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



250
251
252
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 250

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



143
144
145
# File 'lib/korona-cloud-client/models/end_of_day_statement.rb', line 143

def valid?
  true
end