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.
Files changed (68) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/lib/seam/resources/access_code.rb +18 -18
  4. data/lib/seam/resources/access_grant.rb +4 -4
  5. data/lib/seam/resources/access_method.rb +9 -9
  6. data/lib/seam/resources/acs_access_group.rb +3 -3
  7. data/lib/seam/resources/acs_credential.rb +35 -35
  8. data/lib/seam/resources/acs_encoder.rb +10 -10
  9. data/lib/seam/resources/acs_entrance.rb +20 -20
  10. data/lib/seam/resources/acs_system.rb +37 -37
  11. data/lib/seam/resources/acs_user.rb +35 -35
  12. data/lib/seam/resources/action_attempt.rb +101 -101
  13. data/lib/seam/resources/batch.rb +30 -30
  14. data/lib/seam/resources/client_session.rb +12 -12
  15. data/lib/seam/resources/connect_webview.rb +6 -6
  16. data/lib/seam/resources/connected_account.rb +9 -9
  17. data/lib/seam/resources/device.rb +84 -84
  18. data/lib/seam/resources/event.rb +60 -60
  19. data/lib/seam/resources/noise_threshold.rb +2 -2
  20. data/lib/seam/resources/phone.rb +1 -1
  21. data/lib/seam/resources/thermostat_daily_program.rb +1 -1
  22. data/lib/seam/resources/thermostat_schedule.rb +11 -11
  23. data/lib/seam/resources/unmanaged_access_code.rb +15 -15
  24. data/lib/seam/resources/unmanaged_access_grant.rb +4 -4
  25. data/lib/seam/resources/unmanaged_access_method.rb +9 -9
  26. data/lib/seam/resources/unmanaged_device.rb +10 -10
  27. data/lib/seam/resources/user_identity.rb +1 -1
  28. data/lib/seam/resources/webhook.rb +4 -4
  29. data/lib/seam/resources/workspace.rb +12 -12
  30. data/lib/seam/routes/access_codes.rb +28 -28
  31. data/lib/seam/routes/access_codes_simulate.rb +1 -1
  32. data/lib/seam/routes/access_codes_unmanaged.rb +9 -9
  33. data/lib/seam/routes/access_grants.rb +3 -3
  34. data/lib/seam/routes/access_methods.rb +2 -2
  35. data/lib/seam/routes/acs_access_groups.rb +7 -7
  36. data/lib/seam/routes/acs_credentials.rb +11 -11
  37. data/lib/seam/routes/acs_encoders.rb +5 -5
  38. data/lib/seam/routes/acs_encoders_simulate.rb +4 -4
  39. data/lib/seam/routes/acs_entrances.rb +5 -5
  40. data/lib/seam/routes/acs_systems.rb +3 -3
  41. data/lib/seam/routes/acs_users.rb +16 -16
  42. data/lib/seam/routes/action_attempts.rb +2 -2
  43. data/lib/seam/routes/client_sessions.rb +22 -22
  44. data/lib/seam/routes/connect_webviews.rb +11 -11
  45. data/lib/seam/routes/connected_accounts.rb +7 -7
  46. data/lib/seam/routes/connected_accounts_simulate.rb +1 -1
  47. data/lib/seam/routes/devices.rb +9 -9
  48. data/lib/seam/routes/devices_simulate.rb +3 -3
  49. data/lib/seam/routes/devices_unmanaged.rb +6 -6
  50. data/lib/seam/routes/events.rb +2 -2
  51. data/lib/seam/routes/instant_keys.rb +3 -3
  52. data/lib/seam/routes/locks.rb +5 -5
  53. data/lib/seam/routes/locks_simulate.rb +2 -2
  54. data/lib/seam/routes/noise_sensors.rb +1 -1
  55. data/lib/seam/routes/noise_sensors_noise_thresholds.rb +7 -7
  56. data/lib/seam/routes/noise_sensors_simulate.rb +1 -1
  57. data/lib/seam/routes/phones.rb +4 -4
  58. data/lib/seam/routes/phones_simulate.rb +1 -1
  59. data/lib/seam/routes/spaces.rb +4 -4
  60. data/lib/seam/routes/thermostats.rb +43 -43
  61. data/lib/seam/routes/thermostats_schedules.rb +11 -11
  62. data/lib/seam/routes/thermostats_simulate.rb +6 -6
  63. data/lib/seam/routes/user_identities.rb +15 -15
  64. data/lib/seam/routes/user_identities_unmanaged.rb +3 -3
  65. data/lib/seam/routes/webhooks.rb +5 -5
  66. data/lib/seam/routes/workspaces.rb +8 -8
  67. data/lib/seam/version.rb +1 -1
  68. metadata +1 -1
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Seam
4
4
  module Resources
