Class: DocRaptor::AsyncDocStatus

Inherits:
BaseObject show all
Defined in:
lib/docraptor/models/async_doc_status.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseObject

#_deserialize, #_to_hash, #build_from_hash, #to_body, #to_hash, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ AsyncDocStatus

Returns a new instance of AsyncDocStatus.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/docraptor/models/async_doc_status.rb', line 43

def initialize(attributes = {})
  return if !attributes.is_a?(Hash) || attributes.empty?

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'download_url']
    self.download_url = attributes[:'download_url']
  end
  
  if attributes[:'download_id']
    self.download_id = attributes[:'download_id']
  end
  
  if attributes[:'message']
    self.message = attributes[:'message']
  end
  
  if attributes[:'number_of_pages']
    self.number_of_pages = attributes[:'number_of_pages']
  end
  
  if attributes[:'validation_errors']
    self.validation_errors = attributes[:'validation_errors']
  end
  
end

Instance Attribute Details

#download_id ⇒ Object

Returns the value of attribute download_id.



4
5
6
 
# File 'lib/docraptor/models/async_doc_status.rb', line 4

def download_id
  @download_id
end

#download_url ⇒ Object

Returns the value of attribute download_url.



4
5
6
 
# File 'lib/docraptor/models/async_doc_status.rb', line 4

def download_url
  @download_url
end

#message ⇒ Object

Returns the value of attribute message.



4
5
6
 
# File 'lib/docraptor/models/async_doc_status.rb', line 4

def message
  @message
end

#number_of_pages ⇒ Object

Returns the value of attribute number_of_pages.



4
5
6
 
# File 'lib/docraptor/models/async_doc_status.rb', line 4

def number_of_pages
  @number_of_pages
end

#status ⇒ Object

Returns the value of attribute status.



4
5
6
 
# File 'lib/docraptor/models/async_doc_status.rb', line 4

def status
  @status
end

#validation_errors ⇒ Object

Returns the value of attribute validation_errors.



4
5
6
 
# File 'lib/docraptor/models/async_doc_status.rb', line 4

def validation_errors
  @validation_errors
end

Class Method Details

.attribute_map ⇒ Object

attribute mapping from ruby-style variable name to JSON key



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/docraptor/models/async_doc_status.rb', line 6

def self.attribute_map
  {
    
    # The present status of the document. Can be queued, working, completed, and failed.
    :'status' => :'status',
    
    # The URL where the document can be retrieved. This URL may only be used a few times.
    :'download_url' => :'download_url',
    
    # The identifier for downloading the document with the download api.
    :'download_id' => :'download_id',
    
    # Additional information.
    :'message' => :'message',
    
    # Number of PDF pages in document.
    :'number_of_pages' => :'number_of_pages',
    
    # Error information.
    :'validation_errors' => :'validation_errors'
    
  }
end

.swagger_types ⇒ Object

attribute type



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/docraptor/models/async_doc_status.rb', line 31

def self.swagger_types
  {
    :'status' => :'String',
    :'download_url' => :'String',
    :'download_id' => :'String',
    :'message' => :'String',
    :'number_of_pages' => :'Integer',
    :'validation_errors' => :'String'
    
  }
end