Class: PostfinancecheckoutRubySdk::Charge

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/charge.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Charge

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
214
215
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 146

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_on ⇒ Object

The date and time when the object was created.



46
47
48
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 46

def created_on
  @created_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



57
58
59
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 57

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



60
61
62
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 60

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



35
36
37
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 35

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



52
53
54
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 52

def linked_space_id
  @linked_space_id
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



29
30
31
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 29

def planned_purge_date
  @planned_purge_date
end

#space_view_id ⇒ Object

The ID of the space view this object is linked to.



38
39
40
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 38

def space_view_id
  @space_view_id
end

#state ⇒ Object

Returns the value of attribute state.



62
63
64
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 62

def state
  @state
end

#time_zone ⇒ Object

The time zone that this object is associated with.



32
33
34
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 32

def time_zone
  @time_zone
end

#timeout_on ⇒ Object

The date and time when the charge will expire.



55
56
57
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 55

def timeout_on
  @timeout_on
end

#transaction ⇒ Object

Returns the value of attribute transaction.



64
65
66
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 64

def transaction
  @transaction
end

#type ⇒ Object

Returns the value of attribute type.



40
41
42
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 40

def type
  @type
end

#user_failure_message ⇒ Object

The message that can be displayed to the customer explaining why the charge failed, in the customer’s language.



43
44
45
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 43

def user_failure_message
  @user_failure_message
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



49
50
51
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 49

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 292

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



109
110
111
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 109

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



114
115
116
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 114

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 89

def self.attribute_map
  {
    :'planned_purge_date' => :'plannedPurgeDate',
    :'time_zone' => :'timeZone',
    :'language' => :'language',
    :'space_view_id' => :'spaceViewId',
    :'type' => :'type',
    :'user_failure_message' => :'userFailureMessage',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'linked_space_id' => :'linkedSpaceId',
    :'timeout_on' => :'timeoutOn',
    :'failure_reason' => :'failureReason',
    :'id' => :'id',
    :'state' => :'state',
    :'transaction' => :'transaction'
  }
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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 268

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



139
140
141
142
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 139

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

.openapi_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 119

def self.openapi_types
  {
    :'planned_purge_date' => :'Time',
    :'time_zone' => :'String',
    :'language' => :'String',
    :'space_view_id' => :'Integer',
    :'type' => :'ChargeType',
    :'user_failure_message' => :'String',
    :'created_on' => :'Time',
    :'version' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'timeout_on' => :'Time',
    :'failure_reason' => :'FailureReason',
    :'id' => :'Integer',
    :'state' => :'ChargeState',
    :'transaction' => :'Transaction'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      planned_purge_date == o.planned_purge_date &&
      time_zone == o.time_zone &&
      language == o.language &&
      space_view_id == o.space_view_id &&
      type == o.type &&
      user_failure_message == o.user_failure_message &&
      created_on == o.created_on &&
      version == o.version &&
      linked_space_id == o.linked_space_id &&
      timeout_on == o.timeout_on &&
      failure_reason == o.failure_reason &&
      id == o.id &&
      state == o.state &&
      transaction == o.transaction
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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 363

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


255
256
257
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 255

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



261
262
263
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 261

def hash
  [planned_purge_date, time_zone, language, space_view_id, type, user_failure_message, created_on, version, linked_space_id, timeout_on, failure_reason, id, state, transaction].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



219
220
221
222
223
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 219

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



339
340
341
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 345

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



333
334
335
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 333

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



227
228
229
230
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 227

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end