Class: DocuSign_Admin::GetUsersOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_admin/api/users_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#_end ⇒ Object

Index of the last item to include in the response. Ignored if ‘take’ parameter is specfied



33
34
35
 
# File 'lib/docusign_admin/api/users_api.rb', line 33

def _end
  @_end
end

#account_id ⇒ Object

Select users that are members of the specified account. At least one of email, account_id or organization_reserved_domain_id must be specified.



48
49
50
 
# File 'lib/docusign_admin/api/users_api.rb', line 48

def 
  @account_id
end

#email ⇒ Object

Email address of the desired user. At least one of email, account_id or organization_reserved_domain_id must be specified.



36
37
38
 
# File 'lib/docusign_admin/api/users_api.rb', line 36

def email
  @email
end

#email_user_name_like ⇒ Object

Selects users by pattern matching on the user’s email address



39
40
41
 
# File 'lib/docusign_admin/api/users_api.rb', line 39

def email_user_name_like
  @email_user_name_like
end

#last_modified_since ⇒ Object

Select users whose data have been modified since the date specified; account_id or organization_reserved_domain_id must be specified.



54
55
56
 
# File 'lib/docusign_admin/api/users_api.rb', line 54

def last_modified_since
  @last_modified_since
end

#membership_status ⇒ Object

Select users based on membership status



45
46
47
 
# File 'lib/docusign_admin/api/users_api.rb', line 45

def membership_status
  @membership_status
end

#organization_reserved_domain_id ⇒ Object

Select users that are in the specified domain. At least one of email, account_id or organization_reserved_domain_id must be specified.



51
52
53
 
# File 'lib/docusign_admin/api/users_api.rb', line 51

def organization_reserved_domain_id
  @organization_reserved_domain_id
end

#start ⇒ Object

Index of first item to include in the response Default value: 0



27
28
29
 
# File 'lib/docusign_admin/api/users_api.rb', line 27

def start
  @start
end

#status ⇒ Object

Select users based on user status



42
43
44
 
# File 'lib/docusign_admin/api/users_api.rb', line 42

def status
  @status
end

#take ⇒ Object

Page size of the response Default value: 20



30
31
32
 
# File 'lib/docusign_admin/api/users_api.rb', line 30

def take
  @take
end

Class Method Details

.default ⇒ Object 



56
57
58
 
# File 'lib/docusign_admin/api/users_api.rb', line 56

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