Class: DocuSign_eSign::ListTemplatesOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/envelopes_api.rb,
lib/docusign_esign/api/templates_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#count ⇒ Object

Number of records to return in the cache.



105
106
107
 
# File 'lib/docusign_esign/api/templates_api.rb', line 105

def count
  @count
end

#folder ⇒ Object

The query value can be a folder name or folder ID. The response will only return templates in the specified folder.



108
109
110
 
# File 'lib/docusign_esign/api/templates_api.rb', line 108

def folder
  @folder
end

#folder_ids ⇒ Object

A comma separated list of folder ID GUIDs.



111
112
113
 
# File 'lib/docusign_esign/api/templates_api.rb', line 111

def folder_ids
  @folder_ids
end

#from_date ⇒ Object

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.



114
115
116
 
# File 'lib/docusign_esign/api/templates_api.rb', line 114

def from_date
  @from_date
end

#include ⇒ Object

A comma separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.



279
280
281
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 279

def include
  @include
end

#order ⇒ Object

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)



120
121
122
 
# File 'lib/docusign_esign/api/templates_api.rb', line 120

def order
  @order
end

#order_by ⇒ Object

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.



123
124
125
 
# File 'lib/docusign_esign/api/templates_api.rb', line 123

def order_by
  @order_by
end

#search_text ⇒ Object

The search text used to search the names of templates.



126
127
128
 
# File 'lib/docusign_esign/api/templates_api.rb', line 126

def search_text
  @search_text
end

#shared ⇒ Object

Returns the value of attribute shared.



129
130
131
 
# File 'lib/docusign_esign/api/templates_api.rb', line 129

def shared
  @shared
end

#shared_by_me ⇒ Object

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.



132
133
134
 
# File 'lib/docusign_esign/api/templates_api.rb', line 132

def shared_by_me
  @shared_by_me
end

#start_position ⇒ Object

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



135
136
137
 
# File 'lib/docusign_esign/api/templates_api.rb', line 135

def start_position
  @start_position
end

#to_date ⇒ Object

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.



138
139
140
 
# File 'lib/docusign_esign/api/templates_api.rb', line 138

def to_date
  @to_date
end

#used_from_date ⇒ Object

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.



141
142
143
 
# File 'lib/docusign_esign/api/templates_api.rb', line 141

def used_from_date
  @used_from_date
end

#used_to_date ⇒ Object

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.



144
145
146
 
# File 'lib/docusign_esign/api/templates_api.rb', line 144

def used_to_date
  @used_to_date
end

#user_filter ⇒ Object

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.



147
148
149
 
# File 'lib/docusign_esign/api/templates_api.rb', line 147

def user_filter
  @user_filter
end

Class Method Details

.default ⇒ Object 



281
282
283
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 281

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