Class: PCPServerSDK::Models::StatusOutput

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

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:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `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 `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.



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

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.



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

def chargeback_amount
  @chargeback_amount
end

#collected_amount ⇒ Object

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



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

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.



13
14
15
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 13

def is_modifiable
  @is_modifiable
end

#open_amount ⇒ Object

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



16
17
18
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 16

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.



10
11
12
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 10

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.



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

def refunded_amount
  @refunded_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



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
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 188

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::Models.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



68
69
70
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 68

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 55

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:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 164

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



86
87
88
89
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 73

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:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 137

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:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 259

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


151
152
153
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



157
158
159
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 157

def hash
  [payment_status, is_modifiable, open_amount, collected_amount, cancelled_amount, refunded_amount, chargeback_amount].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



235
236
237
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 235

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 241

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



229
230
231
 
# File 'lib/PCP-server-Ruby-SDK/models/status_output.rb', line 229

def to_s
  to_hash.to_s
end