Class: PostFinanceCheckout::PaymentContract

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentContract

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 117

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'account')
    self. = attributes[:'account']
  end

  if attributes.has_key?(:'activatedOn')
    self.activated_on = attributes[:'activatedOn']
  end

  if attributes.has_key?(:'contractIdentifier')
    self.contract_identifier = attributes[:'contractIdentifier']
  end

  if attributes.has_key?(:'contractType')
    self.contract_type = attributes[:'contractType']
  end

  if attributes.has_key?(:'createdBy')
    self.created_by = attributes[:'createdBy']
  end

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

  if attributes.has_key?(:'externalId')
    self.external_id = attributes[:'externalId']
  end

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

  if attributes.has_key?(:'lastModifiedDate')
    self.last_modified_date = attributes[:'lastModifiedDate']
  end

  if attributes.has_key?(:'rejectedOn')
    self.rejected_on = attributes[:'rejectedOn']
  end

  if attributes.has_key?(:'rejectionReason')
    self.rejection_reason = attributes[:'rejectionReason']
  end

  if attributes.has_key?(:'startTerminatingOn')
    self.start_terminating_on = attributes[:'startTerminatingOn']
  end

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

  if attributes.has_key?(:'terminatedBy')
    self.terminated_by = attributes[:'terminatedBy']
  end

  if attributes.has_key?(:'terminatedOn')
    self.terminated_on = attributes[:'terminatedOn']
  end

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



24
25
26
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 24

def 
  @account
end

#activated_on ⇒ Object

Returns the value of attribute activated_on.



27
28
29
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 27

def activated_on
  @activated_on
end

#contract_identifier ⇒ Object

Returns the value of attribute contract_identifier.



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

def contract_identifier
  @contract_identifier
end

#contract_type ⇒ Object

Returns the value of attribute contract_type.



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

def contract_type
  @contract_type
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#external_id ⇒ Object

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#last_modified_date ⇒ Object

The date and time when the object was last modified.



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

def last_modified_date
  @last_modified_date
end

#rejected_on ⇒ Object

Returns the value of attribute rejected_on.



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

def rejected_on
  @rejected_on
end

#rejection_reason ⇒ Object

Returns the value of attribute rejection_reason.



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

def rejection_reason
  @rejection_reason
end

#start_terminating_on ⇒ Object

Returns the value of attribute start_terminating_on.



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

def start_terminating_on
  @start_terminating_on
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#terminated_by ⇒ Object

Returns the value of attribute terminated_by.



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

def terminated_by
  @terminated_by
end

#terminated_on ⇒ Object

Returns the value of attribute terminated_on.



66
67
68
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 66

def terminated_on
  @terminated_on
end

#version ⇒ Object

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



69
70
71
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 69

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 72

def self.attribute_map
  {
    :'account' => :'account',
    :'activated_on' => :'activatedOn',
    :'contract_identifier' => :'contractIdentifier',
    :'contract_type' => :'contractType',
    :'created_by' => :'createdBy',
    :'created_on' => :'createdOn',
    :'external_id' => :'externalId',
    :'id' => :'id',
    :'last_modified_date' => :'lastModifiedDate',
    :'rejected_on' => :'rejectedOn',
    :'rejection_reason' => :'rejectionReason',
    :'start_terminating_on' => :'startTerminatingOn',
    :'state' => :'state',
    :'terminated_by' => :'terminatedBy',
    :'terminated_on' => :'terminatedOn',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 94

def self.swagger_types
  {
    :'account' => :'Account',
    :'activated_on' => :'DateTime',
    :'contract_identifier' => :'String',
    :'contract_type' => :'PaymentContractType',
    :'created_by' => :'User',
    :'created_on' => :'DateTime',
    :'external_id' => :'String',
    :'id' => :'Integer',
    :'last_modified_date' => :'DateTime',
    :'rejected_on' => :'DateTime',
    :'rejection_reason' => :'FailureReason',
    :'start_terminating_on' => :'DateTime',
    :'state' => :'PaymentContractState',
    :'terminated_by' => :'User',
    :'terminated_on' => :'DateTime',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      activated_on == o.activated_on &&
      contract_identifier == o.contract_identifier &&
      contract_type == o.contract_type &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      external_id == o.external_id &&
      id == o.id &&
      last_modified_date == o.last_modified_date &&
      rejected_on == o.rejected_on &&
      rejection_reason == o.rejection_reason &&
      start_terminating_on == o.start_terminating_on &&
      state == o.state &&
      terminated_by == o.terminated_by &&
      terminated_on == o.terminated_on &&
      version == o.version
end

#_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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 260

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = PostFinanceCheckout.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 326

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

#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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 239

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


226
227
228
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 232

def hash
  [, activated_on, contract_identifier, contract_type, created_by, created_on, external_id, id, last_modified_date, rejected_on, rejection_reason, start_terminating_on, state, terminated_by, terminated_on, version].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



190
191
192
193
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 190

def list_invalid_properties
  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



306
307
308
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 306

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



312
313
314
315
316
317
318
319
320
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 312

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



300
301
302
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 300

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



197
198
199
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_contract.rb', line 197

def valid?
  true
end