Class: DocuSign_eSign::ListItemsOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/folders_api.rb

Instance Attribute Summary collapse

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.



45
46
47
 
# File 'lib/docusign_esign/api/folders_api.rb', line 45

def from_date
  @from_date
end

#include_items ⇒ Object

Returns the value of attribute include_items.



48
49
50
 
# File 'lib/docusign_esign/api/folders_api.rb', line 48

def include_items
  @include_items
end

#owner_email ⇒ Object

The email of the folder owner.



51
52
53
 
# File 'lib/docusign_esign/api/folders_api.rb', line 51

def owner_email
  @owner_email
end

#owner_name ⇒ Object

The name of the folder owner.



54
55
56
 
# File 'lib/docusign_esign/api/folders_api.rb', line 54

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.



57
58
59
 
# File 'lib/docusign_esign/api/folders_api.rb', line 57

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.



60
61
62
 
# File 'lib/docusign_esign/api/folders_api.rb', line 60

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.



63
64
65
 
# File 'lib/docusign_esign/api/folders_api.rb', line 63

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.



66
67
68
 
# File 'lib/docusign_esign/api/folders_api.rb', line 66

def to_date
  @to_date
end

Class Method Details

.default ⇒ Object 



68
69
70
 
# File 'lib/docusign_esign/api/folders_api.rb', line 68

def self.default
  @@default ||= ListItemsOptions.new
end