Class: ProntoForms::Document

Inherits:
Resource show all
Defined in:
lib/prontoforms/document.rb

Overview

A Document is a configuration that generates output data or files when attached to a form.

Instance Attribute Summary

Attributes inherited from Resource

#client, #data, #parent

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#initialize, property, #resource_name

Constructor Details

This class inherits a constructor from ProntoForms::Resource

Class Method Details

.resource_name ⇒ Object 



9
10
11
 
# File 'lib/prontoforms/document.rb', line 9

def self.resource_name
  'documents'
end

Instance Method Details

Returns Whether the document auto-links to new forms.

Returns:

  • (String) —

    Whether the document auto-links to new forms



26
 
# File 'lib/prontoforms/document.rb', line 26

property :auto_link, key: 'autoLink'

#description ⇒ String

Returns Document descriptiojn.

Returns:

  • (String) —

    Document descriptiojn



20
 
# File 'lib/prontoforms/document.rb', line 20

property :description, key: 'description'

#form_document_version ⇒ String

Returns Document form version.

Returns:

  • (String) —

    Document form version



22
 
# File 'lib/prontoforms/document.rb', line 22

property :form_document_version, key: 'formDocumentVersion'

#id ⇒ String

Returns The Document identifier.

Returns:

  • (String) —

    The Document identifier



14
 
# File 'lib/prontoforms/document.rb', line 14

property :id, key: 'identifier'

#name ⇒ String

Returns Document name.

Returns:

  • (String) —

    Document name



18
 
# File 'lib/prontoforms/document.rb', line 18

property :name, key: 'name'

#standard ⇒ Boolean Also known as: standard?

Returns Whether the document is standard (system generated).

Returns:

  • (Boolean) —

    Whether the document is standard (system generated)



24
 
# File 'lib/prontoforms/document.rb', line 24

property :standard, key: 'standard'

#type ⇒ String

Returns Document type.

Returns:

  • (String) —

    Document type



16
 
# File 'lib/prontoforms/document.rb', line 16

property :type, key: 'type'