Class: WalleeRubySdk::DebtCollectionCaseDocument

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DebtCollectionCaseDocument

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 101

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

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

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

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

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

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

  if attributes.key?(:'labels')
    if (value = attributes[:'labels']).is_a?(Array)
      self.labels = value
    end
  end
end

Instance Attribute Details

#created_onObject

The date and time when the object was created.



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

def created_on
  @created_on
end

#debt_collection_caseObject

The debt collection case that this document belongs to.



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

def debt_collection_case
  @debt_collection_case
end

#file_nameObject

The file name of the document.



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

def file_name
  @file_name
end

#idObject

A unique identifier for the object.



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

def id
  @id
end

#labelsObject

The labels providing additional information about the object.



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

def labels
  @labels
end

#linked_space_idObject

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#mime_typeObject

The MIME type of the document’s content.



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

def mime_type
  @mime_type
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.



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

def planned_purge_date
  @planned_purge_date
end

#unique_idObject

A unique identifier of the document.



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

def unique_id
  @unique_id
end

#versionObject

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



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

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



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
307
308
309
310
311
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 274

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



73
74
75
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 57

def self.attribute_map
  {
    :'linked_space_id' => :'linkedSpaceId',
    :'file_name' => :'fileName',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'debt_collection_case' => :'debtCollectionCase',
    :'id' => :'id',
    :'mime_type' => :'mimeType',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'unique_id' => :'uniqueId',
    :'labels' => :'labels'
  }
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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 250

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



94
95
96
97
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 94

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

.openapi_typesObject

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 78

def self.openapi_types
  {
    :'linked_space_id' => :'Integer',
    :'file_name' => :'String',
    :'planned_purge_date' => :'Time',
    :'debt_collection_case' => :'Integer',
    :'id' => :'Integer',
    :'mime_type' => :'String',
    :'created_on' => :'Time',
    :'version' => :'Integer',
    :'unique_id' => :'String',
    :'labels' => :'Array<Label>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      linked_space_id == o.linked_space_id &&
      file_name == o.file_name &&
      planned_purge_date == o.planned_purge_date &&
      debt_collection_case == o.debt_collection_case &&
      id == o.id &&
      mime_type == o.mime_type &&
      created_on == o.created_on &&
      version == o.version &&
      unique_id == o.unique_id &&
      labels == o.labels
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



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

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


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

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



245
246
247
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 245

def hash
  [linked_space_id, file_name, planned_purge_date, debt_collection_case, id, mime_type, created_on, version, unique_id, labels].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 159

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@file_name.nil? && @file_name.to_s.length > 100
    invalid_properties.push('invalid value for "file_name", the character length must be smaller than or equal to 100.')
  end

  if !@unique_id.nil? && @unique_id.to_s.length > 500
    invalid_properties.push('invalid value for "unique_id", the character length must be smaller than or equal to 500.')
  end

  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



321
322
323
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 321

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



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

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



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

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



175
176
177
178
179
180
# File 'lib/wallee-ruby-sdk/models/debt_collection_case_document.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@file_name.nil? && @file_name.to_s.length > 100
  return false if !@unique_id.nil? && @unique_id.to_s.length > 500
  true
end