5
- # Represents an [unmanaged smart lock access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
5
+ # Represents an [unmanaged smart lock access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
6
6
  #
7
7
  # 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.
8
8
  #
@@ -12,7 +12,7 @@ module Seam
12
12
  #
13
13
  # Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
14
14
  #
15
- # - [Kwikset](https://docs.seam.co/device-and-system-integration-guides/kwikset-locks)
15
+ # - [Kwikset](https://www.seam.co/docs/device-and-system-integration-guides/kwikset-locks)
16
16
  class UnmanagedAccessCode < BaseResource
17
17
  class DormakabaOracodeMetadata < BaseResource
18
18
  # Indicates whether the stay can be cancelled via the Dormakaba Oracode API.
@@ -251,11 +251,11 @@ module Seam
251
251
  end
252
252
 
253
253
  # This access code is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and this error clears automatically once the access code is no longer active.
254
- class FailedToExpire < Errors
254
+ class FailedToRemove < Errors
255
255
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
256
256
  # @return [String]
257
257
  # Known values:
258
- # - `failed_to_expire`
258
+ # - `failed_to_remove`
259
259
  attr_accessor :error_code
260
260
  # Indicates that this is an access code error.
261
261
  # @return [TrueClass]
@@ -275,7 +275,7 @@ module Seam
275
275
  # Known values:
276
276
  # - `account_disconnected`
277
277
  attr_accessor :error_code
278
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
278
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
279
279
  # @return [TrueClass]
280
280
  attr_accessor :is_connected_account_error
281
281
  # Indicates that the error is not a device error.
@@ -296,7 +296,7 @@ module Seam
296
296
  # Known values:
297
297
  # - `salto_ks_subscription_limit_exceeded`
298
298
  attr_accessor :error_code
299
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
299
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
300
300
  # @return [TrueClass]
301
301
  attr_accessor :is_connected_account_error
302
302
  # Indicates that the error is not a device error.
@@ -317,7 +317,7 @@ module Seam
317
317
  # Known values:
318
318
  # - `insufficient_permissions`
319
319
  attr_accessor :error_code
320
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
320
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
321
321
  # @return [TrueClass]
322
322
  attr_accessor :is_connected_account_error
323
323
  # Indicates that the error is not a device error.
@@ -338,7 +338,7 @@ module Seam
338
338
  # Known values:
339
339
  # - `dormakaba_sites_disconnected`
340
340
  attr_accessor :error_code
341
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
341
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
342
342
  # @return [TrueClass]
343
343
  attr_accessor :is_connected_account_error
344
344
  # Indicates that the error is not a device error.
@@ -424,7 +424,7 @@ module Seam
424
424
  date_accessor :created_at
425
425
  end
426
426
 
427
- # Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
427
+ # Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
428
428
  class EmptyBackupAccessCodePool < Errors
429
429
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
430
430
  # @return [String]
@@ -514,14 +514,14 @@ module Seam
514
514
  date_accessor :created_at
515
515
  end
516
516
 
517
- # Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/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://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
517
+ # 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).
518
518
  class BridgeDisconnected < Errors
519
519
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
520
520
  # @return [String]
521
521
  # Known values:
522
522
  # - `bridge_disconnected`
523
523
  attr_accessor :error_code
524
- # Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
524
+ # Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
525
525
  # @return [Boolean, nil]
526
526
  attr_accessor :is_bridge_error
527
527
  # Indicates whether the error is related specifically to the connected account.
@@ -548,7 +548,7 @@ module Seam
548
548
  # - `code_constraints_violated`
549
549
  # - `failed_to_issue`
550
550
  # - `failed_to_update`
551
- # - `failed_to_expire`
551
+ # - `failed_to_remove`
552
552
  # - `account_disconnected`
553
553
  # - `salto_ks_subscription_limit_exceeded`
554
554
  # - `insufficient_permissions`
