Class: Seam::Clients::AcsUsers

Inherits:
BaseClient show all
Defined in:
lib/seam/clients/acs_users.rb

Instance Attribute Summary

Attributes inherited from BaseClient

#client

Instance Method Summary collapse

Methods inherited from BaseClient

#initialize, #request_seam, #request_seam_object

Constructor Details

This class inherits a constructor from Seam::Clients::BaseClient

Instance Method Details

#add_to_access_group(acs_access_group_id:, acs_user_id:) ⇒ Object



6
7
8
9
10
11
12
13
14
# File 'lib/seam/clients/acs_users.rb', line 6

def add_to_access_group(acs_access_group_id:, acs_user_id:)
  request_seam(
    :post,
    "/acs/users/add_to_access_group",
    body: {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id}.compact
  )

  nil
end

#create(acs_system_id:, access_schedule: nil, acs_access_group_ids: nil, email: nil, email_address: nil, full_name: nil, phone_number: nil, user_identity_id: nil) ⇒ Object



16
17
18
19
20
21
22
23
24
# File 'lib/seam/clients/acs_users.rb', line 16

def create(acs_system_id:, access_schedule: nil, acs_access_group_ids: nil, email: nil, email_address: nil, full_name: nil, phone_number: nil, user_identity_id: nil)
  request_seam_object(
    :post,
    "/acs/users/create",
    Seam::AcsUser,
    "acs_user",
    body: {acs_system_id: acs_system_id, access_schedule: access_schedule, acs_access_group_ids: acs_access_group_ids, email: email, email_address: email_address, full_name: full_name, phone_number: phone_number, user_identity_id: user_identity_id}.compact
  )
end

#delete(acs_user_id:) ⇒ Object



26
27
28
29
30
31
32
33
34
# File 'lib/seam/clients/acs_users.rb', line 26

def delete(acs_user_id:)
  request_seam(
    :post,
    "/acs/users/delete",
    body: {acs_user_id: acs_user_id}.compact
  )

  nil
end

#get(acs_user_id:) ⇒ Object



36
37
38
39
40
41
42
43
44
# File 'lib/seam/clients/acs_users.rb', line 36

def get(acs_user_id:)
  request_seam_object(
    :post,
    "/acs/users/get",
    Seam::AcsUser,
    "acs_user",
    body: {acs_user_id: acs_user_id}.compact
  )
end

#list(acs_system_id: nil, user_identity_email_address: nil, user_identity_id: nil, user_identity_phone_number: nil) ⇒ Object



46
47
48
49
50
51
52
53
54
# File 'lib/seam/clients/acs_users.rb', line 46

def list(acs_system_id: nil, user_identity_email_address: nil, user_identity_id: nil, user_identity_phone_number: nil)
  request_seam_object(
    :post,
    "/acs/users/list",
    Seam::AcsUser,
    "acs_users",
    body: {acs_system_id: acs_system_id, user_identity_email_address: user_identity_email_address, user_identity_id: user_identity_id, user_identity_phone_number: user_identity_phone_number}.compact
  )
end

#list_accessible_entrances(acs_user_id:) ⇒ Object



56
57
58
59
60
61
62
63
64
# File 'lib/seam/clients/acs_users.rb', line 56

def list_accessible_entrances(acs_user_id:)
  request_seam_object(
    :post,
    "/acs/users/list_accessible_entrances",
    Seam::AcsEntrance,
    "acs_entrances",
    body: {acs_user_id: acs_user_id}.compact
  )
end

#remove_from_access_group(acs_access_group_id:, acs_user_id:) ⇒ Object



66
67
68
69
70
71
72
73
74
# File 'lib/seam/clients/acs_users.rb', line 66

def remove_from_access_group(acs_access_group_id:, acs_user_id:)
  request_seam(
    :post,
    "/acs/users/remove_from_access_group",
    body: {acs_access_group_id: acs_access_group_id, acs_user_id: acs_user_id}.compact
  )

  nil
end

#revoke_access_to_all_entrances(acs_user_id:) ⇒ Object



76
77
78
79
80
81
82
83
84
# File 'lib/seam/clients/acs_users.rb', line 76

def revoke_access_to_all_entrances(acs_user_id:)
  request_seam(
    :post,
    "/acs/users/revoke_access_to_all_entrances",
    body: {acs_user_id: acs_user_id}.compact
  )

  nil
end

#suspend(acs_user_id:) ⇒ Object



86
87
88
89
90
91
92
93
94
# File 'lib/seam/clients/acs_users.rb', line 86

def suspend(acs_user_id:)
  request_seam(
    :post,
    "/acs/users/suspend",
    body: {acs_user_id: acs_user_id}.compact
  )

  nil
end

#unsuspend(acs_user_id:) ⇒ Object



96
97
98
99
100
101
102
103
104
# File 'lib/seam/clients/acs_users.rb', line 96

def unsuspend(acs_user_id:)
  request_seam(
    :post,
    "/acs/users/unsuspend",
    body: {acs_user_id: acs_user_id}.compact
  )

  nil
end

#update(acs_user_id:, access_schedule: nil, email: nil, email_address: nil, full_name: nil, hid_acs_system_id: nil, phone_number: nil) ⇒ Object



106
107
108
109
110
111
112
113
114
# File 'lib/seam/clients/acs_users.rb', line 106

def update(acs_user_id:, access_schedule: nil, email: nil, email_address: nil, full_name: nil, hid_acs_system_id: nil, phone_number: nil)
  request_seam(
    :post,
    "/acs/users/update",
    body: {acs_user_id: acs_user_id, access_schedule: access_schedule, email: email, email_address: email_address, full_name: full_name, hid_acs_system_id: hid_acs_system_id, phone_number: phone_number}.compact
  )

  nil
end