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
data/lib/seam/resources/batch.rb
CHANGED
|
@@ -4,15 +4,15 @@ module Seam
|
|
|
4
4
|
module Resources
|
|
5
5
|
# A batch of workspace resources.
|
|
6
6
|
class Batch < BaseResource
|
|
7
|
-
# Represents a smart lock [access code](https://
|
|
7
|
+
# Represents a smart lock [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
8
8
|
#
|
|
9
9
|
# An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
|
|
10
10
|
#
|
|
11
|
-
# Seam supports programming two types of access codes: [ongoing](https://
|
|
11
|
+
# Seam supports programming two types of access codes: [ongoing](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
12
12
|
#
|
|
13
|
-
# In addition, for certain devices, Seam also supports [offline access codes](https://
|
|
13
|
+
# In addition, for certain devices, Seam also supports [offline access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
14
14
|
#
|
|
15
|
-
# For granting a person access to a space, [Access Grants](https://
|
|
15
|
+
# For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
|
|
16
16
|
# @return [Hash, nil]
|
|
17
17
|
attr_accessor :access_codes
|
|
18
18
|
# Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
|
|
@@ -23,21 +23,21 @@ module Seam
|
|
|
23
23
|
attr_accessor :access_methods
|
|
24
24
|
# Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
|
|
25
25
|
#
|
|
26
|
-
# Some access control systems use [access group](https://
|
|
26
|
+
# Some access control systems use [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
|
|
27
27
|
#
|
|
28
|
-
# To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://
|
|
28
|
+
# To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems).
|
|
29
29
|
# @return [Hash, nil]
|
|
30
30
|
attr_accessor :acs_access_groups
|
|
31
|
-
# Means by which an [access control system user](https://
|
|
31
|
+
# Means by which an [access control system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) gains access at an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
32
32
|
#
|
|
33
33
|
# An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
|
|
34
34
|
#
|
|
35
35
|
# For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
|
|
36
36
|
#
|
|
37
|
-
# For granting a person access to a space, [Access Grants](https://
|
|
37
|
+
# For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.
|
|
38
38
|
# @return [Hash, nil]
|
|
39
39
|
attr_accessor :acs_credentials
|
|
40
|
-
# Represents a hardware device that encodes [credential](https://
|
|
40
|
+
# Represents a hardware device that encodes [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
41
41
|
#
|
|
42
42
|
# Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
|
|
43
43
|
#
|
|
@@ -48,38 +48,38 @@ module Seam
|
|
|
48
48
|
#
|
|
49
49
|
# Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
|
|
50
50
|
#
|
|
51
|
-
# See [Working with Card Encoders and Scanners](https://
|
|
51
|
+
# See [Working with Card Encoders and Scanners](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
52
52
|
#
|
|
53
|
-
# To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://
|
|
53
|
+
# To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems).
|
|
54
54
|
# @return [Hash, nil]
|
|
55
55
|
attr_accessor :acs_encoders
|
|
56
|
-
# Represents an [entrance](https://
|
|
56
|
+
# 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).
|
|
57
57
|
#
|
|
58
58
|
# 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.
|
|
59
59
|
# @return [Hash, nil]
|
|
60
60
|
attr_accessor :acs_entrances
|
|
61
|
-
# Represents an [access control system](https://
|
|
61
|
+
# Represents an [access control system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
62
62
|
#
|
|
63
|
-
# Within an `acs_system`, create [`acs_user`s](https://
|
|
63
|
+
# 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.
|
|
64
64
|
#
|
|
65
|
-
# For details about the resources associated with an access control system, see the [access control systems namespace](https://
|
|
65
|
+
# 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).
|
|
66
66
|
# @return [Hash, nil]
|
|
67
67
|
attr_accessor :acs_systems
|
|
68
|
-
# Represents a [user](https://
|
|
68
|
+
# 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).
|
|
69
69
|
#
|
|
70
70
|
# 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.
|
|
71
71
|
#
|
|
72
|
-
# For details about how to configure users in your access system, see the corresponding [system integration guide](https://
|
|
72
|
+
# 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).
|
|
73
73
|
# @return [Hash, nil]
|
|
74
74
|
attr_accessor :acs_users
|
|
75
75
|
# Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
|
|
76
76
|
#
|
|
77
77
|
# When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
|
|
78
78
|
#
|
|
79
|
-
# See also [Action Attempts](https://
|
|
79
|
+
# See also [Action Attempts](https://www.seam.co/docs/core-concepts/action-attempts).
|
|
80
80
|
# @return [Hash, nil]
|
|
81
81
|
attr_accessor :action_attempts
|
|
82
|
-
# Represents a [client session](https://
|
|
82
|
+
# Represents a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
83
83
|
#
|
|
84
84
|
# You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
|
|
85
85
|
#
|
|
@@ -87,10 +87,10 @@ module Seam
|
|
|
87
87
|
#
|
|
88
88
|
# A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
89
89
|
#
|
|
90
|
-
# See also [Get Started with React](https://
|
|
90
|
+
# See also [Get Started with React](https://www.seam.co/docs/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
|
|
91
91
|
# @return [Hash, nil]
|
|
92
92
|
attr_accessor :client_sessions
|
|
93
|
-
# Represents a [Connect Webview](https://
|
|
93
|
+
# Represents a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
94
94
|
#
|
|
95
95
|
# Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
|
|
96
96
|
#
|
|
@@ -103,10 +103,10 @@ module Seam
|
|
|
103
103
|
# To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.
|
|
104
104
|
# @return [Hash, nil]
|
|
105
105
|
attr_accessor :connect_webviews
|
|
106
|
-
# Represents a [connected account](https://
|
|
106
|
+
# Represents a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
|
|
107
107
|
# @return [Hash, nil]
|
|
108
108
|
attr_accessor :connected_accounts
|
|
109
|
-
# Represents a [device](https://
|
|
109
|
+
# Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.
|
|
110
110
|
# @return [Hash, nil]
|
|
111
111
|
attr_accessor :devices
|
|
112
112
|
# Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.
|
|
@@ -119,7 +119,7 @@ module Seam
|
|
|
119
119
|
# There’s no app to install, nor account to create. Your user just taps a link and gets a lightweight, native-feeling experience using iOS App Clip or Instant Apps on Android. Further, Instant Keys work offline, so even in areas with poor cellular or Wi-Fi, like elevator banks or concrete-walled hallways, the Instant Keys still work.
|
|
120
120
|
# @return [Hash, nil]
|
|
121
121
|
attr_accessor :instant_keys
|
|
122
|
-
# Represents a [noise threshold](https://
|
|
122
|
+
# Represents a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
|
|
123
123
|
# @return [Hash, nil]
|
|
124
124
|
attr_accessor :noise_thresholds
|
|
125
125
|
# Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.
|
|
@@ -128,10 +128,10 @@ module Seam
|
|
|
128
128
|
# Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
|
|
129
129
|
# @return [Hash, nil]
|
|
130
130
|
attr_accessor :thermostat_daily_programs
|
|
131
|
-
# Represents a [thermostat schedule](https://
|
|
131
|
+
# Represents a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
|
|
132
132
|
# @return [Hash, nil]
|
|
133
133
|
attr_accessor :thermostat_schedules
|
|
134
|
-
# Represents an [unmanaged smart lock access code](https://
|
|
134
|
+
# Represents an [unmanaged smart lock access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
135
135
|
#
|
|
136
136
|
# An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.
|
|
137
137
|
#
|
|
@@ -141,16 +141,16 @@ module Seam
|
|
|
141
141
|
#
|
|
142
142
|
# Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
|
|
143
143
|
#
|
|
144
|
-
# - [Kwikset](https://
|
|
144
|
+
# - [Kwikset](https://www.seam.co/docs/device-and-system-integration-guides/kwikset-locks)
|
|
145
145
|
# @return [Hash, nil]
|
|
146
146
|
attr_accessor :unmanaged_access_codes
|
|
147
|
-
# Represents an [unmanaged device](https://
|
|
147
|
+
# Represents an [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
148
148
|
# @return [Hash, nil]
|
|
149
149
|
attr_accessor :unmanaged_devices
|
|
150
|
-
# Represents a [user identity](https://
|
|
150
|
+
# Represents a [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
|
|
151
151
|
# @return [Hash, nil]
|
|
152
152
|
attr_accessor :user_identities
|
|
153
|
-
# Represents a Seam [workspace](https://
|
|
153
|
+
# Represents a Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://www.seam.co/docs/core-concepts/workspaces#production-workspaces).
|
|
154
154
|
# @return [Hash, nil]
|
|
155
155
|
attr_accessor :workspaces
|
|
156
156
|
end
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Seam
|
|
4
4
|
module Resources
|
|
5
|
-
# Represents a [client session](https://
|
|
5
|
+
# Represents a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
6
6
|
#
|
|
7
7
|
# You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
|
|
8
8
|
#
|
|
@@ -10,33 +10,33 @@ module Seam
|
|
|
10
10
|
#
|
|
11
11
|
# A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
12
12
|
#
|
|
13
|
-
# See also [Get Started with React](https://
|
|
13
|
+
# See also [Get Started with React](https://www.seam.co/docs/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
|
|
14
14
|
class ClientSession < BaseResource
|
|
15
15
|
# ID of the client session.
|
|
16
16
|
# @return [String]
|
|
17
17
|
attr_accessor :client_session_id
|
|
18
|
-
# IDs of the [Connect Webviews](https://
|
|
18
|
+
# IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
19
19
|
# @return [Array<String>]
|
|
20
20
|
attr_accessor :connect_webview_ids
|
|
21
|
-
# IDs of the [connected accounts](https://
|
|
21
|
+
# IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
22
22
|
# @return [Array<String>]
|
|
23
23
|
attr_accessor :connected_account_ids
|
|
24
|
-
# Customer key associated with the [client session](https://
|
|
24
|
+
# Customer key associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
25
25
|
# @return [String, nil]
|
|
26
26
|
attr_accessor :customer_key
|
|
27
|
-
# Number of devices associated with the [client session](https://
|
|
27
|
+
# Number of devices associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
28
28
|
# @return [Float]
|
|
29
29
|
attr_accessor :device_count
|
|
30
|
-
# Client session token associated with the [client session](https://
|
|
30
|
+
# Client session token associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
31
31
|
# @return [String]
|
|
32
32
|
attr_accessor :token
|
|
33
|
-
# Your user ID for the user associated with the [client session](https://
|
|
33
|
+
# Your user ID for the user associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
34
34
|
# @return [String, nil]
|
|
35
35
|
attr_accessor :user_identifier_key
|
|
36
|
-
# ID of the [user identity](https://
|
|
36
|
+
# ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
|
|
37
37
|
# @return [String, nil]
|
|
38
38
|
attr_accessor :user_identity_id
|
|
39
|
-
# IDs of the [user identities](https://
|
|
39
|
+
# IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
|
|
40
40
|
# @return [Array<String>]
|
|
41
41
|
# @deprecated Use `user_identity_id` instead.
|
|
42
42
|
attr_accessor :user_identity_ids
|
|
@@ -44,11 +44,11 @@ module Seam
|
|
|
44
44
|
# @return [String]
|
|
45
45
|
attr_accessor :workspace_id
|
|
46
46
|
|
|
47
|
-
# Date and time at which the [client session](https://
|
|
47
|
+
# Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) was created.
|
|
48
48
|
# @return [Time]
|
|
49
49
|
date_accessor :created_at
|
|
50
50
|
|
|
51
|
-
# Date and time at which the [client session](https://
|
|
51
|
+
# Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) expires.
|
|
52
52
|
# @return [Time]
|
|
53
53
|
date_accessor :expires_at
|
|
54
54
|
end
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Seam
|
|
4
4
|
module Resources
|
|
5
|
-
# Represents a [Connect Webview](https://
|
|
5
|
+
# Represents a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
6
6
|
#
|
|
7
7
|
# Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
|
|
8
8
|
#
|
|
@@ -23,13 +23,13 @@ module Seam
|
|
|
23
23
|
# - `access_control`
|
|
24
24
|
# - `camera`
|
|
25
25
|
attr_accessor :accepted_capabilities
|
|
26
|
-
# List of accepted [provider keys](https://
|
|
26
|
+
# List of accepted [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
|
|
27
27
|
# @return [Array<String>]
|
|
28
28
|
attr_accessor :accepted_providers
|
|
29
29
|
# Indicates whether any provider is allowed.
|
|
30
30
|
# @return [Boolean]
|
|
31
31
|
attr_accessor :any_provider_allowed
|
|
32
|
-
# Indicates whether Seam should [import all new devices](https://
|
|
32
|
+
# Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.
|
|
33
33
|
# @return [Boolean]
|
|
34
34
|
attr_accessor :automatically_manage_new_devices
|
|
35
35
|
# ID of the Connect Webview.
|
|
@@ -38,7 +38,7 @@ module Seam
|
|
|
38
38
|
# ID of the connected account associated with the Connect Webview.
|
|
39
39
|
# @return [String, nil]
|
|
40
40
|
attr_accessor :connected_account_id
|
|
41
|
-
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
41
|
+
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
42
42
|
# @return [Hash{String => String, Boolean}]
|
|
43
43
|
attr_accessor :custom_metadata
|
|
44
44
|
# URL to which the Connect Webview should redirect when an unexpected error occurs.
|
|
@@ -60,7 +60,7 @@ module Seam
|
|
|
60
60
|
# Indicates whether the user logged in successfully using the Connect Webview.
|
|
61
61
|
# @return [Boolean]
|
|
62
62
|
attr_accessor :login_successful
|
|
63
|
-
# Selected provider of the Connect Webview, one of the [provider keys](https://
|
|
63
|
+
# Selected provider of the Connect Webview, one of the [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
|
|
64
64
|
# @return [String, nil]
|
|
65
65
|
attr_accessor :selected_provider
|
|
66
66
|
# Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview.
|
|
@@ -73,7 +73,7 @@ module Seam
|
|
|
73
73
|
# URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user.
|
|
74
74
|
# @return [String]
|
|
75
75
|
attr_accessor :url
|
|
76
|
-
# Indicates whether Seam should [finish syncing all devices](https://
|
|
76
|
+
# Indicates whether Seam should [finish syncing all devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.
|
|
77
77
|
# @return [Boolean]
|
|
78
78
|
attr_accessor :wait_for_device_creation
|
|
79
79
|
# ID of the workspace that contains the Connect Webview.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Seam
|
|
4
4
|
module Resources
|
|
5
|
-
# Represents a [connected account](https://
|
|
5
|
+
# Represents a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
|
|
6
6
|
class ConnectedAccount < BaseResource
|
|
7
7
|
# Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
|
|
8
8
|
class Errors < BaseResource
|
|
@@ -13,7 +13,7 @@ module Seam
|
|
|
13
13
|
# Known values:
|
|
14
14
|
# - `account_disconnected`
|
|
15
15
|
attr_accessor :error_code
|
|
16
|
-
# Indicates whether the error is related to [Seam Bridge](https://
|
|
16
|
+
# Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
17
17
|
# @return [Boolean, nil]
|
|
18
18
|
attr_accessor :is_bridge_error
|
|
19
19
|
# Indicates whether the error is related specifically to the connected account.
|
|
@@ -27,14 +27,14 @@ 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://
|
|
30
|
+
# Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. 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).
|
|
31
31
|
class BridgeDisconnected < Errors
|
|
32
32
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
33
33
|
# @return [String]
|
|
34
34
|
# Known values:
|
|
35
35
|
# - `bridge_disconnected`
|
|
36
36
|
attr_accessor :error_code
|
|
37
|
-
# Indicates whether the error is related to [Seam Bridge](https://
|
|
37
|
+
# Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
38
38
|
# @return [Boolean, nil]
|
|
39
39
|
attr_accessor :is_bridge_error
|
|
40
40
|
# Indicates whether the error is related specifically to the connected account.
|
|
@@ -79,7 +79,7 @@ module Seam
|
|
|
79
79
|
# Known values:
|
|
80
80
|
# - `salto_ks_subscription_limit_exceeded`
|
|
81
81
|
attr_accessor :error_code
|
|
82
|
-
# Indicates whether the error is related to [Seam Bridge](https://
|
|
82
|
+
# Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
83
83
|
# @return [Boolean, nil]
|
|
84
84
|
attr_accessor :is_bridge_error
|
|
85
85
|
# Indicates whether the error is related specifically to the connected account.
|
|
@@ -100,7 +100,7 @@ module Seam
|
|
|
100
100
|
# Known values:
|
|
101
101
|
# - `dormakaba_sites_disconnected`
|
|
102
102
|
attr_accessor :error_code
|
|
103
|
-
# Indicates whether the error is related to [Seam Bridge](https://
|
|
103
|
+
# Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
104
104
|
# @return [Boolean, nil]
|
|
105
105
|
attr_accessor :is_bridge_error
|
|
106
106
|
# Indicates whether the error is related specifically to the connected account.
|
|
@@ -122,7 +122,7 @@ module Seam
|
|
|
122
122
|
# - `salto_ks_subscription_limit_exceeded`
|
|
123
123
|
# - `dormakaba_sites_disconnected`
|
|
124
124
|
attr_accessor :error_code
|
|
125
|
-
# Indicates whether the error is related to [Seam Bridge](https://
|
|
125
|
+
# Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
126
126
|
# @return [Boolean, nil]
|
|
127
127
|
attr_accessor :is_bridge_error
|
|
128
128
|
# Indicates whether the error is related specifically to the connected account.
|
|
@@ -362,13 +362,13 @@ module Seam
|
|
|
362
362
|
# Display name for the connected account type.
|
|
363
363
|
# @return [String]
|
|
364
364
|
attr_accessor :account_type_display_name
|
|
365
|
-
# Indicates whether Seam should [import all new devices](https://
|
|
365
|
+
# Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API.
|
|
366
366
|
# @return [Boolean]
|
|
367
367
|
attr_accessor :automatically_manage_new_devices
|
|
368
368
|
# ID of the connected account.
|
|
369
369
|
# @return [String]
|
|
370
370
|
attr_accessor :connected_account_id
|
|
371
|
-
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
371
|
+
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
372
372
|
# @return [Hash{String => String, Boolean}]
|
|
373
373
|
attr_accessor :custom_metadata
|
|
374
374
|
# Your unique key for the customer associated with this connected account.
|