Class: DocuSign_Rooms::GetUsersOptions

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#access_level ⇒ Object

Valid values are ‘Company’, ‘Region’, ‘Office’, ‘Contributor’



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

def access_level
  @access_level
end

#count ⇒ Object

Defaults to 100. Must be less than or equal to 100



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

def count
  @count
end

#default_office_id ⇒ Object

Default office ID



24
25
26
 
# File 'lib/docusign_rooms/api/users_api.rb', line 24

def default_office_id
  @default_office_id
end

#filter ⇒ Object

Filters by name and email



18
19
20
 
# File 'lib/docusign_rooms/api/users_api.rb', line 18

def filter
  @filter
end

#locked_only ⇒ Object

When set to true, filters for users whose accounts are locked



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

def locked_only
  @locked_only
end

#role_id ⇒ Object

Only valid for next gen companies



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

def role_id
  @role_id
end

#sort ⇒ Object

Valid values are ‘FirstNameAsc’, ‘FirstNameDesc’, ‘LastNameAsc’, ‘LastNameDesc’, ‘EmailAsc’, ‘EmailDesc’



21
22
23
 
# File 'lib/docusign_rooms/api/users_api.rb', line 21

def sort
  @sort
end

#start_position ⇒ Object

Defaults to 0



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

def start_position
  @start_position
end

#status ⇒ Object

Valid values are ‘Active’, ‘Pending’



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

def status
  @status
end

#title_id ⇒ Object

Only valid for classic companies



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

def title_id
  @title_id
end

Class Method Details

.default ⇒ Object 



47
48
49
 
# File 'lib/docusign_rooms/api/users_api.rb', line 47

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