Class: DocuSign_eSign::SearchOptions

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

#all ⇒ Object

Specifies that all envelopes that match the criteria are returned.



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

def all
  @all
end

#count ⇒ Object

Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.



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

def count
  @count
end

#from_date ⇒ Object

Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.



70
71
72
 
# File 'lib/docusign_esign/api/folders_api.rb', line 70

def from_date
  @from_date
end

#include_recipients ⇒ Object

When set to true, the recipient information is returned in the response.



73
74
75
 
# File 'lib/docusign_esign/api/folders_api.rb', line 73

def include_recipients
  @include_recipients
end

#order ⇒ Object

Specifies the order in which the list is returned. Valid values are: ‘asc` for ascending order, and `desc` for descending order.



76
77
78
 
# File 'lib/docusign_esign/api/folders_api.rb', line 76

def order
  @order
end

#order_by ⇒ Object

Specifies the property used to sort the list. Valid values are: ‘action_required`, `created`, `completed`, `sent`, `signer_list`, `status`, or `subject`.



79
80
81
 
# File 'lib/docusign_esign/api/folders_api.rb', line 79

def order_by
  @order_by
end

#start_position ⇒ Object

Specifies the the starting location in the result set of the items that are returned.



82
83
84
 
# File 'lib/docusign_esign/api/folders_api.rb', line 82

def start_position
  @start_position
end

#to_date ⇒ Object

Specifies the end of the date range to return.



85
86
87
 
# File 'lib/docusign_esign/api/folders_api.rb', line 85

def to_date
  @to_date
end

Class Method Details

.default ⇒ Object 



87
88
89
 
# File 'lib/docusign_esign/api/folders_api.rb', line 87

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