class DocuSign_eSign::ListOptions

Attributes

additional_info[RW]

When set to true, the full list of user information is returned for each user in the account.

alternate_admins_only[RW]
cloud_storage_folder_path[RW]
cloud_storage_folderid_plain[RW]
count[RW]

An optional value that sets how many items are included in the response. The default setting for this is 25.

custom_tab_only[RW]

When set to true, only custom tabs are returned in the response.

domain_users_only[RW]
email[RW]
email_substring[RW]

Filters the returned user records by the email address or a sub-string of email address.

group_id[RW]

Filters user records returned by one or more group Id’s.

group_type[RW]
include[RW]
include_items[RW]
include_users[RW]

When set to true, the response includes the signing group members.

include_usersettings_for_csv[RW]
login_status[RW]
not_group_id[RW]
order[RW]

An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order

order_by[RW]

An optional value that sets the file attribute used to sort the item list. Valid values are: * modified * name

search_text[RW]
start_position[RW]

Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.

status[RW]
template[RW]

Specifies the items that are returned. Valid values are: * include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.

user_filter[RW]
user_name_substring[RW]

Filters the user records returned by the user name or a sub-string of user name.

Public Class Methods

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