class DocuSign_eSign::ListTemplatesOptions

Attributes

count[RW]

Number of records to return in the cache.

created_from_date[RW]

created_to_date[RW]

folder_ids[RW]

A comma separated list of folder ID GUIDs.

folder_types[RW]

from_date[RW]

Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.

include[RW]

The possible values are: matching_applied - This returns template matching information for the template.

is_deleted_template_only[RW]

is_download[RW]

modified_from_date[RW]

modified_to_date[RW]

order[RW]

Sets the direction order used to sort the list. Valid values are: -asc = ascending sort order (a to z) -desc = descending sort order (z to a)

order_by[RW]

Sets the file attribute used to sort the list. Valid values are: -name: template name -modified: date/time template was last modified. -used: date/time the template was last used.

search_fields[RW]

search_text[RW]

The search text used to search the names of templates.

shared_by_me[RW]

If true, the response only includes templates shared by the user. If false, the response only returns template not shared by the user. If not specified, the response is not affected.

start_position[RW]

The starting index for the first template shown in the response. This must be greater than or equal to 0 (zero).

template_ids[RW]

to_date[RW]

End of the search date range. Only returns templates created up to this date/time. If no value is provided, this defaults to the current date.

used_from_date[RW]

Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.

used_to_date[RW]

End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.

user_filter[RW]

Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns. -shared_with_me: only shows templates that are shared with the user. -all: shows all templates owned or shared with the user.

user_id[RW]

Public Class Methods

default() click to toggle source

# File lib/docusign_esign/api/envelopes_api.rb, line 446
def self.default
  @@default ||= ListTemplatesOptions.new
end