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/bulk_envelopes_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.



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

def additional_info
  @additional_info
end

#cloud_storage_folder_path ⇒ Object

Returns the value of attribute cloud_storage_folder_path.



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

def cloud_storage_folder_path
  @cloud_storage_folder_path
end

#cloud_storage_folderid_plain ⇒ Object

Returns the value of attribute cloud_storage_folderid_plain.



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

def cloud_storage_folderid_plain
  @cloud_storage_folderid_plain
end

#count ⇒ Object

The number of results to return. This can be 1 to 20.



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

def count
  @count
end

#custom_tab_only ⇒ Object

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



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

def custom_tab_only
  @custom_tab_only
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#email_substring ⇒ Object

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



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

def email_substring
  @email_substring
end

#group_id ⇒ Object

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



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

def group_id
  @group_id
end

#group_type ⇒ Object

Returns the value of attribute group_type.



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

def group_type
  @group_type
end

#include ⇒ Object

Returns the value of attribute include.



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

def include
  @include
end

#include_items ⇒ Object

Returns the value of attribute include_items.



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

def include_items
  @include_items
end

#include_users ⇒ Object

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



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

def include_users
  @include_users
end

#include_usersettings_for_csv ⇒ Object

Returns the value of attribute include_usersettings_for_csv.



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

def include_usersettings_for_csv
  @include_usersettings_for_csv
end

#login_status ⇒ Object

Returns the value of attribute login_status.



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

def 
  @login_status
end

#not_group_id ⇒ Object

Returns the value of attribute not_group_id.



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

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



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

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



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

def order_by
  @order_by
end

#search_text ⇒ Object

Returns the value of attribute search_text.



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

def search_text
  @search_text
end

#start_position ⇒ Object

The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0.



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

def start_position
  @start_position
end

#status ⇒ Object

Returns the value of attribute status.



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

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.



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

def template
  @template
end

#user_filter ⇒ Object

Returns the value of attribute user_filter.



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

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.



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

def user_name_substring
  @user_name_substring
end

Class Method Details

.default ⇒ Object 



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

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