Class: DocuSign_eSign::GetOptions
- Inherits:
-
Object
- Object
- DocuSign_eSign::GetOptions
- Defined in:
- lib/docusign_esign/api/templates_api.rb,
lib/docusign_esign/api/bulk_envelopes_api.rb
Instance Attribute Summary collapse
-
#count ⇒ Object
Specifies the number of entries to return.
-
#include ⇒ Object
Specifies which entries are included in the response.
-
#start_position ⇒ Object
Specifies the location in the list of envelopes from which to start.
Class Method Summary collapse
Instance Attribute Details
#count ⇒ Object
Specifies the number of entries to return.
19 20 21 |
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 19 def count @count end |
#include ⇒ Object
Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include="failed,queued") Valid values are: * all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided. * failed - This only returns entries with a failed status. * queued - This only returns entries with a queued status. * sent - This only returns entries with a sent status.
22 23 24 |
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 22 def include @include end |
#start_position ⇒ Object
Specifies the location in the list of envelopes from which to start.
25 26 27 |
# File 'lib/docusign_esign/api/bulk_envelopes_api.rb', line 25 def start_position @start_position end |
Class Method Details
.default ⇒ Object
30 31 32 |
# File 'lib/docusign_esign/api/templates_api.rb', line 30 def self.default @@default ||= GetOptions.new end |