Class: PCPServerSDK::StatusOutput

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/status_output.rb

Overview

Contains information about whether the payment of the Checkout has already been completed and how much of the total sum has been collected already.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StatusOutput

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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
133
134
135
136
137
138
139
140
141
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 101

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

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

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

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

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

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

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

Instance Attribute Details

#cancelled_amount ⇒ Object

Amount in cents always having 2 decimals. The amount that has already been cancelled.



32
33
34
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 32

def cancelled_amount
  @cancelled_amount
end

#chargeback_amount ⇒ Object

Amount in cents always having 2 decimals. Amount that has been collected but was charged back by the customer.



38
39
40
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 38

def chargeback_amount
  @chargeback_amount
end

#collected_amount ⇒ Object

Amount in cents always having 2 decimals. The amount that has already been collected.



29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 29

def collected_amount
  @collected_amount
end

#is_modifiable ⇒ Object

Indicates whether the Checkout can still be modified. False if any payment is already in progress, true otherwise.



23
24
25
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 23

def is_modifiable
  @is_modifiable
end

#open_amount ⇒ Object

Amount in cents always having 2 decimals. The amount yet to be paid.



26
27
28
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 26

def open_amount
  @open_amount
end

#payment_status ⇒ Object

  • WAITING_FOR_PAYMENT - There does not yet exist a PaymentExecution nor a PaymentInformation for this Checkout. * PAYMENT_NOT_COMPLETED - There exists a PaymentExecution or a PaymentInformation for this Checkout, but all or some part of the total amount is still unpaid. * PAYMENT_COMPLETED - There exists a PaymentExecution or a PaymentInformation for this Checkout and the total amount is fully paid. * NO_PAYMENT - Checkout was created and deleted. No Payment Execution and no other actions can be triggered on the Checkout.



20
21
22
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 20

def payment_status
  @payment_status
end

#refunded_amount ⇒ Object

Amount in cents always having 2 decimals. Amount that has been collected but was refunded to the customer.



35
36
37
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 35

def refunded_amount
  @refunded_amount
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



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
396
397
398
399
400
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 363

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



76
77
78
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 63

def self.attribute_map
  {
    :'payment_status' => :'paymentStatus',
    :'is_modifiable' => :'isModifiable',
    :'open_amount' => :'openAmount',
    :'collected_amount' => :'collectedAmount',
    :'cancelled_amount' => :'cancelledAmount',
    :'refunded_amount' => :'refundedAmount',
    :'chargeback_amount' => :'chargebackAmount'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 339

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



94
95
96
97
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 81

def self.openapi_types
  {
    :'payment_status' => :'String',
    :'is_modifiable' => :'Boolean',
    :'open_amount' => :'Integer',
    :'collected_amount' => :'Integer',
    :'cancelled_amount' => :'Integer',
    :'refunded_amount' => :'Integer',
    :'chargeback_amount' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 312

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payment_status == o.payment_status &&
      is_modifiable == o.is_modifiable &&
      open_amount == o.open_amount &&
      collected_amount == o.collected_amount &&
      cancelled_amount == o.cancelled_amount &&
      refunded_amount == o.refunded_amount &&
      chargeback_amount == o.chargeback_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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 434

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:

  • to be compared

Returns:

See Also:

  • `==` method


326
327
328
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 326

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • Hash code



332
333
334
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 332

def hash
  [payment_status, is_modifiable, open_amount, collected_amount, cancelled_amount, refunded_amount, chargeback_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



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
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 145

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

  if !@open_amount.nil? && @open_amount < 0
    invalid_properties.push('invalid value for "open_amount", must be greater than or equal to 0.')
  end

  if !@collected_amount.nil? && @collected_amount > 999999999999
    invalid_properties.push('invalid value for "collected_amount", must be smaller than or equal to 999999999999.')
  end

  if !@collected_amount.nil? && @collected_amount < 0
    invalid_properties.push('invalid value for "collected_amount", must be greater than or equal to 0.')
  end

  if !@cancelled_amount.nil? && @cancelled_amount > 999999999999
    invalid_properties.push('invalid value for "cancelled_amount", must be smaller than or equal to 999999999999.')
  end

  if !@cancelled_amount.nil? && @cancelled_amount < 0
    invalid_properties.push('invalid value for "cancelled_amount", must be greater than or equal to 0.')
  end

  if !@refunded_amount.nil? && @refunded_amount > 999999999999
    invalid_properties.push('invalid value for "refunded_amount", must be smaller than or equal to 999999999999.')
  end

  if !@refunded_amount.nil? && @refunded_amount < 0
    invalid_properties.push('invalid value for "refunded_amount", must be greater than or equal to 0.')
  end

  if !@chargeback_amount.nil? && @chargeback_amount > 999999999999
    invalid_properties.push('invalid value for "chargeback_amount", must be smaller than or equal to 999999999999.')
  end

  if !@chargeback_amount.nil? && @chargeback_amount < 0
    invalid_properties.push('invalid value for "chargeback_amount", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • Returns the object in the form of hash



410
411
412
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 410

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 416

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 presentation of the object



404
405
406
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 404

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • true if the model is valid



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 193

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  payment_status_validator = EnumAttributeValidator.new('String', ["WAITING_FOR_PAYMENT", "PAYMENT_NOT_COMPLETED", "PAYMENT_COMPLETED", "NO_PAYMENT"])
  return false unless payment_status_validator.valid?(@payment_status)
  return false if !@open_amount.nil? && @open_amount > 999999999999
  return false if !@open_amount.nil? && @open_amount < 0
  return false if !@collected_amount.nil? && @collected_amount > 999999999999
  return false if !@collected_amount.nil? && @collected_amount < 0
  return false if !@cancelled_amount.nil? && @cancelled_amount > 999999999999
  return false if !@cancelled_amount.nil? && @cancelled_amount < 0
  return false if !@refunded_amount.nil? && @refunded_amount > 999999999999
  return false if !@refunded_amount.nil? && @refunded_amount < 0
  return false if !@chargeback_amount.nil? && @chargeback_amount > 999999999999
  return false if !@chargeback_amount.nil? && @chargeback_amount < 0
  true
end