Class: TogaiClient::CreatePaymentRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/togai_client/models/create_payment_request.rb

Overview

payload to create payment

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePaymentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/togai_client/models/create_payment_request.rb', line 74

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



25
26
27
 
# File 'lib/togai_client/models/create_payment_request.rb', line 25

def 
  @account_id
end

#currency ⇒ Object

Returns the value of attribute currency.



31
32
33
 
# File 'lib/togai_client/models/create_payment_request.rb', line 31

def currency
  @currency
end

#description ⇒ Object

A brief description of the payment



20
21
22
 
# File 'lib/togai_client/models/create_payment_request.rb', line 20

def description
  @description
end

#external_payment_reference ⇒ Object

Returns the value of attribute external_payment_reference.



27
28
29
 
# File 'lib/togai_client/models/create_payment_request.rb', line 27

def external_payment_reference
  @external_payment_reference
end

#line_item_records ⇒ Object

Returns the value of attribute line_item_records.



29
30
31
 
# File 'lib/togai_client/models/create_payment_request.rb', line 29

def line_item_records
  @line_item_records
end

#notes ⇒ Object

A detailed note about the payment



23
24
25
 
# File 'lib/togai_client/models/create_payment_request.rb', line 23

def notes
  @notes
end

#total_amount ⇒ Object

Returns the value of attribute total_amount.



33
34
35
 
# File 'lib/togai_client/models/create_payment_request.rb', line 33

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/togai_client/models/create_payment_request.rb', line 307

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 = TogaiClient.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_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/togai_client/models/create_payment_request.rb', line 49

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/togai_client/models/create_payment_request.rb', line 36

def self.attribute_map
  {
    :'description' => :'description',
    :'notes' => :'notes',
    :'account_id' => :'accountId',
    :'external_payment_reference' => :'externalPaymentReference',
    :'line_item_records' => :'lineItemRecords',
    :'currency' => :'currency',
    :'total_amount' => :'totalAmount'
  }
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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/togai_client/models/create_payment_request.rb', line 283

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



67
68
69
70
 
# File 'lib/togai_client/models/create_payment_request.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/togai_client/models/create_payment_request.rb', line 54

def self.openapi_types
  {
    :'description' => :'String',
    :'notes' => :'String',
    :'account_id' => :'String',
    :'external_payment_reference' => :'ExternalPaymentReference',
    :'line_item_records' => :'Array<PaymentLineItemRecord>',
    :'currency' => :'String',
    :'total_amount' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/togai_client/models/create_payment_request.rb', line 256

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      notes == o.notes &&
       == o. &&
      external_payment_reference == o.external_payment_reference &&
      line_item_records == o.line_item_records &&
      currency == o.currency &&
      total_amount == o.total_amount
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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/togai_client/models/create_payment_request.rb', line 378

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


270
271
272
 
# File 'lib/togai_client/models/create_payment_request.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/togai_client/models/create_payment_request.rb', line 276

def hash
  [description, notes, , external_payment_reference, line_item_records, currency, total_amount].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



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
 
# File 'lib/togai_client/models/create_payment_request.rb', line 130

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

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

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

  if @account_id.to_s.length > 512
    invalid_properties.push('invalid value for "account_id", the character length must be smaller than or equal to 512.')
  end

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

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

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

  if @currency.to_s.length > 512
    invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 512.')
  end

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



354
355
356
 
# File 'lib/togai_client/models/create_payment_request.rb', line 354

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/togai_client/models/create_payment_request.rb', line 360

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



348
349
350
 
# File 'lib/togai_client/models/create_payment_request.rb', line 348

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



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/togai_client/models/create_payment_request.rb', line 174

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@description.nil? && @description.to_s.length > 512
  return false if !@notes.nil? && @notes.to_s.length > 512
  return false if @account_id.nil?
  return false if @account_id.to_s.length > 512
  return false if @external_payment_reference.nil?
  return false if @line_item_records.nil?
  return false if @currency.nil?
  return false if @currency.to_s.length > 512
  return false if @total_amount.nil?
  true
end