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.



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

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.



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

def folder
  @folder
end

#folder_ids ⇒ Object

A comma separated list of folder ID GUIDs.



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

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.



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

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.



319
320
321
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 319

def include
  @include
end

#modified_from_date ⇒ Object

Returns the value of attribute modified_from_date.



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

def modified_from_date
  @modified_from_date
end

#modified_to_date ⇒ Object

Returns the value of attribute modified_to_date.



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

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)



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

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.



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

def order_by
  @order_by
end

#search_text ⇒ Object

The search text used to search the names of templates.



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

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.



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

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



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

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.



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

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.



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

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.



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

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.



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

def user_filter
  @user_filter
end

#user_id ⇒ Object

Returns the value of attribute user_id.



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

def user_id
  @user_id
end

Class Method Details

.default ⇒ Object 



321
322
323
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 321

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