class DocSpring::Submission

Attributes

actions[RW]
batch_id[RW]
data[RW]
data_requests[RW]
download_url[RW]
editable[RW]
expired[RW]
expires_at[RW]
id[RW]
metadata[RW]
pdf_hash[RW]
permanent_download_url[RW]
processed_at[RW]
referrer[RW]
source[RW]
state[RW]
template_id[RW]
test[RW]
truncated_text[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/docspring/models/submission.rb, line 78
def self.attribute_map
  {
    :'id' => :'id',
    :'template_id' => :'template_id',
    :'test' => :'test',
    :'editable' => :'editable',
    :'expired' => :'expired',
    :'expires_at' => :'expires_at',
    :'processed_at' => :'processed_at',
    :'state' => :'state',
    :'data' => :'data',
    :'metadata' => :'metadata',
    :'truncated_text' => :'truncated_text',
    :'pdf_hash' => :'pdf_hash',
    :'download_url' => :'download_url',
    :'permanent_download_url' => :'permanent_download_url',
    :'batch_id' => :'batch_id',
    :'data_requests' => :'data_requests',
    :'actions' => :'actions',
    :'source' => :'source',
    :'referrer' => :'referrer'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/docspring/models/submission.rb, line 129
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'referrer')
    self.referrer = attributes[:'referrer']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/docspring/models/submission.rb, line 103
def self.openapi_types
  {
    :'id' => :'String',
    :'template_id' => :'String',
    :'test' => :'BOOLEAN',
    :'editable' => :'BOOLEAN',
    :'expired' => :'BOOLEAN',
    :'expires_at' => :'String',
    :'processed_at' => :'String',
    :'state' => :'String',
    :'data' => :'Object',
    :'metadata' => :'Object',
    :'truncated_text' => :'Object',
    :'pdf_hash' => :'String',
    :'download_url' => :'String',
    :'permanent_download_url' => :'String',
    :'batch_id' => :'String',
    :'data_requests' => :'Array<SubmissionDataRequest>',
    :'actions' => :'Array<SubmissionAction>',
    :'source' => :'String',
    :'referrer' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/docspring/models/submission.rb, line 263
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      template_id == o.template_id &&
      test == o.test &&
      editable == o.editable &&
      expired == o.expired &&
      expires_at == o.expires_at &&
      processed_at == o.processed_at &&
      state == o.state &&
      data == o.data &&
      metadata == o.metadata &&
      truncated_text == o.truncated_text &&
      pdf_hash == o.pdf_hash &&
      download_url == o.download_url &&
      permanent_download_url == o.permanent_download_url &&
      batch_id == o.batch_id &&
      data_requests == o.data_requests &&
      actions == o.actions &&
      source == o.source &&
      referrer == o.referrer
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/docspring/models/submission.rb, line 323
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 = DocSpring.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/docspring/models/submission.rb, line 389
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/docspring/models/submission.rb, line 302
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/docspring/models/submission.rb, line 289
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/docspring/models/submission.rb, line 295
def hash
  [id, template_id, test, editable, expired, expires_at, processed_at, state, data, metadata, truncated_text, pdf_hash, download_url, permanent_download_url, batch_id, data_requests, actions, source, referrer].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/docspring/models/submission.rb, line 218
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

  invalid_properties
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned

# File lib/docspring/models/submission.rb, line 253
def state=(state)
  validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'syntax_error', 'account_suspended', 'license_revoked', 'accidental'])
  unless validator.valid?(state)
    fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/docspring/models/submission.rb, line 369
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/docspring/models/submission.rb, line 375
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/docspring/models/submission.rb, line 363
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/docspring/models/submission.rb, line 241
def valid?
  return false if @id.nil?
  return false if @test.nil?
  return false if @expired.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'syntax_error', 'account_suspended', 'license_revoked', 'accidental'])
  return false unless state_validator.valid?(@state)
  true
end