Class: WalleeRubySdk::PaymentContract

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 152

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

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

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  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?(:'terminated_on')
    self.terminated_on = attributes[:'terminated_on']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

This account that the contract belongs to.



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

def 
  @account
end

#activated_on ⇒ Object

The date and time when the contract was activated.



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

def activated_on
  @activated_on
end

#contract_identifier ⇒ Object

The identifier of the contract.



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

def contract_identifier
  @contract_identifier
end

#contract_type ⇒ Object

Returns the value of attribute contract_type.



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

def contract_type
  @contract_type
end

#created_by ⇒ Object

The ID of the user the contract was created by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#external_id ⇒ Object

A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#rejected_on ⇒ Object

The date and time when the contract was rejected.



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

def rejected_on
  @rejected_on
end

#rejection_reason ⇒ Object

Returns the value of attribute rejection_reason.



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

def rejection_reason
  @rejection_reason
end

#start_terminating_on ⇒ Object

The date and time when the termination process of the contract was started.



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

def start_terminating_on
  @start_terminating_on
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#terminated_by ⇒ Object

The ID of the user the contract was terminated by.



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

def terminated_by
  @terminated_by
end

#terminated_on ⇒ Object

The date and time when the contract was terminated.



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

def terminated_on
  @terminated_on
end

#version ⇒ Object

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



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

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



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
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 303

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



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



119
120
121
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 119

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'contract_type' => :'contractType',
    :'terminated_by' => :'terminatedBy',
    :'external_id' => :'externalId',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'terminated_on' => :'terminatedOn',
    :'activated_on' => :'activatedOn',
    :'start_terminating_on' => :'startTerminatingOn',
    :'created_by' => :'createdBy',
    :'contract_identifier' => :'contractIdentifier',
    :'rejected_on' => :'rejectedOn',
    :'id' => :'id',
    :'state' => :'state',
    :'rejection_reason' => :'rejectionReason',
    :'account' => :'account'
  }
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 279

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



145
146
147
148
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 145

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

.openapi_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 124

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contract_type == o.contract_type &&
      terminated_by == o.terminated_by &&
      external_id == o.external_id &&
      created_on == o.created_on &&
      version == o.version &&
      terminated_on == o.terminated_on &&
      activated_on == o.activated_on &&
      start_terminating_on == o.start_terminating_on &&
      created_by == o.created_by &&
      contract_identifier == o.contract_identifier &&
      rejected_on == o.rejected_on &&
      id == o.id &&
      state == o.state &&
      rejection_reason == o.rejection_reason &&
       == o.
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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 374

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


266
267
268
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 272

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



229
230
231
232
233
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 229

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



350
351
352
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 350

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 356

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



344
345
346
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 344

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



237
238
239
240
 
# File 'lib/wallee-ruby-sdk/models/payment_contract.rb', line 237

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