Class: DocSpring::SubmissionBatchWithSubmissions

Inherits:
Object
  • Object
show all
Defined in:
lib/docspring/models/submission_batch_with_submissions.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubmissionBatchWithSubmissions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 108

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

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

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  else
    self.metadata = nil
  end

  if attributes.key?(:'processed_at')
    self.processed_at = attributes[:'processed_at']
  else
    self.processed_at = nil
  end

  if attributes.key?(:'total_count')
    self.total_count = attributes[:'total_count']
  else
    self.total_count = nil
  end

  if attributes.key?(:'pending_count')
    self.pending_count = attributes[:'pending_count']
  else
    self.pending_count = nil
  end

  if attributes.key?(:'error_count')
    self.error_count = attributes[:'error_count']
  else
    self.error_count = nil
  end

  if attributes.key?(:'completion_percentage')
    self.completion_percentage = attributes[:'completion_percentage']
  else
    self.completion_percentage = nil
  end

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

Instance Attribute Details

#completion_percentage ⇒ Object

Returns the value of attribute completion_percentage.



32
33
34
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 32

def completion_percentage
  @completion_percentage
end

#error_count ⇒ Object

Returns the value of attribute error_count.



30
31
32
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 30

def error_count
  @error_count
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 18

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



22
23
24
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 22

def metadata
  @metadata
end

#pending_count ⇒ Object

Returns the value of attribute pending_count.



28
29
30
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 28

def pending_count
  @pending_count
end

#processed_at ⇒ Object

Returns the value of attribute processed_at.



24
25
26
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 24

def processed_at
  @processed_at
end

#state ⇒ Object

Returns the value of attribute state.



20
21
22
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 20

def state
  @state
end

#submissions ⇒ Object

Returns the value of attribute submissions.



34
35
36
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 34

def submissions
  @submissions
end

#total_count ⇒ Object

Returns the value of attribute total_count.



26
27
28
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 26

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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 339

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



74
75
76
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 74

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 79

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 59

def self.attribute_map
  {
    :'id' => :'id',
    :'state' => :'state',
    :'metadata' => :'metadata',
    :'processed_at' => :'processed_at',
    :'total_count' => :'total_count',
    :'pending_count' => :'pending_count',
    :'error_count' => :'error_count',
    :'completion_percentage' => :'completion_percentage',
    :'submissions' => :'submissions'
  }
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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 315

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



99
100
101
102
103
104
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 99

def self.openapi_nullable
  Set.new([
    :'id',
    :'processed_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 84

def self.openapi_types
  {
    :'id' => :'String',
    :'state' => :'String',
    :'metadata' => :'Object',
    :'processed_at' => :'String',
    :'total_count' => :'Integer',
    :'pending_count' => :'Integer',
    :'error_count' => :'Integer',
    :'completion_percentage' => :'Float',
    :'submissions' => :'Array<SubmissionPreview>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      state == o.state &&
      metadata == o.metadata &&
      processed_at == o.processed_at &&
      total_count == o.total_count &&
      pending_count == o.pending_count &&
      error_count == o.error_count &&
      completion_percentage == o.completion_percentage &&
      submissions == o.submissions
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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 410

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


302
303
304
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 308

def hash
  [id, state, metadata, processed_at, total_count, pending_count, error_count, completion_percentage, submissions].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



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
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 179

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @state.nil?
    invalid_properties.push('invalid value for "state", state cannot be nil.')
  end

  if @metadata.nil?
    invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
  end

  if @total_count.nil?
    invalid_properties.push('invalid value for "total_count", total_count cannot be nil.')
  end

  if @pending_count.nil?
    invalid_properties.push('invalid value for "pending_count", pending_count cannot be nil.')
  end

  if @error_count.nil?
    invalid_properties.push('invalid value for "error_count", error_count cannot be nil.')
  end

  if @completion_percentage.nil?
    invalid_properties.push('invalid value for "completion_percentage", completion_percentage cannot be nil.')
  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



386
387
388
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 386

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



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 392

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



380
381
382
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 380

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



211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/docspring/models/submission_batch_with_submissions.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "error"])
  return false unless state_validator.valid?(@state)
  return false if @metadata.nil?
  return false if @total_count.nil?
  return false if @pending_count.nil?
  return false if @error_count.nil?
  return false if @completion_percentage.nil?
  true
end