Class: DocuSign_eSign::ListTemplatesOptions
- Inherits:
-
Object
- Object
- DocuSign_eSign::ListTemplatesOptions
- Defined in:
- lib/docusign_esign/api/envelopes_api.rb,
lib/docusign_esign/api/templates_api.rb
Instance Attribute Summary collapse
-
#count ⇒ Object
Number of records to return in the cache.
-
#created_from_date ⇒ Object
Returns the value of attribute created_from_date.
-
#created_to_date ⇒ Object
Returns the value of attribute created_to_date.
-
#folder_ids ⇒ Object
A comma separated list of folder ID GUIDs.
-
#folder_types ⇒ Object
Returns the value of attribute folder_types.
-
#from_date ⇒ Object
Start of the search date range.
-
#include ⇒ Object
A comma separated list of additional template attributes to include in the response.
-
#is_download ⇒ Object
Returns the value of attribute is_download.
-
#modified_from_date ⇒ Object
Returns the value of attribute modified_from_date.
-
#modified_to_date ⇒ Object
Returns the value of attribute modified_to_date.
-
#order ⇒ Object
Sets the direction order used to sort the list.
-
#order_by ⇒ Object
Sets the file attribute used to sort the list.
-
#search_fields ⇒ Object
Returns the value of attribute search_fields.
-
#search_text ⇒ Object
The search text used to search the names of templates.
-
#shared_by_me ⇒ Object
If true, the response only includes templates shared by the user.
-
#start_position ⇒ Object
The starting index for the first template shown in the response.
-
#template_ids ⇒ Object
Returns the value of attribute template_ids.
-
#to_date ⇒ Object
End of the search date range.
-
#used_from_date ⇒ Object
Start of the search date range.
-
#used_to_date ⇒ Object
End of the search date range.
-
#user_filter ⇒ Object
Sets if the templates shown in the response Valid values are: -owned_by_me: only shows templates the user owns.
-
#user_id ⇒ Object
Returns the value of attribute user_id.
Class Method Summary collapse
Instance Attribute Details
#count ⇒ Object
Number of records to return in the cache.
150 151 152 |
# File 'lib/docusign_esign/api/templates_api.rb', line 150 def count @count end |
#created_from_date ⇒ Object
Returns the value of attribute created_from_date.
153 154 155 |
# File 'lib/docusign_esign/api/templates_api.rb', line 153 def created_from_date @created_from_date end |
#created_to_date ⇒ Object
Returns the value of attribute created_to_date.
156 157 158 |
# File 'lib/docusign_esign/api/templates_api.rb', line 156 def created_to_date @created_to_date end |
#folder_ids ⇒ Object
A comma separated list of folder ID GUIDs.
159 160 161 |
# File 'lib/docusign_esign/api/templates_api.rb', line 159 def folder_ids @folder_ids end |
#folder_types ⇒ Object
Returns the value of attribute folder_types.
162 163 164 |
# File 'lib/docusign_esign/api/templates_api.rb', line 162 def folder_types @folder_types 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.
165 166 167 |
# File 'lib/docusign_esign/api/templates_api.rb', line 165 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.
402 403 404 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 402 def include @include end |
#is_download ⇒ Object
Returns the value of attribute is_download.
171 172 173 |
# File 'lib/docusign_esign/api/templates_api.rb', line 171 def is_download @is_download end |
#modified_from_date ⇒ Object
Returns the value of attribute modified_from_date.
174 175 176 |
# File 'lib/docusign_esign/api/templates_api.rb', line 174 def modified_from_date @modified_from_date end |
#modified_to_date ⇒ Object
Returns the value of attribute modified_to_date.
177 178 179 |
# File 'lib/docusign_esign/api/templates_api.rb', line 177 def modified_to_date @modified_to_date 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)
180 181 182 |
# File 'lib/docusign_esign/api/templates_api.rb', line 180 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.
183 184 185 |
# File 'lib/docusign_esign/api/templates_api.rb', line 183 def order_by @order_by end |
#search_fields ⇒ Object
Returns the value of attribute search_fields.
186 187 188 |
# File 'lib/docusign_esign/api/templates_api.rb', line 186 def search_fields @search_fields end |
#search_text ⇒ Object
The search text used to search the names of templates.
189 190 191 |
# File 'lib/docusign_esign/api/templates_api.rb', line 189 def search_text @search_text 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.
192 193 194 |
# File 'lib/docusign_esign/api/templates_api.rb', line 192 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).
195 196 197 |
# File 'lib/docusign_esign/api/templates_api.rb', line 195 def start_position @start_position end |
#template_ids ⇒ Object
Returns the value of attribute template_ids.
198 199 200 |
# File 'lib/docusign_esign/api/templates_api.rb', line 198 def template_ids @template_ids 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.
201 202 203 |
# File 'lib/docusign_esign/api/templates_api.rb', line 201 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.
204 205 206 |
# File 'lib/docusign_esign/api/templates_api.rb', line 204 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.
207 208 209 |
# File 'lib/docusign_esign/api/templates_api.rb', line 207 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.
210 211 212 |
# File 'lib/docusign_esign/api/templates_api.rb', line 210 def user_filter @user_filter end |
#user_id ⇒ Object
Returns the value of attribute user_id.
213 214 215 |
# File 'lib/docusign_esign/api/templates_api.rb', line 213 def user_id @user_id end |
Class Method Details
.default ⇒ Object
404 405 406 |
# File 'lib/docusign_esign/api/envelopes_api.rb', line 404 def self.default @@default ||= ListTemplatesOptions.new end |