@@ -582,7 +582,7 @@ module Seam
582
582
  "code_constraints_violated" => CodeConstraintsViolated,
583
583
  "failed_to_issue" => FailedToIssue,
584
584
  "failed_to_update" => FailedToUpdate,
585
- "failed_to_expire" => FailedToExpire,
585
+ "failed_to_remove" => FailedToRemove,
586
586
  "account_disconnected" => AccountDisconnected,
587
587
  "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
588
588
  "insufficient_permissions" => InsufficientPermissions,
@@ -845,10 +845,10 @@ module Seam
845
845
  # Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.
846
846
  # @return [DormakabaOracodeMetadata, nil]
847
847
  resource_accessor :dormakaba_oracode_metadata, DormakabaOracodeMetadata
848
- # Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
848
+ # Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
849
849
  # @return [Array<Errors>]
850
850
  resource_list_accessor :errors, Errors
851
- # Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
851
+ # Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
852
852
  # @return [Array<Warnings>]
853
853
  resource_list_accessor :warnings, Warnings
854
854
  # Unique identifier for the access code.
@@ -116,7 +116,7 @@ module Seam
116
116
 
117
117
  # Known `warning_code` values load as subclasses; unknown values remain Warnings instances for forward compatibility.
118
118
  class Warnings < BaseResource
119
- # Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted.
119
+ # Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted.
120
120
  class BeingDeleted < Warnings
121
121
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
122
122
  # @return [String]
@@ -176,7 +176,7 @@ module Seam
176
176
  date_accessor :created_at
177
177
  end
178
178
 
179
- # Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated.
179
+ # Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated.
180
180
  class UpdatingAccessTimes < Warnings
181
181
  # IDs of the access methods being updated.
182
182
  # @return [Array<String>]
@@ -290,7 +290,7 @@ module Seam
290
290
  }.freeze
291
291
  end
292
292
 
293
- # Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
293
+ # Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
294
294
  # @return [Array<Errors>]
295
295
  resource_list_accessor :errors, Errors
296
296
  # List of pending mutations for the access grant. This shows updates that are in progress.
@@ -299,7 +299,7 @@ module Seam
299
299
  # Access methods that the user requested for the Access Grant.
300
300
  # @return [Array<RequestedAccessMethods>]
301
301
  resource_list_accessor :requested_access_methods, RequestedAccessMethods
302
- # Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access).
302
+ # Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access).
303
303
  # @return [Array<Warnings>]
304
304
  resource_list_accessor :warnings, Warnings
305
305
  # ID of the Access Grant.
@@ -6,7 +6,7 @@ module Seam
6
6
  class UnmanagedAccessMethod < BaseResource
7
7
  # Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
8
8
  class Errors < BaseResource
9
- # Indicates that Seam was unable to issue this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.
9
+ # Indicates that Seam was unable to issue this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) before its access grant started, so the recipient may be unable to access the space. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access method is eventually issued.
10
10
  class FailedToIssue < Errors
11
11
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
12
12
  # @return [String]
@@ -79,7 +79,7 @@ module Seam
79
79
 
80
80
  # Known `warning_code` values load as subclasses; unknown values remain Warnings instances for forward compatibility.
81
81
  class Warnings < BaseResource
82
- # Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted.
82
+ # Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted.
83
83
  class BeingDeleted < Warnings
84
84
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
85
85
  # @return [String]
@@ -94,7 +94,7 @@ module Seam
94
94
  date_accessor :created_at
95
95
  end
96
96
 
97
- # Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated.
97
+ # Indicates that the access times for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) are being updated.
98
98
  class UpdatingAccessTimes < Warnings
99
99
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
100
100
  # @return [String]
@@ -127,7 +127,7 @@ module Seam
127
127
  date_accessor :created_at
128
128
  end
129
129
 
130
- # Indicates that Seam has not yet issued this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
130
+ # Indicates that Seam has not yet issued this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), even though its access grant is about to begin, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.
131
131
  class DelayInIssuing < Warnings
132
132
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
133
133
  # @return [String]
@@ -142,7 +142,7 @@ module Seam
142
142
  date_accessor :created_at
143
143
  end
144
144
 
145
- # Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant.
145
+ # Indicates that the access system delivers this mobile key through an app invitation sent to the recipient's email address, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no email address, so the mobile key cannot be delivered. Set an email address on the user identity when you create the access grant.
146
146
  class UserIdentityMissingEmailAddress < Warnings
