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

#allObject

Specifies that all envelopes that match the criteria are returned.


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

def all
  @all
end

#countObject

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


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

def count
  @count
end

#from_dateObject

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


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

def from_date
  @from_date
end

#include_recipientsObject

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


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

def include_recipients
  @include_recipients
end

#orderObject

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


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

def order
  @order
end

#order_byObject

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


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

def order_by
  @order_by
end

#start_positionObject

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


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

def start_position
  @start_position
end

#to_dateObject

Specifies the end of the date range to return.


91
92
93
# File 'lib/docusign_esign/api/folders_api.rb', line 91

def to_date
  @to_date
end

Class Method Details

.defaultObject


93
94
95
# File 'lib/docusign_esign/api/folders_api.rb', line 93

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