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.



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

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.



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

def folder
  @folder
end

#folder_ids ⇒ Object

A comma separated list of folder ID GUIDs.



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

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.



150
151
152
 
# File 'lib/docusign_esign/api/templates_api.rb', line 150

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.



300
301
302
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 300

def include
  @include
end

#modified_from_date ⇒ Object

Returns the value of attribute modified_from_date.



156
157
158
 
# File 'lib/docusign_esign/api/templates_api.rb', line 156

def modified_from_date
  @modified_from_date
end

#modified_to_date ⇒ Object

Returns the value of attribute modified_to_date.



159
160
161
 
# File 'lib/docusign_esign/api/templates_api.rb', line 159

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)



162
163
164
 
# File 'lib/docusign_esign/api/templates_api.rb', line 162

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.



165
166
167
 
# File 'lib/docusign_esign/api/templates_api.rb', line 165

def order_by
  @order_by
end

#search_text ⇒ Object

The search text used to search the names of templates.



168
169
170
 
# File 'lib/docusign_esign/api/templates_api.rb', line 168

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.



171
172
173
 
# File 'lib/docusign_esign/api/templates_api.rb', line 171

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).



174
175
176
 
# File 'lib/docusign_esign/api/templates_api.rb', line 174

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.



177
178
179
 
# File 'lib/docusign_esign/api/templates_api.rb', line 177

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.



180
181
182
 
# File 'lib/docusign_esign/api/templates_api.rb', line 180

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.



183
184
185
 
# File 'lib/docusign_esign/api/templates_api.rb', line 183

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.



186
187
188
 
# File 'lib/docusign_esign/api/templates_api.rb', line 186

def user_filter
  @user_filter
end

#user_id ⇒ Object

Returns the value of attribute user_id.



189
190
191
 
# File 'lib/docusign_esign/api/templates_api.rb', line 189

def user_id
  @user_id
end

Class Method Details

.default ⇒ Object 



302
303
304
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 302

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