Class: WalleeRubySdk::DunningCase

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DunningCase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
189
190
191
192
193
194
195
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 131

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::DunningCase` 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|
    unless self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `WalleeRubySdk::DunningCase`. 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?(:'canceled_on')
    self.canceled_on = attributes[:'canceled_on']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#canceled_onObject

Returns the value of attribute canceled_on.



26
27
28
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 26

def canceled_on
  @canceled_on
end

#created_onObject

The date and time when the object was created.



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

def created_on
  @created_on
end

#derecognized_onObject

Returns the value of attribute derecognized_on.



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

def derecognized_on
  @derecognized_on
end

#failed_onObject

Returns the value of attribute failed_on.



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

def failed_on
  @failed_on
end

#flowObject

Returns the value of attribute flow.



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

def flow
  @flow
end

#idObject

A unique identifier for the object.



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

def id
  @id
end

#initial_invoiceObject

Returns the value of attribute initial_invoice.



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

def initial_invoice
  @initial_invoice
end

#linked_space_idObject

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#linked_transactionObject

The payment transaction this object is linked to.



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

def linked_transaction
  @linked_transaction
end

#planned_purge_dateObject

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



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

def planned_purge_date
  @planned_purge_date
end

#stateObject

Returns the value of attribute state.



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

def state
  @state
end

#succeeded_onObject

Returns the value of attribute succeeded_on.



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

def succeeded_on
  @succeeded_on
end

#versionObject

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



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

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



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
297
298
299
300
301
302
303
304
305
306
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 269

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_attributesObject

Returns all the JSON keys this model knows about



100
101
102
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 100

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 81

def self.attribute_map
  {
    :'canceled_on' => :'canceledOn',
    :'derecognized_on' => :'derecognizedOn',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'linked_space_id' => :'linkedSpaceId',
    :'initial_invoice' => :'initialInvoice',
    :'succeeded_on' => :'succeededOn',
    :'id' => :'id',
    :'state' => :'state',
    :'linked_transaction' => :'linkedTransaction',
    :'failed_on' => :'failedOn',
    :'flow' => :'flow'
  }
end

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



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

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_nullableObject

List of attributes with nullable: true



124
125
126
127
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 124

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

.openapi_typesObject

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 105

def self.openapi_types
  {
    :'canceled_on' => :'Time',
    :'derecognized_on' => :'Time',
    :'planned_purge_date' => :'Time',
    :'created_on' => :'Time',
    :'version' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'initial_invoice' => :'TransactionInvoice',
    :'succeeded_on' => :'Time',
    :'id' => :'Integer',
    :'state' => :'DunningCaseState',
    :'linked_transaction' => :'Integer',
    :'failed_on' => :'Time',
    :'flow' => :'DunningFlow'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      canceled_on == o.canceled_on &&
      derecognized_on == o.derecognized_on &&
      planned_purge_date == o.planned_purge_date &&
      created_on == o.created_on &&
      version == o.version &&
      linked_space_id == o.linked_space_id &&
      initial_invoice == o.initial_invoice &&
      succeeded_on == o.succeeded_on &&
      id == o.id &&
      state == o.state &&
      linked_transaction == o.linked_transaction &&
      failed_on == o.failed_on &&
      flow == o.flow
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



340
341
342
343
344
345
346
347
348
349
350
351
352
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 340

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


234
235
236
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 234

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



240
241
242
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 240

def hash
  [canceled_on, derecognized_on, planned_purge_date, created_on, version, linked_space_id, initial_invoice, succeeded_on, id, state, linked_transaction, failed_on, flow].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



199
200
201
202
203
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 199

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



316
317
318
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 316

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



322
323
324
325
326
327
328
329
330
331
332
333
334
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 322

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



310
311
312
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 310

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



207
208
209
210
# File 'lib/wallee-ruby-sdk/models/dunning_case.rb', line 207

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