Class: Seam::Clients::UserIdentities
- Inherits:
-
Object
- Object
- Seam::Clients::UserIdentities
- Defined in:
- lib/seam/routes/clients/user_identities.rb
Instance Method Summary collapse
- #add_acs_user(acs_user_id:, user_identity_id: nil, user_identity_key: nil) ⇒ Object
- #create(acs_system_ids: nil, email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil) ⇒ Object
- #delete(user_identity_id:) ⇒ Object
- #generate_instant_key(user_identity_id:, customization_profile_id: nil, max_use_count: nil) ⇒ Object
- #get(user_identity_id: nil, user_identity_key: nil) ⇒ Object
- #grant_access_to_device(device_id:, user_identity_id:) ⇒ Object
-
#initialize(client:, defaults:) ⇒ UserIdentities
constructor
A new instance of UserIdentities.
- #list(created_before: nil, credential_manager_acs_system_id: nil, limit: nil, page_cursor: nil, search: nil, user_identity_ids: nil) ⇒ Object
- #list_accessible_devices(user_identity_id:) ⇒ Object
- #list_accessible_entrances(user_identity_id:) ⇒ Object
- #list_acs_systems(user_identity_id:) ⇒ Object
- #list_acs_users(user_identity_id:) ⇒ Object
- #remove_acs_user(acs_user_id:, user_identity_id:) ⇒ Object
- #revoke_access_to_device(device_id:, user_identity_id:) ⇒ Object
- #unmanaged ⇒ Object
- #update(user_identity_id:, email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil) ⇒ Object
Constructor Details
#initialize(client:, defaults:) ⇒ UserIdentities
Returns a new instance of UserIdentities.
6 7 8 9 |
# File 'lib/seam/routes/clients/user_identities.rb', line 6 def initialize(client:, defaults:) @client = client @defaults = defaults end |
Instance Method Details
#add_acs_user(acs_user_id:, user_identity_id: nil, user_identity_key: nil) ⇒ Object
15 16 17 18 19 |
# File 'lib/seam/routes/clients/user_identities.rb', line 15 def add_acs_user(acs_user_id:, user_identity_id: nil, user_identity_key: nil) @client.post("/user_identities/add_acs_user", {acs_user_id: acs_user_id, user_identity_id: user_identity_id, user_identity_key: user_identity_key}.compact) nil end |
#create(acs_system_ids: nil, email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil) ⇒ Object
21 22 23 24 25 |
# File 'lib/seam/routes/clients/user_identities.rb', line 21 def create(acs_system_ids: nil, email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil) res = @client.post("/user_identities/create", {acs_system_ids: acs_system_ids, email_address: email_address, full_name: full_name, phone_number: phone_number, user_identity_key: user_identity_key}.compact) Seam::Resources::UserIdentity.load_from_response(res.body["user_identity"]) end |
#delete(user_identity_id:) ⇒ Object
27 28 29 30 31 |
# File 'lib/seam/routes/clients/user_identities.rb', line 27 def delete(user_identity_id:) @client.post("/user_identities/delete", {user_identity_id: user_identity_id}.compact) nil end |
#generate_instant_key(user_identity_id:, customization_profile_id: nil, max_use_count: nil) ⇒ Object
33 34 35 36 37 |
# File 'lib/seam/routes/clients/user_identities.rb', line 33 def generate_instant_key(user_identity_id:, customization_profile_id: nil, max_use_count: nil) res = @client.post("/user_identities/generate_instant_key", {user_identity_id: user_identity_id, customization_profile_id: customization_profile_id, max_use_count: max_use_count}.compact) Seam::Resources::InstantKey.load_from_response(res.body["instant_key"]) end |
#get(user_identity_id: nil, user_identity_key: nil) ⇒ Object
39 40 41 42 43 |
# File 'lib/seam/routes/clients/user_identities.rb', line 39 def get(user_identity_id: nil, user_identity_key: nil) res = @client.post("/user_identities/get", {user_identity_id: user_identity_id, user_identity_key: user_identity_key}.compact) Seam::Resources::UserIdentity.load_from_response(res.body["user_identity"]) end |
#grant_access_to_device(device_id:, user_identity_id:) ⇒ Object
45 46 47 48 49 |
# File 'lib/seam/routes/clients/user_identities.rb', line 45 def grant_access_to_device(device_id:, user_identity_id:) @client.post("/user_identities/grant_access_to_device", {device_id: device_id, user_identity_id: user_identity_id}.compact) nil end |
#list(created_before: nil, credential_manager_acs_system_id: nil, limit: nil, page_cursor: nil, search: nil, user_identity_ids: nil) ⇒ Object
51 52 53 54 55 |
# File 'lib/seam/routes/clients/user_identities.rb', line 51 def list(created_before: nil, credential_manager_acs_system_id: nil, limit: nil, page_cursor: nil, search: nil, user_identity_ids: nil) res = @client.post("/user_identities/list", {created_before: created_before, credential_manager_acs_system_id: credential_manager_acs_system_id, limit: limit, page_cursor: page_cursor, search: search, user_identity_ids: user_identity_ids}.compact) Seam::Resources::UserIdentity.load_from_response(res.body["user_identities"]) end |
#list_accessible_devices(user_identity_id:) ⇒ Object
57 58 59 60 61 |
# File 'lib/seam/routes/clients/user_identities.rb', line 57 def list_accessible_devices(user_identity_id:) res = @client.post("/user_identities/list_accessible_devices", {user_identity_id: user_identity_id}.compact) Seam::Resources::Device.load_from_response(res.body["devices"]) end |
#list_accessible_entrances(user_identity_id:) ⇒ Object
63 64 65 66 67 |
# File 'lib/seam/routes/clients/user_identities.rb', line 63 def list_accessible_entrances(user_identity_id:) res = @client.post("/user_identities/list_accessible_entrances", {user_identity_id: user_identity_id}.compact) Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"]) end |
#list_acs_systems(user_identity_id:) ⇒ Object
69 70 71 72 73 |
# File 'lib/seam/routes/clients/user_identities.rb', line 69 def list_acs_systems(user_identity_id:) res = @client.post("/user_identities/list_acs_systems", {user_identity_id: user_identity_id}.compact) Seam::Resources::AcsSystem.load_from_response(res.body["acs_systems"]) end |
#list_acs_users(user_identity_id:) ⇒ Object
75 76 77 78 79 |
# File 'lib/seam/routes/clients/user_identities.rb', line 75 def list_acs_users(user_identity_id:) res = @client.post("/user_identities/list_acs_users", {user_identity_id: user_identity_id}.compact) Seam::Resources::AcsUser.load_from_response(res.body["acs_users"]) end |
#remove_acs_user(acs_user_id:, user_identity_id:) ⇒ Object
81 82 83 84 85 |
# File 'lib/seam/routes/clients/user_identities.rb', line 81 def remove_acs_user(acs_user_id:, user_identity_id:) @client.post("/user_identities/remove_acs_user", {acs_user_id: acs_user_id, user_identity_id: user_identity_id}.compact) nil end |
#revoke_access_to_device(device_id:, user_identity_id:) ⇒ Object
87 88 89 90 91 |
# File 'lib/seam/routes/clients/user_identities.rb', line 87 def revoke_access_to_device(device_id:, user_identity_id:) @client.post("/user_identities/revoke_access_to_device", {device_id: device_id, user_identity_id: user_identity_id}.compact) nil end |
#unmanaged ⇒ Object
11 12 13 |
# File 'lib/seam/routes/clients/user_identities.rb', line 11 def unmanaged @unmanaged ||= Seam::Clients::UserIdentitiesUnmanaged.new(client: @client, defaults: @defaults) end |
#update(user_identity_id:, email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil) ⇒ Object
93 94 95 96 97 |
# File 'lib/seam/routes/clients/user_identities.rb', line 93 def update(user_identity_id:, email_address: nil, full_name: nil, phone_number: nil, user_identity_key: nil) @client.post("/user_identities/update", {user_identity_id: user_identity_id, email_address: email_address, full_name: full_name, phone_number: phone_number, user_identity_key: user_identity_key}.compact) nil end |