Class: DealMakerAPI::V1EntitiesBulkUpload

Inherits:
Object
  • Object
show all
Defined in:
lib/DealMakerAPI/models/v1_entities_bulk_upload.rb

Overview

V1_Entities_BulkUpload model

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1EntitiesBulkUpload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 121

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#company_id ⇒ Object

The company ID



23
24
25
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 23

def company_id
  @company_id
end

#created_at ⇒ Object

The created at timestamp



47
48
49
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 47

def created_at
  @created_at
end

#document_type ⇒ Object

The document type



29
30
31
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 29

def document_type
  @document_type
end

#errors_count ⇒ Object

The number of errors in the bulk upload



38
39
40
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 38

def errors_count
  @errors_count
end

#file_identifier ⇒ Object

The file identifier [shareholder, investor]



26
27
28
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 26

def file_identifier
  @file_identifier
end

#files_count ⇒ Object

The number of files in the bulk upload



35
36
37
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 35

def files_count
  @files_count
end

#id ⇒ Object

The bulk upload ID



20
21
22
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 20

def id
  @id
end

#status ⇒ Object

The status [pending, processing, completed, failed]



44
45
46
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 44

def status
  @status
end

#success_count ⇒ Object

The number of succeeded files in the bulk upload



41
42
43
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 41

def success_count
  @success_count
end

#updated_at ⇒ Object

The updated at timestamp



50
51
52
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 50

def updated_at
  @updated_at
end

#upload_name ⇒ Object

The bulk upload name



32
33
34
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 32

def upload_name
  @upload_name
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



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
297
298
299
300
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 263

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 = DealMakerAPI.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 92

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 75

def self.attribute_map
  {
    :'id' => :'id',
    :'company_id' => :'company_id',
    :'file_identifier' => :'file_identifier',
    :'document_type' => :'document_type',
    :'upload_name' => :'upload_name',
    :'files_count' => :'files_count',
    :'errors_count' => :'errors_count',
    :'success_count' => :'success_count',
    :'status' => :'status',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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
255
256
257
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 239

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



114
115
116
117
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 97

def self.openapi_types
  {
    :'id' => :'Integer',
    :'company_id' => :'Integer',
    :'file_identifier' => :'String',
    :'document_type' => :'String',
    :'upload_name' => :'String',
    :'files_count' => :'Integer',
    :'errors_count' => :'Integer',
    :'success_count' => :'Integer',
    :'status' => :'String',
    :'created_at' => :'String',
    :'updated_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      company_id == o.company_id &&
      file_identifier == o.file_identifier &&
      document_type == o.document_type &&
      upload_name == o.upload_name &&
      files_count == o.files_count &&
      errors_count == o.errors_count &&
      success_count == o.success_count &&
      status == o.status &&
      created_at == o.created_at &&
      updated_at == o.updated_at
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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 334

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


226
227
228
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 232

def hash
  [id, company_id, file_identifier, document_type, upload_name, files_count, errors_count, success_count, status, created_at, updated_at].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



181
182
183
184
185
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 181

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



310
311
312
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 310

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 316

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



304
305
306
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 304

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



189
190
191
192
193
194
 
# File 'lib/DealMakerAPI/models/v1_entities_bulk_upload.rb', line 189

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  document_type_validator = EnumAttributeValidator.new('String', ["drs_statement", "shareholder_statement", "book_entry_statement", "dividend_statement"])
  return false unless document_type_validator.valid?(@document_type)
  true
end