147
147
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
148
148
  # @return [String]
@@ -157,7 +157,7 @@ module Seam
157
157
  date_accessor :created_at
158
158
  end
159
159
 
160
- # Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant.
160
+ # Indicates that the access system delivers this mobile key to the recipient's phone number, but the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities) for this [access grant](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) has no phone number, so the mobile key cannot be delivered. Set a phone number on the user identity when you create the access grant.
161
161
  class UserIdentityMissingPhoneNumber < Warnings
162
162
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
163
163
  # @return [String]
@@ -199,13 +199,13 @@ module Seam
199
199
  }.freeze
200
200
  end
201
201
 
202
- # Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
202
+ # Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
203
203
  # @return [Array<Errors>]
204
204
  resource_list_accessor :errors, Errors
205
- # Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
205
+ # Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress.
206
206
  # @return [Array<PendingMutations>]
207
207
  resource_list_accessor :pending_mutations, PendingMutations
208
- # Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant).
208
+ # Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
209
209
  # @return [Array<Warnings>]
210
210
  resource_list_accessor :warnings, Warnings
211
211
  # ID of the access method.
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Seam
4
4
  module Resources
5
- # Represents an [unmanaged device](https://docs.seam.co/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://docs.seam.co/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://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
5
+ # 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).
6
6
  class UnmanagedDevice < 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 that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
16
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
17
17
  # @return [TrueClass]
18
18
  attr_accessor :is_connected_account_error
19
19
  # Indicates that the error is not a device error.
@@ -34,7 +34,7 @@ module Seam
34
34
  # Known values:
35
35
  # - `salto_ks_subscription_limit_exceeded`
36
36
  attr_accessor :error_code
37
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
37
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
38
38
  # @return [TrueClass]
39
39
  attr_accessor :is_connected_account_error
40
40
  # Indicates that the error is not a device error.
@@ -55,7 +55,7 @@ module Seam
55
55
  # Known values:
56
56
  # - `insufficient_permissions`
57
57
  attr_accessor :error_code
58
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
58
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
59
59
  # @return [TrueClass]
60
60
  attr_accessor :is_connected_account_error
61
61
  # Indicates that the error is not a device error.
@@ -76,7 +76,7 @@ module Seam
76
76
  # Known values:
77
77
  # - `dormakaba_sites_disconnected`
78
78
  attr_accessor :error_code
79
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
79
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
80
80
  # @return [TrueClass]
81
81
  attr_accessor :is_connected_account_error
82
82
  # Indicates that the error is not a device error.
@@ -162,7 +162,7 @@ module Seam
162
162
  date_accessor :created_at
163
163
  end
164
164
 
165
- # Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
165
+ # Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
166
166
  class EmptyBackupAccessCodePool < Errors
167
167
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
168
168
  # @return [String]
@@ -252,14 +252,14 @@ module Seam
252
252
  date_accessor :created_at
253
253
  end
254
254
 
255
- # Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/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://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
255
+ # 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).
256
256
  class BridgeDisconnected < Errors
257
257
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
258
258
  # @return [String]
259
259
  # Known values:
260
260
  # - `bridge_disconnected`
261
261
  attr_accessor :error_code
262
- # Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
262
+ # Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
263
263
  # @return [Boolean, nil]
264
264
  attr_accessor :is_bridge_error
265
265
  # Indicates whether the error is related specifically to the connected account.
@@ -994,7 +994,7 @@ module Seam
994
994
  # Indicates whether the lock supports unlocking with an access code.
995
995
  # @return [Boolean, nil]
996
996
  attr_accessor :can_unlock_with_code
997
- # Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags).
997
+ # Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
998
998
  # @return [Array<String>]
999
999
  # Known values:
1000
1000
  # - `access_code`
@@ -1007,7 +1007,7 @@ module Seam
1007
1007
  # Unique identifier for the account associated with the device.
1008
1008
  # @return [String]
1009
1009
  attr_accessor :connected_account_id
1010
- # Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/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.
1010
+ # 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.
1011
1011
  # @return [Hash{String => String, Boolean}]
1012
1012
  attr_accessor :custom_metadata
1013
1013
  # ID of the device.
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Seam
4
4
  module Resources
