seam 2.157.0 → 2.158.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/lib/seam/resources/access_code.rb +18 -18
- data/lib/seam/resources/access_grant.rb +4 -4
- data/lib/seam/resources/access_method.rb +9 -9
- data/lib/seam/resources/acs_access_group.rb +3 -3
- data/lib/seam/resources/acs_credential.rb +35 -35
- data/lib/seam/resources/acs_encoder.rb +10 -10
- data/lib/seam/resources/acs_entrance.rb +20 -20
- data/lib/seam/resources/acs_system.rb +37 -37
- data/lib/seam/resources/acs_user.rb +35 -35
- data/lib/seam/resources/action_attempt.rb +101 -101
- data/lib/seam/resources/batch.rb +30 -30
- data/lib/seam/resources/client_session.rb +12 -12
- data/lib/seam/resources/connect_webview.rb +6 -6
- data/lib/seam/resources/connected_account.rb +9 -9
- data/lib/seam/resources/device.rb +84 -84
- data/lib/seam/resources/event.rb +60 -60
- data/lib/seam/resources/noise_threshold.rb +2 -2
- data/lib/seam/resources/phone.rb +1 -1
- data/lib/seam/resources/thermostat_daily_program.rb +1 -1
- data/lib/seam/resources/thermostat_schedule.rb +11 -11
- data/lib/seam/resources/unmanaged_access_code.rb +15 -15
- data/lib/seam/resources/unmanaged_access_grant.rb +4 -4
- data/lib/seam/resources/unmanaged_access_method.rb +9 -9
- data/lib/seam/resources/unmanaged_device.rb +10 -10
- data/lib/seam/resources/user_identity.rb +1 -1
- data/lib/seam/resources/webhook.rb +4 -4
- data/lib/seam/resources/workspace.rb +12 -12
- data/lib/seam/routes/access_codes.rb +28 -28
- data/lib/seam/routes/access_codes_simulate.rb +1 -1
- data/lib/seam/routes/access_codes_unmanaged.rb +9 -9
- data/lib/seam/routes/access_grants.rb +3 -3
- data/lib/seam/routes/access_methods.rb +2 -2
- data/lib/seam/routes/acs_access_groups.rb +7 -7
- data/lib/seam/routes/acs_credentials.rb +11 -11
- data/lib/seam/routes/acs_encoders.rb +5 -5
- data/lib/seam/routes/acs_encoders_simulate.rb +4 -4
- data/lib/seam/routes/acs_entrances.rb +5 -5
- data/lib/seam/routes/acs_systems.rb +3 -3
- data/lib/seam/routes/acs_users.rb +16 -16
- data/lib/seam/routes/action_attempts.rb +2 -2
- data/lib/seam/routes/client_sessions.rb +22 -22
- data/lib/seam/routes/connect_webviews.rb +11 -11
- data/lib/seam/routes/connected_accounts.rb +7 -7
- data/lib/seam/routes/connected_accounts_simulate.rb +1 -1
- data/lib/seam/routes/devices.rb +9 -9
- data/lib/seam/routes/devices_simulate.rb +3 -3
- data/lib/seam/routes/devices_unmanaged.rb +6 -6
- data/lib/seam/routes/events.rb +2 -2
- data/lib/seam/routes/instant_keys.rb +3 -3
- data/lib/seam/routes/locks.rb +5 -5
- data/lib/seam/routes/locks_simulate.rb +2 -2
- data/lib/seam/routes/noise_sensors.rb +1 -1
- data/lib/seam/routes/noise_sensors_noise_thresholds.rb +7 -7
- data/lib/seam/routes/noise_sensors_simulate.rb +1 -1
- data/lib/seam/routes/phones.rb +4 -4
- data/lib/seam/routes/phones_simulate.rb +1 -1
- data/lib/seam/routes/spaces.rb +4 -4
- data/lib/seam/routes/thermostats.rb +43 -43
- data/lib/seam/routes/thermostats_schedules.rb +11 -11
- data/lib/seam/routes/thermostats_simulate.rb +6 -6
- data/lib/seam/routes/user_identities.rb +15 -15
- data/lib/seam/routes/user_identities_unmanaged.rb +3 -3
- data/lib/seam/routes/webhooks.rb +5 -5
- data/lib/seam/routes/workspaces.rb +8 -8
- data/lib/seam/version.rb +1 -1
- metadata +1 -1
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Seam
|
|
4
4
|
module Resources
|
|
5
|
-
# Represents an [entrance](https://
|
|
5
|
+
# Represents an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
6
6
|
#
|
|
7
7
|
# In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
|
|
8
8
|
class AcsEntrance < BaseResource
|
|
@@ -321,49 +321,49 @@ module Seam
|
|
|
321
321
|
}.freeze
|
|
322
322
|
end
|
|
323
323
|
|
|
324
|
-
# Akiles-specific metadata associated with the [entrance](https://
|
|
324
|
+
# Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
325
325
|
# @return [AkilesMetadata, nil]
|
|
326
326
|
resource_accessor :akiles_metadata, AkilesMetadata
|
|
327
|
-
# ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://
|
|
327
|
+
# ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
328
328
|
# @return [AssaAbloyVostioMetadata, nil]
|
|
329
329
|
resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
|
|
330
|
-
# Avigilon Alta-specific metadata associated with the [entrance](https://
|
|
330
|
+
# Avigilon Alta-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
331
331
|
# @return [AvigilonAltaMetadata, nil]
|
|
332
332
|
resource_accessor :avigilon_alta_metadata, AvigilonAltaMetadata
|
|
333
|
-
# Brivo-specific metadata associated with the [entrance](https://
|
|
333
|
+
# Brivo-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
334
334
|
# @return [BrivoMetadata, nil]
|
|
335
335
|
resource_accessor :brivo_metadata, BrivoMetadata
|
|
336
|
-
# dormakaba Ambiance-specific metadata associated with the [entrance](https://
|
|
336
|
+
# dormakaba Ambiance-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
337
337
|
# @return [DormakabaAmbianceMetadata, nil]
|
|
338
338
|
resource_accessor :dormakaba_ambiance_metadata, DormakabaAmbianceMetadata
|
|
339
|
-
# dormakaba Community-specific metadata associated with the [entrance](https://
|
|
339
|
+
# dormakaba Community-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
340
340
|
# @return [DormakabaCommunityMetadata, nil]
|
|
341
341
|
resource_accessor :dormakaba_community_metadata, DormakabaCommunityMetadata
|
|
342
|
-
# Hotek-specific metadata associated with the [entrance](https://
|
|
342
|
+
# Hotek-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
343
343
|
# @return [HotekMetadata, nil]
|
|
344
344
|
resource_accessor :hotek_metadata, HotekMetadata
|
|
345
|
-
# Latch-specific metadata associated with the [entrance](https://
|
|
345
|
+
# Latch-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
346
346
|
# @return [LatchMetadata, nil]
|
|
347
347
|
resource_accessor :latch_metadata, LatchMetadata
|
|
348
|
-
# Salto KS-specific metadata associated with the [entrance](https://
|
|
348
|
+
# Salto KS-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
349
349
|
# @return [SaltoKsMetadata, nil]
|
|
350
350
|
resource_accessor :salto_ks_metadata, SaltoKsMetadata
|
|
351
|
-
# Salto Space-specific metadata associated with the [entrance](https://
|
|
351
|
+
# Salto Space-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
352
352
|
# @return [SaltoSpaceMetadata, nil]
|
|
353
353
|
resource_accessor :salto_space_metadata, SaltoSpaceMetadata
|
|
354
|
-
# Visionline-specific metadata associated with the [entrance](https://
|
|
354
|
+
# Visionline-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
355
355
|
# @return [VisionlineMetadata, nil]
|
|
356
356
|
resource_accessor :visionline_metadata, VisionlineMetadata
|
|
357
|
-
# Errors associated with the [entrance](https://
|
|
357
|
+
# Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
358
358
|
# @return [Array<Errors>]
|
|
359
359
|
resource_list_accessor :errors, Errors
|
|
360
|
-
# Warnings associated with the [entrance](https://
|
|
360
|
+
# Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
361
361
|
# @return [Array<Warnings>]
|
|
362
362
|
resource_list_accessor :warnings, Warnings
|
|
363
|
-
# ID of the [entrance](https://
|
|
363
|
+
# ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
364
364
|
# @return [String]
|
|
365
365
|
attr_accessor :acs_entrance_id
|
|
366
|
-
# ID of the [access control system](https://
|
|
366
|
+
# ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
367
367
|
# @return [String]
|
|
368
368
|
attr_accessor :acs_system_id
|
|
369
369
|
# Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.
|
|
@@ -381,20 +381,20 @@ module Seam
|
|
|
381
381
|
# Indicates whether the ACS entrance can be unlocked with mobile key credentials.
|
|
382
382
|
# @return [Boolean, nil]
|
|
383
383
|
attr_accessor :can_unlock_with_mobile_key
|
|
384
|
-
# ID of the [connected account](https://
|
|
384
|
+
# ID of the [connected account](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
385
385
|
# @return [String]
|
|
386
386
|
attr_accessor :connected_account_id
|
|
387
|
-
# Display name for the [entrance](https://
|
|
387
|
+
# Display name for the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
388
388
|
# @return [String]
|
|
389
389
|
attr_accessor :display_name
|
|
390
|
-
# Indicates whether the [entrance](https://
|
|
390
|
+
# Indicates whether the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) is currently locked.
|
|
391
391
|
# @return [Boolean, nil]
|
|
392
392
|
attr_accessor :is_locked
|
|
393
393
|
# IDs of the spaces that the entrance is in.
|
|
394
394
|
# @return [Array<String>]
|
|
395
395
|
attr_accessor :space_ids
|
|
396
396
|
|
|
397
|
-
# Date and time at which the [entrance](https://
|
|
397
|
+
# Date and time at which the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was created.
|
|
398
398
|
# @return [Time]
|
|
399
399
|
date_accessor :created_at
|
|
400
400
|
end
|
|
@@ -2,17 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
module Seam
|
|
4
4
|
module Resources
|
|
5
|
-
# Represents an [access control system](https://
|
|
5
|
+
# Represents an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
6
6
|
#
|
|
7
|
-
# Within an `acs_system`, create [`acs_user`s](https://
|
|
7
|
+
# Within an `acs_system`, create [`acs_user`s](https://www.seam.co/docs/api/acs/users/object) and [`acs_credential`s](https://www.seam.co/docs/api/acs/credentials/object) to grant access to the `acs_user`s.
|
|
8
8
|
#
|
|
9
|
-
# For details about the resources associated with an access control system, see the [access control systems namespace](https://
|
|
9
|
+
# For details about the resources associated with an access control system, see the [access control systems namespace](https://www.seam.co/docs/api/acs/object).
|
|
10
10
|
class AcsSystem < BaseResource
|
|
11
11
|
# Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
|
|
12
12
|
class Errors < BaseResource
|
|
13
|
-
# Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
14
|
-
# This error might also occur if Seam Bridge is connected to the wrong [workspace](https://
|
|
15
|
-
# See also [Troubleshooting Your Access Control System](https://
|
|
13
|
+
# Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
14
|
+
# This error might also occur if Seam Bridge is connected to the wrong [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
15
|
+
# See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
16
16
|
class SeamBridgeDisconnected < Errors
|
|
17
17
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
18
18
|
# @return [String]
|
|
@@ -27,15 +27,15 @@ module Seam
|
|
|
27
27
|
date_accessor :created_at
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
-
# Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
31
|
-
# See also [Troubleshooting Your Access Control System](https://
|
|
30
|
+
# Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
31
|
+
# See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
32
32
|
class BridgeDisconnected < Errors
|
|
33
33
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
34
34
|
# @return [String]
|
|
35
35
|
# Known values:
|
|
36
36
|
# - `bridge_disconnected`
|
|
37
37
|
attr_accessor :error_code
|
|
38
|
-
# Indicates whether the error is related to the [Seam Bridge](https://
|
|
38
|
+
# Indicates whether the error is related to the [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
39
39
|
# @return [Boolean, nil]
|
|
40
40
|
attr_accessor :is_bridge_error
|
|
41
41
|
# Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
@@ -46,9 +46,9 @@ module Seam
|
|
|
46
46
|
date_accessor :created_at
|
|
47
47
|
end
|
|
48
48
|
|
|
49
|
-
# Indicates that [Seam Bridge](https://
|
|
50
|
-
# For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://
|
|
51
|
-
# See also [Troubleshooting Your Access Control System](https://
|
|
49
|
+
# Indicates that [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://www.seam.co/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
|
|
50
|
+
# For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
51
|
+
# See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-visionline_instance_unreachable).
|
|
52
52
|
class VisionlineInstanceUnreachable < Errors
|
|
53
53
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
54
54
|
# @return [String]
|
|
@@ -78,7 +78,7 @@ module Seam
|
|
|
78
78
|
date_accessor :created_at
|
|
79
79
|
end
|
|
80
80
|
|
|
81
|
-
# Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://
|
|
81
|
+
# Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system.
|
|
82
82
|
class InsufficientPermissions < Errors
|
|
83
83
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
84
84
|
# @return [String]
|
|
@@ -93,7 +93,7 @@ module Seam
|
|
|
93
93
|
date_accessor :created_at
|
|
94
94
|
end
|
|
95
95
|
|
|
96
|
-
# Indicates that the [access control system](https://
|
|
96
|
+
# Indicates that the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue.
|
|
97
97
|
class AcsSystemDisconnected < Errors
|
|
98
98
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
99
99
|
# @return [String]
|
|
@@ -108,7 +108,7 @@ module Seam
|
|
|
108
108
|
date_accessor :created_at
|
|
109
109
|
end
|
|
110
110
|
|
|
111
|
-
# Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://
|
|
111
|
+
# Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) to restore access.
|
|
112
112
|
class AccountDisconnected < Errors
|
|
113
113
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
114
114
|
# @return [String]
|
|
@@ -123,7 +123,7 @@ module Seam
|
|
|
123
123
|
date_accessor :created_at
|
|
124
124
|
end
|
|
125
125
|
|
|
126
|
-
# Indicates that the [access control system](https://
|
|
126
|
+
# Indicates that the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.
|
|
127
127
|
class SaltoKsCertificationExpired < Errors
|
|
128
128
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
129
129
|
# @return [String]
|
|
@@ -187,13 +187,13 @@ module Seam
|
|
|
187
187
|
end
|
|
188
188
|
|
|
189
189
|
class Location < BaseResource
|
|
190
|
-
# Time zone in which the [access control system](https://
|
|
190
|
+
# Time zone in which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is located.
|
|
191
191
|
# @return [String, nil]
|
|
192
192
|
attr_accessor :time_zone
|
|
193
193
|
end
|
|
194
194
|
|
|
195
195
|
class VisionlineMetadata < BaseResource
|
|
196
|
-
# IP address or hostname of the main Visionline server relative to [Seam Bridge](https://
|
|
196
|
+
# IP address or hostname of the main Visionline server relative to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) on the local network.
|
|
197
197
|
# @return [String, nil]
|
|
198
198
|
attr_accessor :lan_address
|
|
199
199
|
# Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
|
|
@@ -221,7 +221,7 @@ module Seam
|
|
|
221
221
|
date_accessor :created_at
|
|
222
222
|
end
|
|
223
223
|
|
|
224
|
-
# Indicates the [access control system](https://
|
|
224
|
+
# Indicates the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
225
225
|
class TimeZoneDoesNotMatchLocation < Warnings
|
|
226
226
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
227
227
|
# @return [String]
|
|
@@ -254,7 +254,7 @@ module Seam
|
|
|
254
254
|
date_accessor :created_at
|
|
255
255
|
end
|
|
256
256
|
|
|
257
|
-
# Indicates that Seam encountered an unexpected error while syncing this [access control system](https://
|
|
257
|
+
# Indicates that Seam encountered an unexpected error while syncing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems), so its users, credentials, and access groups may be out of date. Seam retries on every sync cycle and clears this warning once a sync succeeds; if it persists, contact [support](mailto:support@seam.co).
|
|
258
258
|
class UnknownIssueWithAcsSystem < Warnings
|
|
259
259
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
260
260
|
# @return [String]
|
|
@@ -292,38 +292,38 @@ module Seam
|
|
|
292
292
|
}.freeze
|
|
293
293
|
end
|
|
294
294
|
|
|
295
|
-
# Location information for the [access control system](https://
|
|
295
|
+
# Location information for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
296
296
|
# @return [Location]
|
|
297
297
|
resource_accessor :location, Location
|
|
298
|
-
# Visionline-specific metadata for the [access control system](https://
|
|
298
|
+
# Visionline-specific metadata for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
299
299
|
# @return [VisionlineMetadata, nil]
|
|
300
300
|
resource_accessor :visionline_metadata, VisionlineMetadata
|
|
301
|
-
# Errors associated with the [access control system](https://
|
|
301
|
+
# Errors associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
302
302
|
# @return [Array<Errors>]
|
|
303
303
|
resource_list_accessor :errors, Errors
|
|
304
|
-
# Warnings associated with the [access control system](https://
|
|
304
|
+
# Warnings associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
305
305
|
# @return [Array<Warnings>]
|
|
306
306
|
resource_list_accessor :warnings, Warnings
|
|
307
|
-
# Number of access groups in the [access control system](https://
|
|
307
|
+
# Number of access groups in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
308
308
|
# @return [Float, nil]
|
|
309
309
|
attr_accessor :acs_access_group_count
|
|
310
|
-
# ID of the [access control system](https://
|
|
310
|
+
# ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
311
311
|
# @return [String]
|
|
312
312
|
attr_accessor :acs_system_id
|
|
313
|
-
# Number of users in the [access control system](https://
|
|
313
|
+
# Number of users in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
314
314
|
# @return [Float, nil]
|
|
315
315
|
attr_accessor :acs_user_count
|
|
316
|
-
# ID of the connected account associated with the [access control system](https://
|
|
316
|
+
# ID of the connected account associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
317
317
|
# @return [String]
|
|
318
318
|
attr_accessor :connected_account_id
|
|
319
|
-
# IDs of the [connected accounts](https://
|
|
319
|
+
# IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
320
320
|
# @return [Array<String>]
|
|
321
321
|
# @deprecated Use `connected_account_id`.
|
|
322
322
|
attr_accessor :connected_account_ids
|
|
323
|
-
# ID of the default credential manager `acs_system` for this [access control system](https://
|
|
323
|
+
# ID of the default credential manager `acs_system` for this [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
324
324
|
# @return [String, nil]
|
|
325
325
|
attr_accessor :default_credential_manager_acs_system_id
|
|
326
|
-
# Brand-specific terminology for the [access control system](https://
|
|
326
|
+
# Brand-specific terminology for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) type.
|
|
327
327
|
# @return [String, nil]
|
|
328
328
|
# Known values:
|
|
329
329
|
# - `pti_site`
|
|
@@ -344,19 +344,19 @@ module Seam
|
|
|
344
344
|
# - `kisi_organization`
|
|
345
345
|
# - `akiles_organization`
|
|
346
346
|
attr_accessor :external_type
|
|
347
|
-
# Display name that corresponds to the brand-specific terminology for the [access control system](https://
|
|
347
|
+
# Display name that corresponds to the brand-specific terminology for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) type.
|
|
348
348
|
# @return [String, nil]
|
|
349
349
|
attr_accessor :external_type_display_name
|
|
350
|
-
# Alternative text for the [access control system](https://
|
|
350
|
+
# Alternative text for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) image.
|
|
351
351
|
# @return [String]
|
|
352
352
|
attr_accessor :image_alt_text
|
|
353
|
-
# URL for the image that represents the [access control system](https://
|
|
353
|
+
# URL for the image that represents the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
354
354
|
# @return [String]
|
|
355
355
|
attr_accessor :image_url
|
|
356
356
|
# Indicates whether the `acs_system` is a credential manager.
|
|
357
357
|
# @return [Boolean]
|
|
358
358
|
attr_accessor :is_credential_manager
|
|
359
|
-
# Name of the [access control system](https://
|
|
359
|
+
# Name of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
360
360
|
# @return [String]
|
|
361
361
|
attr_accessor :name
|
|
362
362
|
# @return [String, nil]
|
|
@@ -383,11 +383,11 @@ module Seam
|
|
|
383
383
|
# @return [String, nil]
|
|
384
384
|
# @deprecated Use `external_type_display_name`.
|
|
385
385
|
attr_accessor :system_type_display_name
|
|
386
|
-
# ID of the workspace that contains the [access control system](https://
|
|
386
|
+
# ID of the workspace that contains the [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
387
387
|
# @return [String]
|
|
388
388
|
attr_accessor :workspace_id
|
|
389
389
|
|
|
390
|
-
# Date and time at which the [access control system](https://
|
|
390
|
+
# Date and time at which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) was created.
|
|
391
391
|
# @return [Time]
|
|
392
392
|
date_accessor :created_at
|
|
393
393
|
end
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
module Seam
|
|
4
4
|
module Resources
|
|
5
|
-
# Represents a [user](https://
|
|
5
|
+
# Represents a [user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
6
6
|
#
|
|
7
7
|
# An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period.
|
|
8
8
|
#
|
|
9
|
-
# For details about how to configure users in your access system, see the corresponding [system integration guide](https://
|
|
9
|
+
# For details about how to configure users in your access system, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems).
|
|
10
10
|
class AcsUser < BaseResource
|
|
11
11
|
class AccessSchedule < BaseResource
|
|
12
12
|
# Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
@@ -19,7 +19,7 @@ module Seam
|
|
|
19
19
|
|
|
20
20
|
# Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
|
|
21
21
|
class Errors < BaseResource
|
|
22
|
-
# Indicates that the [access system user](https://
|
|
22
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems) outside of Seam.
|
|
23
23
|
class DeletedExternally < Errors
|
|
24
24
|
# @return [String]
|
|
25
25
|
# Known values:
|
|
@@ -33,7 +33,7 @@ module Seam
|
|
|
33
33
|
date_accessor :created_at
|
|
34
34
|
end
|
|
35
35
|
|
|
36
|
-
# Indicates that the [access system user](https://
|
|
36
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
|
|
37
37
|
class SaltoKsSubscriptionLimitExceeded < Errors
|
|
38
38
|
# @return [String]
|
|
39
39
|
# Known values:
|
|
@@ -47,7 +47,7 @@ module Seam
|
|
|
47
47
|
date_accessor :created_at
|
|
48
48
|
end
|
|
49
49
|
|
|
50
|
-
# Indicates that the [access system user](https://
|
|
50
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not created on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
|
|
51
51
|
class FailedToCreateOnAcsSystem < Errors
|
|
52
52
|
# @return [String]
|
|
53
53
|
# Known values:
|
|
@@ -61,7 +61,7 @@ module Seam
|
|
|
61
61
|
date_accessor :created_at
|
|
62
62
|
end
|
|
63
63
|
|
|
64
|
-
# Indicates that the [access system user](https://
|
|
64
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not updated on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
|
|
65
65
|
class FailedToUpdateOnAcsSystem < Errors
|
|
66
66
|
# @return [String]
|
|
67
67
|
# Known values:
|
|
@@ -75,7 +75,7 @@ module Seam
|
|
|
75
75
|
date_accessor :created_at
|
|
76
76
|
end
|
|
77
77
|
|
|
78
|
-
# Indicates that the [access system user](https://
|
|
78
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
|
|
79
79
|
class FailedToDeleteOnAcsSystem < Errors
|
|
80
80
|
# @return [String]
|
|
81
81
|
# Known values:
|
|
@@ -89,7 +89,7 @@ module Seam
|
|
|
89
89
|
date_accessor :created_at
|
|
90
90
|
end
|
|
91
91
|
|
|
92
|
-
# Indicates that the [access system user](https://
|
|
92
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co).
|
|
93
93
|
class LatchConflictWithResidentUser < Errors
|
|
94
94
|
# @return [String]
|
|
95
95
|
# Known values:
|
|
@@ -227,7 +227,7 @@ module Seam
|
|
|
227
227
|
|
|
228
228
|
# Known `warning_code` values load as subclasses; unknown values remain Warnings instances for forward compatibility.
|
|
229
229
|
class Warnings < BaseResource
|
|
230
|
-
# Indicates that the [access system user](https://
|
|
230
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly.
|
|
231
231
|
class BeingDeleted < Warnings
|
|
232
232
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
233
233
|
# @return [String]
|
|
@@ -241,7 +241,7 @@ module Seam
|
|
|
241
241
|
date_accessor :created_at
|
|
242
242
|
end
|
|
243
243
|
|
|
244
|
-
# Indicates that the [access system user](https://
|
|
244
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.
|
|
245
245
|
class SaltoKsUserNotSubscribed < Warnings
|
|
246
246
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
247
247
|
# @return [String]
|
|
@@ -255,7 +255,7 @@ module Seam
|
|
|
255
255
|
date_accessor :created_at
|
|
256
256
|
end
|
|
257
257
|
|
|
258
|
-
# Indicates that the [access system user](https://
|
|
258
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) exists but is not currently able to gain access—for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked.
|
|
259
259
|
class AcsUserInactive < Warnings
|
|
260
260
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
261
261
|
# @return [String]
|
|
@@ -269,7 +269,7 @@ module Seam
|
|
|
269
269
|
date_accessor :created_at
|
|
270
270
|
end
|
|
271
271
|
|
|
272
|
-
# An unknown issue occurred while syncing the state of this [access system user](https://
|
|
272
|
+
# An unknown issue occurred while syncing the state of this [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.
|
|
273
273
|
class UnknownIssueWithAcsUser < Warnings
|
|
274
274
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
275
275
|
# @return [String]
|
|
@@ -283,7 +283,7 @@ module Seam
|
|
|
283
283
|
date_accessor :created_at
|
|
284
284
|
end
|
|
285
285
|
|
|
286
|
-
# Indicates that the [access system user](https://
|
|
286
|
+
# Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user.
|
|
287
287
|
class LatchResidentUser < Warnings
|
|
288
288
|
# Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
289
289
|
# @return [String]
|
|
@@ -321,43 +321,43 @@ module Seam
|
|
|
321
321
|
}.freeze
|
|
322
322
|
end
|
|
323
323
|
|
|
324
|
-
# `starts_at` and `ends_at` timestamps for the [access system user's](https://
|
|
324
|
+
# `starts_at` and `ends_at` timestamps for the [access system user's](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access.
|
|
325
325
|
# @return [AccessSchedule, nil]
|
|
326
326
|
resource_accessor :access_schedule, AccessSchedule
|
|
327
|
-
# Salto KS-specific metadata associated with the [access system user](https://
|
|
327
|
+
# Salto KS-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
328
328
|
# @return [SaltoKsMetadata, nil]
|
|
329
329
|
resource_accessor :salto_ks_metadata, SaltoKsMetadata
|
|
330
|
-
# Salto Space-specific metadata associated with the [access system user](https://
|
|
330
|
+
# Salto Space-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
331
331
|
# @return [SaltoSpaceMetadata, nil]
|
|
332
332
|
resource_accessor :salto_space_metadata, SaltoSpaceMetadata
|
|
333
|
-
# Errors associated with the [access system user](https://
|
|
333
|
+
# Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
334
334
|
# @return [Array<Errors>]
|
|
335
335
|
resource_list_accessor :errors, Errors
|
|
336
|
-
# Pending mutations associated with the [access system user](https://
|
|
336
|
+
# Pending mutations associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system.
|
|
337
337
|
# @return [Array<PendingMutations>]
|
|
338
338
|
resource_list_accessor :pending_mutations, PendingMutations
|
|
339
|
-
# Warnings associated with the [access system user](https://
|
|
339
|
+
# Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
340
340
|
# @return [Array<Warnings>]
|
|
341
341
|
resource_list_accessor :warnings, Warnings
|
|
342
|
-
# ID of the [access system](https://
|
|
342
|
+
# ID of the [access system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
343
343
|
# @return [String]
|
|
344
344
|
attr_accessor :acs_system_id
|
|
345
|
-
# ID of the [access system user](https://
|
|
345
|
+
# ID of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
346
346
|
# @return [String]
|
|
347
347
|
attr_accessor :acs_user_id
|
|
348
|
-
# The ID of the connected account that is associated with the [access system user](https://
|
|
348
|
+
# The ID of the connected account that is associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
349
349
|
# @return [String]
|
|
350
350
|
attr_accessor :connected_account_id
|
|
351
|
-
# Display name for the [access system user](https://
|
|
351
|
+
# Display name for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
352
352
|
# @return [String]
|
|
353
353
|
attr_accessor :display_name
|
|
354
354
|
# @return [String, nil]
|
|
355
355
|
# @deprecated use email_address.
|
|
356
356
|
attr_accessor :email
|
|
357
|
-
# Email address of the [access system user](https://
|
|
357
|
+
# Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
358
358
|
# @return [String, nil]
|
|
359
359
|
attr_accessor :email_address
|
|
360
|
-
# Brand-specific terminology for the [access system user](https://
|
|
360
|
+
# Brand-specific terminology for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) type.
|
|
361
361
|
# @return [String, nil]
|
|
362
362
|
# Known values:
|
|
363
363
|
# - `pti_user`
|
|
@@ -370,10 +370,10 @@ module Seam
|
|
|
370
370
|
# - `avigilon_alta_user`
|
|
371
371
|
# - `kisi_user`
|
|
372
372
|
attr_accessor :external_type
|
|
373
|
-
# Display name that corresponds to the brand-specific terminology for the [access system user](https://
|
|
373
|
+
# Display name that corresponds to the brand-specific terminology for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) type.
|
|
374
374
|
# @return [String, nil]
|
|
375
375
|
attr_accessor :external_type_display_name
|
|
376
|
-
# Full name of the [access system user](https://
|
|
376
|
+
# Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
377
377
|
# @return [String, nil]
|
|
378
378
|
attr_accessor :full_name
|
|
379
379
|
# ID of the HID access control system associated with the user.
|
|
@@ -382,29 +382,29 @@ module Seam
|
|
|
382
382
|
# Indicates whether Seam manages the access system user.
|
|
383
383
|
# @return [TrueClass]
|
|
384
384
|
attr_accessor :is_managed
|
|
385
|
-
# Indicates whether the [access system user](https://
|
|
385
|
+
# Indicates whether the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is currently [suspended](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users).
|
|
386
386
|
# @return [Boolean, nil]
|
|
387
387
|
attr_accessor :is_suspended
|
|
388
|
-
# Phone number of the [access system user](https://
|
|
388
|
+
# Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
|
|
389
389
|
# @return [String, nil]
|
|
390
390
|
attr_accessor :phone_number
|
|
391
|
-
# Email address of the user identity associated with the [access system user](https://
|
|
391
|
+
# Email address of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
392
392
|
# @return [String, nil]
|
|
393
393
|
attr_accessor :user_identity_email_address
|
|
394
|
-
# Full name of the user identity associated with the [access system user](https://
|
|
394
|
+
# Full name of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
395
395
|
# @return [String, nil]
|
|
396
396
|
attr_accessor :user_identity_full_name
|
|
397
|
-
# ID of the user identity associated with the [access system user](https://
|
|
397
|
+
# ID of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
398
398
|
# @return [String, nil]
|
|
399
399
|
attr_accessor :user_identity_id
|
|
400
|
-
# Phone number of the user identity associated with the [access system user](https://
|
|
400
|
+
# Phone number of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
|
|
401
401
|
# @return [String, nil]
|
|
402
402
|
attr_accessor :user_identity_phone_number
|
|
403
|
-
# ID of the workspace that contains the [access system user](https://
|
|
403
|
+
# ID of the workspace that contains the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
404
404
|
# @return [String]
|
|
405
405
|
attr_accessor :workspace_id
|
|
406
406
|
|
|
407
|
-
# Date and time at which the [access system user](https://
|
|
407
|
+
# Date and time at which the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created.
|
|
408
408
|
# @return [Time]
|
|
409
409
|
date_accessor :created_at
|
|
410
410
|
end
|