Class: DocuSign_Rooms::GetDocumentsOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_rooms/api/rooms_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#count ⇒ Object

Number of documents to return. Defaults to the maximum which is 100.



36
37
38
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 36

def count
  @count
end

#include_archived ⇒ Object

Filter documents to have the same isArchived value as includeArchived. Defaults to true, to include archived documents.



51
52
53
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 51

def include_archived
  @include_archived
end

#name_filter ⇒ Object

Filter documents where Name contains the filter. Defaults to null, to not filter.



48
49
50
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 48

def name_filter
  @name_filter
end

#require_content_for_dynamic_documents ⇒ Object

Filter out any isDynamic documents without content. Defaults to false.



42
43
44
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 42

def require_content_for_dynamic_documents
  @require_content_for_dynamic_documents
end

#room_folder_id ⇒ Object

Filter documents by folderId. Defaults to null, to not filter on folderId.



45
46
47
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 45

def room_folder_id
  @room_folder_id
end

#start_position ⇒ Object

Position of the first item in the total results. Defaults to 0.



39
40
41
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 39

def start_position
  @start_position
end

Class Method Details

.default ⇒ Object 



53
54
55
 
# File 'lib/docusign_rooms/api/rooms_api.rb', line 53

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