5
- # Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
5
+ # 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.
6
6
  class UserIdentity < BaseResource
7
7
  # Known `error_code` values load as subclasses; unknown values remain Errors instances for forward compatibility.
8
8
  class Errors < BaseResource
@@ -2,15 +2,15 @@
2
2
 
3
3
  module Seam
4
4
  module Resources
5
- # Represents a [webhook](https://docs.seam.co/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.
5
+ # Represents a [webhook](https://www.seam.co/docs/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.
6
6
  class Webhook < BaseResource
7
- # Types of events that the [webhook](https://docs.seam.co/developer-tools/webhooks) should receive.
7
+ # Types of events that the [webhook](https://www.seam.co/docs/developer-tools/webhooks) should receive.
8
8
  # @return [Array<String>]
9
9
  attr_accessor :event_types
10
- # Secret associated with the [webhook](https://docs.seam.co/developer-tools/webhooks).
10
+ # Secret associated with the [webhook](https://www.seam.co/docs/developer-tools/webhooks).
11
11
  # @return [String, nil]
12
12
  attr_accessor :secret
13
- # URL for the [webhook](https://docs.seam.co/developer-tools/webhooks).
13
+ # URL for the [webhook](https://www.seam.co/docs/developer-tools/webhooks).
14
14
  # @return [String]
15
15
  attr_accessor :url
16
16
  # ID of the webhook.
@@ -2,54 +2,54 @@
2
2
 
3
3
  module Seam
4
4
  module Resources
5
- # Represents a Seam [workspace](https://docs.seam.co/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://docs.seam.co/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://docs.seam.co/core-concepts/workspaces#production-workspaces).
5
+ # 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).
6
6
  class Workspace < BaseResource
7
7
  class ConnectWebviewCustomization < BaseResource
8
- # URL of the inviter logo for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
8
+ # URL of the inviter logo for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
9
9
  # @return [String, nil]
10
10
  attr_accessor :inviter_logo_url
11
- # Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
11
+ # Logo shape for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
12
12
  # @return [String, nil]
13
13
  # Known values:
14
14
  # - `circle`
15
15
  # - `square`
16
16
  attr_accessor :logo_shape
17
- # Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
17
+ # Primary button color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
18
18
  # @return [String, nil]
19
19
  attr_accessor :primary_button_color
20
- # Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
20
+ # Primary button text color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
21
21
  # @return [String, nil]
22
22
  attr_accessor :primary_button_text_color
23
- # Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
23
+ # Success message for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
24
24
  # @return [String, nil]
25
25
  attr_accessor :success_message
26
26
  end
27
27
 
28
28
  # @return [ConnectWebviewCustomization]
29
29
  resource_accessor :connect_webview_customization, ConnectWebviewCustomization
30
- # Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces).
30
+ # Company name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
31
31
  # @return [String]
32
32
  # @deprecated Use `connect_partner_name` instead.
33
33
  attr_accessor :company_name
34
- # Seam Connect partner name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces).
34
+ # Seam Connect partner name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
35
35
  # @return [String, nil]
36
36
  attr_accessor :connect_partner_name
37
37
  # Indicates whether publishable key authentication is enabled for this workspace.
38
38
  # @return [Boolean]
39
39
  attr_accessor :is_publishable_key_auth_enabled
40
- # Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
40
+ # Indicates whether the workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
41
41
  # @return [Boolean]
42
42
  attr_accessor :is_sandbox
43
- # Indicates whether the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.
43
+ # Indicates whether the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.
44
44
  # @return [Boolean]
45
45
  attr_accessor :is_suspended
46
- # Name of the [workspace](https://docs.seam.co/core-concepts/workspaces).
46
+ # Name of the [workspace](https://www.seam.co/docs/core-concepts/workspaces).
47
47
  # @return [String]
48
48
  attr_accessor :name
49
49
  # ID of the organization to which the workspace belongs, or `null` if the workspace is not assigned to an organization.
50
50
  # @return [String, nil]
51
51
  attr_accessor :organization_id
52
- # Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.
52
+ # Publishable key for the [workspace](https://www.seam.co/docs/core-concepts/workspaces). This key is used to identify the workspace in client-side applications.
53
53
  # @return [String, nil]
54
54
  attr_accessor :publishable_key
55
55
  # ID of the workspace.