class DocuSign_eSign::SearchOptions

Attributes

all[RW]

Specifies that all envelopes that match the criteria are returned.

count[RW]

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

from_date[RW]

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

include_recipients[RW]

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

order[RW]

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

order_by[RW]

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

start_position[RW]

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

to_date[RW]

Specifies the end of the date range to return.

Public Class Methods

default() click to toggle source
# File lib/docusign_esign/api/folders_api.rb, line 92
def self.default
  @@default ||= SearchOptions.new
end