Class: DocuSign_eSign::ListOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/users_api.rb,
lib/docusign_esign/api/folders_api.rb,
lib/docusign_esign/api/custom_tabs_api.rb,
lib/docusign_esign/api/cloud_storage_api.rb,
lib/docusign_esign/api/signing_groups_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#additional_info ⇒ Object

When set to true, the full list of user information is returned for each user in the account.



66
67
68
 
# File 'lib/docusign_esign/api/users_api.rb', line 66

def additional_info
  @additional_info
end

#cloud_storage_folder_path ⇒ Object

Returns the value of attribute cloud_storage_folder_path.



27
28
29
 
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 27

def cloud_storage_folder_path
  @cloud_storage_folder_path
end

#cloud_storage_folderid_plain ⇒ Object

Returns the value of attribute cloud_storage_folderid_plain.



30
31
32
 
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 30

def cloud_storage_folderid_plain
  @cloud_storage_folderid_plain
end

#count ⇒ Object

An optional value that sets how many items are included in the response. The default setting for this is 25.



69
70
71
 
# File 'lib/docusign_esign/api/users_api.rb', line 69

def count
  @count
end

#custom_tab_only ⇒ Object

When set to true, only custom tabs are returned in the response.



18
19
20
 
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 18

def custom_tab_only
  @custom_tab_only
end

#email ⇒ Object

Returns the value of attribute email.



72
73
74
 
# File 'lib/docusign_esign/api/users_api.rb', line 72

def email
  @email
end

#email_substring ⇒ Object

Filters the returned user records by the email address or a sub-string of email address.



75
76
77
 
# File 'lib/docusign_esign/api/users_api.rb', line 75

def email_substring
  @email_substring
end

#group_id ⇒ Object

Filters user records returned by one or more group Id’s.



78
79
80
 
# File 'lib/docusign_esign/api/users_api.rb', line 78

def group_id
  @group_id
end

#group_type ⇒ Object

Returns the value of attribute group_type.



18
19
20
 
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 18

def group_type
  @group_type
end

#include ⇒ Object

Returns the value of attribute include.



18
19
20
 
# File 'lib/docusign_esign/api/folders_api.rb', line 18

def include
  @include
end

#include_items ⇒ Object

Returns the value of attribute include_items.



21
22
23
 
# File 'lib/docusign_esign/api/folders_api.rb', line 21

def include_items
  @include_items
end

#include_users ⇒ Object

When set to true, the response includes the signing group members.



21
22
23
 
# File 'lib/docusign_esign/api/signing_groups_api.rb', line 21

def include_users
  @include_users
end

#include_usersettings_for_csv ⇒ Object

Returns the value of attribute include_usersettings_for_csv.



81
82
83
 
# File 'lib/docusign_esign/api/users_api.rb', line 81

def include_usersettings_for_csv
  @include_usersettings_for_csv
end

#login_status ⇒ Object

Returns the value of attribute login_status.



84
85
86
 
# File 'lib/docusign_esign/api/users_api.rb', line 84

def 
  @login_status
end

#not_group_id ⇒ Object

Returns the value of attribute not_group_id.



87
88
89
 
# File 'lib/docusign_esign/api/users_api.rb', line 87

def not_group_id
  @not_group_id
end

#order ⇒ Object

An optional value that sets the direction order used to sort the item list. Valid values are: * asc = ascending sort order * desc = descending sort order



36
37
38
 
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 36

def order
  @order
end

#order_by ⇒ Object

An optional value that sets the file attribute used to sort the item list. Valid values are: * modified * name



39
40
41
 
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 39

def order_by
  @order_by
end

#search_text ⇒ Object

Returns the value of attribute search_text.



42
43
44
 
# File 'lib/docusign_esign/api/cloud_storage_api.rb', line 42

def search_text
  @search_text
end

#start_position ⇒ Object

Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.



90
91
92
 
# File 'lib/docusign_esign/api/users_api.rb', line 90

def start_position
  @start_position
end

#status ⇒ Object

Returns the value of attribute status.



93
94
95
 
# File 'lib/docusign_esign/api/users_api.rb', line 93

def status
  @status
end

#template ⇒ Object

Specifies the items that are returned. Valid values are: * include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.



27
28
29
 
# File 'lib/docusign_esign/api/folders_api.rb', line 27

def template
  @template
end

#user_filter ⇒ Object

Returns the value of attribute user_filter.



30
31
32
 
# File 'lib/docusign_esign/api/folders_api.rb', line 30

def user_filter
  @user_filter
end

#user_name_substring ⇒ Object

Filters the user records returned by the user name or a sub-string of user name.



96
97
98
 
# File 'lib/docusign_esign/api/users_api.rb', line 96

def user_name_substring
  @user_name_substring
end

Class Method Details

.default ⇒ Object 



98
99
100
 
# File 'lib/docusign_esign/api/users_api.rb', line 98

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