Class: DocuSign_eSign::ListItemsOptions
- Inherits:
-
Object
- Object
- DocuSign_eSign::ListItemsOptions
- Defined in:
- lib/docusign_esign/api/folders_api.rb
Instance Attribute Summary collapse
-
#from_date ⇒ Object
Only return items on or after this date.
-
#include_items ⇒ Object
Returns the value of attribute include_items.
-
#owner_email ⇒ Object
The email of the folder owner.
-
#owner_name ⇒ Object
The name of the folder owner.
-
#search_text ⇒ Object
The search text used to search the items of the envelope.
-
#start_position ⇒ Object
The position of the folder items to return.
-
#status ⇒ Object
The current status of the envelope.
-
#to_date ⇒ Object
Only return items up to this date.
Class Method Summary collapse
Instance Attribute Details
#from_date ⇒ Object
Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
40 41 42 |
# File 'lib/docusign_esign/api/folders_api.rb', line 40 def from_date @from_date end |
#include_items ⇒ Object
Returns the value of attribute include_items.
43 44 45 |
# File 'lib/docusign_esign/api/folders_api.rb', line 43 def include_items @include_items end |
#owner_email ⇒ Object
The email of the folder owner.
46 47 48 |
# File 'lib/docusign_esign/api/folders_api.rb', line 46 def owner_email @owner_email end |
#owner_name ⇒ Object
The name of the folder owner.
49 50 51 |
# File 'lib/docusign_esign/api/folders_api.rb', line 49 def owner_name @owner_name end |
#search_text ⇒ Object
The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
52 53 54 |
# File 'lib/docusign_esign/api/folders_api.rb', line 52 def search_text @search_text end |
#start_position ⇒ Object
The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
55 56 57 |
# File 'lib/docusign_esign/api/folders_api.rb', line 55 def start_position @start_position end |
#status ⇒ Object
The current status of the envelope. If no value is provided, the default search is all/any status.
58 59 60 |
# File 'lib/docusign_esign/api/folders_api.rb', line 58 def status @status end |
#to_date ⇒ Object
Only return items up to this date. If no value is provided, the default search is to the current date.
61 62 63 |
# File 'lib/docusign_esign/api/folders_api.rb', line 61 def to_date @to_date end |
Class Method Details
.default ⇒ Object
63 64 65 |
# File 'lib/docusign_esign/api/folders_api.rb', line 63 def self.default @@default ||= ListItemsOptions.new end |