Class: KoronaEntryClient::TicketEntry

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

Overview

Represents a validity/definition of a ticket. each ticket can have more than one validity.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TicketEntry

Initializes the object

Parameters:

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

    Model attributes in the form of hash



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#create_dateObject

Date of creation.



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

def create_date
  @create_date
end

#entry_gatesObject

Number of access points to which this validity applies.



58
59
60
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 58

def entry_gates
  @entry_gates
end

#first_useObject

Date of first use.



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

def first_use
  @first_use
end

#idObject

Objects ID.



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

def id
  @id
end

#informationObject

Returns the value of attribute information.



60
61
62
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 60

def information
  @information
end

#last_exitObject

Date of last exiting.



34
35
36
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 34

def last_exit
  @last_exit
end

#last_useObject

Date of last use (not exiting).



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

def last_use
  @last_use
end

#lock_after_useObject

Specifies the number of days after which the ticket is locked from the first use.



55
56
57
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 55

def lock_after_use
  @lock_after_use
end

#lock_for_period_after_useObject

Specifies a time period after which the ticket is locked from the first use. The standard ISO 8601 format is used - PyYmMwWdDThHmMsS. Note that weeks should not be shown if any other field is present and vice versa.



69
70
71
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 69

def lock_for_period_after_use
  @lock_for_period_after_use
end

#locked_toObject

Date until which the ticketEntry is locked.



63
64
65
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 63

def locked_to
  @locked_to
end

#re_entry_lockObject

Specifies how many seconds the ticket should be locked after a successful entry.



66
67
68
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 66

def re_entry_lock
  @re_entry_lock
end

#used_upObject

True, if the ticket is used up.



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

def used_up
  @used_up
end

#usesObject

Number of entries already made.



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

def uses
  @uses
end

#uses_maxObject

Optional maximum number of possible entries.



40
41
42
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 40

def uses_max
  @uses_max
end

#valid_fromObject

When the ticket becomes valid.



43
44
45
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 43

def valid_from
  @valid_from
end

#valid_from_timeObject

Time from which the ticket becomes valid within a day. Format: HH:ii:ss



49
50
51
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 49

def valid_from_time
  @valid_from_time
end

#valid_toObject

Optional fixed date until which the ticket is valid.



46
47
48
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 46

def valid_to
  @valid_to
end

#valid_to_timeObject

Time until which the ticket becomes valid within a day. Format: HH:ii:ss



52
53
54
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 52

def valid_to_time
  @valid_to_time
end

Class Method Details

.attribute_mapObject

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 72

def self.attribute_map
  {
    :'id' => :'id',
    :'create_date' => :'createDate',
    :'used_up' => :'usedUp',
    :'first_use' => :'firstUse',
    :'last_use' => :'lastUse',
    :'last_exit' => :'lastExit',
    :'uses' => :'uses',
    :'uses_max' => :'usesMax',
    :'valid_from' => :'validFrom',
    :'valid_to' => :'validTo',
    :'valid_from_time' => :'validFromTime',
    :'valid_to_time' => :'validToTime',
    :'lock_after_use' => :'lockAfterUse',
    :'entry_gates' => :'entryGates',
    :'information' => :'information',
    :'locked_to' => :'lockedTo',
    :'re_entry_lock' => :'reEntryLock',
    :'lock_for_period_after_use' => :'lockForPeriodAfterUse'
  }
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



302
303
304
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 302

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

.openapi_nullableObject

List of attributes with nullable: true



120
121
122
123
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 120

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

.openapi_typesObject

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 96

def self.openapi_types
  {
    :'id' => :'Integer',
    :'create_date' => :'DateTime',
    :'used_up' => :'Boolean',
    :'first_use' => :'DateTime',
    :'last_use' => :'DateTime',
    :'last_exit' => :'DateTime',
    :'uses' => :'Integer',
    :'uses_max' => :'Integer',
    :'valid_from' => :'DateTime',
    :'valid_to' => :'DateTime',
    :'valid_from_time' => :'String',
    :'valid_to_time' => :'String',
    :'lock_after_use' => :'Integer',
    :'entry_gates' => :'Array<String>',
    :'information' => :'TicketInformation',
    :'locked_to' => :'DateTime',
    :'re_entry_lock' => :'Integer',
    :'lock_for_period_after_use' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      create_date == o.create_date &&
      used_up == o.used_up &&
      first_use == o.first_use &&
      last_use == o.last_use &&
      last_exit == o.last_exit &&
      uses == o.uses &&
      uses_max == o.uses_max &&
      valid_from == o.valid_from &&
      valid_to == o.valid_to &&
      valid_from_time == o.valid_from_time &&
      valid_to_time == o.valid_to_time &&
      lock_after_use == o.lock_after_use &&
      entry_gates == o.entry_gates &&
      information == o.information &&
      locked_to == o.locked_to &&
      re_entry_lock == o.re_entry_lock &&
      lock_for_period_after_use == o.lock_for_period_after_use
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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 330

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
    KoronaEntryClient.const_get(type).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



399
400
401
402
403
404
405
406
407
408
409
410
411
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 399

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 309

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # 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


289
290
291
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 289

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



295
296
297
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 295

def hash
  [id, create_date, used_up, first_use, last_use, last_exit, uses, uses_max, valid_from, valid_to, valid_from_time, valid_to_time, lock_after_use, entry_gates, information, locked_to, re_entry_lock, lock_for_period_after_use].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 217

def list_invalid_properties
  invalid_properties = Array.new
  pattern = Regexp.new(/^([0-1]\d|2[0-3])\:[0-5]\d\:[0-5]\d$/)
  if !@valid_from_time.nil? && @valid_from_time !~ pattern
    invalid_properties.push("invalid value for \"valid_from_time\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^([0-1]\d|2[0-3])\:[0-5]\d\:[0-5]\d$/)
  if !@valid_to_time.nil? && @valid_to_time !~ pattern
    invalid_properties.push("invalid value for \"valid_to_time\", must conform to the pattern #{pattern}.")
  end

  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



375
376
377
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 375

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



381
382
383
384
385
386
387
388
389
390
391
392
393
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 381

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



369
370
371
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 369

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



234
235
236
237
238
# File 'lib/korona-entry-client/models/ticket_entry.rb', line 234

def valid?
  return false if !@valid_from_time.nil? && @valid_from_time !~ Regexp.new(/^([0-1]\d|2[0-3])\:[0-5]\d\:[0-5]\d$/)
  return false if !@valid_to_time.nil? && @valid_to_time !~ Regexp.new(/^([0-1]\d|2[0-3])\:[0-5]\d\:[0-5]\d$/)
  true
end