Class: WhiteLabelMachineName::DebtCollectionCaseDocument

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-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



92
93
94
95
96
97
98
99
100
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 92

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?(:'createdOn')
    self.created_on = attributes[:'createdOn']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_on ⇒ Object

The created on date indicates the date on which the entity was stored into the database.



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

def created_on
  @created_on
end

#debt_collection_case ⇒ Object

Returns the value of attribute debt_collection_case.



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

def debt_collection_case
  @debt_collection_case
end

#file_name ⇒ Object

Returns the value of attribute file_name.



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

def file_name
  @file_name
end

#id ⇒ Object

The ID is the primary key of the entity. The ID identifies the entity uniquely.



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

def id
  @id
end

#labels ⇒ Object

Returns the value of attribute labels.



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

def labels
  @labels
end

#linked_space_id ⇒ Object

The linked space id holds the ID of the space to which the entity belongs to.



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

def linked_space_id
  @linked_space_id
end

#mime_type ⇒ Object

Returns the value of attribute mime_type.



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

def mime_type
  @mime_type
end

#planned_purge_date ⇒ Object

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.



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

def planned_purge_date
  @planned_purge_date
end

#storage_id ⇒ Object

Returns the value of attribute storage_id.



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

def storage_id
  @storage_id
end

#unique_id ⇒ Object

Returns the value of attribute unique_id.



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

def unique_id
  @unique_id
end

#version ⇒ Object

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'created_on' => :'createdOn',
    :'debt_collection_case' => :'debtCollectionCase',
    :'file_name' => :'fileName',
    :'id' => :'id',
    :'labels' => :'labels',
    :'linked_space_id' => :'linkedSpaceId',
    :'mime_type' => :'mimeType',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'storage_id' => :'storageId',
    :'unique_id' => :'uniqueId',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 74

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 205

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



257
258
259
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 257

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



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

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



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

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


223
224
225
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



229
230
231
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 229

def hash
  [created_on, debt_collection_case, file_name, id, labels, linked_space_id, mime_type, planned_purge_date, storage_id, unique_id, 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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 147

def list_invalid_properties
  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 !@storage_id.nil? && @storage_id.to_s.length > 100
    invalid_properties.push('invalid value for "storage_id", 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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



303
304
305
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 303

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



309
310
311
312
313
314
315
316
317
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 309

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



297
298
299
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 297

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



166
167
168
169
170
171
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/debt_collection_case_document.rb', line 166

def valid?
  return false if !@file_name.nil? && @file_name.to_s.length > 100
  return false if !@storage_id.nil? && @storage_id.to_s.length > 100
  return false if !@unique_id.nil? && @unique_id.to_s.length > 500
  true
end