Class: Checkbook::Check

Inherits:
Object
  • Object
show all
Defined in:
lib/checkbook/models/check.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Check

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/checkbook/models/check.rb', line 133

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

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

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  else
    self.amount = nil
  end

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

  if attributes.key?(:'date')
    self.date = attributes[:'date']
  else
    self.date = nil
  end

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

  if attributes.key?(:'direction')
    self.direction = attributes[:'direction']
  else
    self.direction = nil
  end

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

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

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

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

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

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  else
    self.status = nil
  end
end

Instance Attribute Details

#amount ⇒ Object

Payment amount



19
20
21
 
# File 'lib/checkbook/models/check.rb', line 19

def amount
  @amount
end

#comment ⇒ Object

Payment comment



22
23
24
 
# File 'lib/checkbook/models/check.rb', line 22

def comment
  @comment
end

#date ⇒ Object

Payment creation timestamp



25
26
27
 
# File 'lib/checkbook/models/check.rb', line 25

def date
  @date
end

#description ⇒ Object

Payment description/memo



28
29
30
 
# File 'lib/checkbook/models/check.rb', line 28

def description
  @description
end

#direction ⇒ Object

Payment direction



31
32
33
 
# File 'lib/checkbook/models/check.rb', line 31

def direction
  @direction
end

#id ⇒ Object

Unique identifier for payment



34
35
36
 
# File 'lib/checkbook/models/check.rb', line 34

def id
  @id
end

#image_uri ⇒ Object

URI where image of the payment can be accessed



37
38
39
 
# File 'lib/checkbook/models/check.rb', line 37

def image_uri
  @image_uri
end

#name ⇒ Object

Name of third party who received the payment



40
41
42
 
# File 'lib/checkbook/models/check.rb', line 40

def name
  @name
end

#number ⇒ Object

Returns the value of attribute number.



42
43
44
 
# File 'lib/checkbook/models/check.rb', line 42

def number
  @number
end

#recipient ⇒ Object

Returns the value of attribute recipient.



44
45
46
 
# File 'lib/checkbook/models/check.rb', line 44

def recipient
  @recipient
end

#sender ⇒ Object

Email/id or physical address of the payment sender



47
48
49
 
# File 'lib/checkbook/models/check.rb', line 47

def sender
  @sender
end

#status ⇒ Object

Current status of the payment



50
51
52
 
# File 'lib/checkbook/models/check.rb', line 50

def status
  @status
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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/checkbook/models/check.rb', line 358

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 = ::Checkbook.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



93
94
95
 
# File 'lib/checkbook/models/check.rb', line 93

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/checkbook/models/check.rb', line 98

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/checkbook/models/check.rb', line 75

def self.attribute_map
  {
    :'amount' => :'amount',
    :'comment' => :'comment',
    :'date' => :'date',
    :'description' => :'description',
    :'direction' => :'direction',
    :'id' => :'id',
    :'image_uri' => :'image_uri',
    :'name' => :'name',
    :'number' => :'number',
    :'recipient' => :'recipient',
    :'sender' => :'sender',
    :'status' => :'status'
  }
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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/checkbook/models/check.rb', line 334

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



121
122
123
124
125
126
127
128
129
 
# File 'lib/checkbook/models/check.rb', line 121

def self.openapi_nullable
  Set.new([
    :'comment',
    :'description',
    :'image_uri',
    :'name',
    :'sender',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/checkbook/models/check.rb', line 103

def self.openapi_types
  {
    :'amount' => :'Float',
    :'comment' => :'String',
    :'date' => :'String',
    :'description' => :'String',
    :'direction' => :'String',
    :'id' => :'String',
    :'image_uri' => :'String',
    :'name' => :'String',
    :'number' => :'ApprovalNumber',
    :'recipient' => :'ApprovalRecipient',
    :'sender' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/checkbook/models/check.rb', line 302

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      comment == o.comment &&
      date == o.date &&
      description == o.description &&
      direction == o.direction &&
      id == o.id &&
      image_uri == o.image_uri &&
      name == o.name &&
      number == o.number &&
      recipient == o.recipient &&
      sender == o.sender &&
      status == o.status
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



429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/checkbook/models/check.rb', line 429

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


321
322
323
 
# File 'lib/checkbook/models/check.rb', line 321

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



327
328
329
 
# File 'lib/checkbook/models/check.rb', line 327

def hash
  [amount, comment, date, description, direction, id, image_uri, name, number, recipient, sender, status].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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/checkbook/models/check.rb', line 208

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

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

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

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

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  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



405
406
407
 
# File 'lib/checkbook/models/check.rb', line 405

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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/checkbook/models/check.rb', line 411

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



399
400
401
 
# File 'lib/checkbook/models/check.rb', line 399

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/checkbook/models/check.rb', line 236

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @amount.nil?
  return false if @date.nil?
  return false if @direction.nil?
  direction_validator = EnumAttributeValidator.new('String', ["INCOMING", "OUTGOING"])
  return false unless direction_validator.valid?(@direction)
  return false if @id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["PAID", "IN_PROCESS", "UNPAID", "VOID", "EXPIRED", "PRINTED", "MAILED", "FAILED", "REFUNDED"])
  return false unless status_validator.valid?(@status)
  true
end