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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2798eb3b2b95fac5a6be01f3cca2e86883a7481b333b5742d108c4e3d0d6516d
4
- data.tar.gz: 4d6421e4c3123a84b96fffa3f71bd82c12de363e9bfcdaea4a7c46bacca31978
3
+ metadata.gz: 25a61d2b647b8a194add41ffc332ab8708743ace9d8a6d203fb3acfb768c5475
4
+ data.tar.gz: 224f3aee42977300ca859d37b15b29950cda8ceb384f75269695591e2c96c388
5
5
  SHA512:
6
- metadata.gz: '097fa833f6fc51b938d28ee9f25632e3ab8031e4b631a678c3d21ecf2540c06f9a3c9d317d041baa2915d683ae59f2b2242176352a350b28b3e29852fc15bba2'
7
- data.tar.gz: 1f74cae81dcdd44451eb26c57d0d8f5ab6b20c400d730641bff973f0a8bb37d66fb970f3b14c5b8b23c22506033a44957fe4e8fd4d1392a34aa643e295acd8cd
6
+ metadata.gz: d7ed8024b8644b021a0abec47ea4eb454e2c46449f7875f5e684a9983b4069ccf2622d3735dbd949ef704d04f7f84271c51c37305e43b941416cb331ac7b8e9d
7
+ data.tar.gz: bee8647cdaa28d0102de7b04ec20ee298ed4cdf6374acc54ed6195e130eabb6dfccedce6fb559b1e85415c6575b39a1219c8052a70ea02d40c8fe9d9eb1a13e3
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- seam (2.157.0)
4
+ seam (2.158.0)
5
5
  faraday (~> 2.7)
6
6
  faraday-retry (~> 2.2)
7
7
  svix (~> 1.30)
@@ -171,7 +171,7 @@ CHECKSUMS
171
171
  rubocop-ast (1.50.0) sha256=b9ca88300da0803ee222ad20cdb30494c0a784eed06fdc35d254b06d662788db
172
172
  rubocop-performance (1.26.1) sha256=cd19b936ff196df85829d264b522fd4f98b6c89ad271fa52744a8c11b8f71834
173
173
  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
174
- seam (2.157.0)
174
+ seam (2.158.0)
175
175
  simplecov (1.1.1) sha256=25825ef13f0b2e74694d769817dad6ab8e90131dabdaa666e522fea105521e78
176
176
  simplecov-console (0.9.5) sha256=b1108bcfff5f210143e2b8301698c367b01586f20d25a73e95475a5df6fc6ff6
177
177
  standard (1.56.0) sha256=ae2af4d9669589162ac69ed5ef59dcf9f346d4afc81f7e62b84339310dfcb787
@@ -2,15 +2,15 @@
2
2
 
3
3
  module Seam
4
4
  module Resources
5
- # Represents a smart lock [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
5
+ # Represents a smart lock [access code](https://www.seam.co/docs/low-level-apis/smart-locks/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. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
8
8
  #
9
- # Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/low-level-apis/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/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.
9
+ # 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.
10
10
  #
11
- # In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/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.
11
+ # 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.
12
12
  #
13
- # For granting a person access to a space, [Access Grants](https://docs.seam.co/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.
13
+ # 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.
14
14
  class AccessCode < BaseResource
15
15
  class DormakabaOracodeMetadata < BaseResource
16
16
  # Indicates whether the stay can be cancelled via the Dormakaba Oracode API.
@@ -249,11 +249,11 @@ module Seam
249
249
  end
250
250
 
251
251
  # 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.
252
- class FailedToExpire < Errors
252
+ class FailedToRemove < Errors
253
253
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
254
254
  # @return [String]
255
255
  # Known values:
256
- # - `failed_to_expire`
256
+ # - `failed_to_remove`
257
257
  attr_accessor :error_code
258
258
  # Indicates that this is an access code error.
259
259
  # @return [TrueClass]
@@ -273,7 +273,7 @@ module Seam
273
273
  # Known values:
274
274
  # - `account_disconnected`
275
275
  attr_accessor :error_code
276
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
276
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
277
277
  # @return [TrueClass]
278
278
  attr_accessor :is_connected_account_error
279
279
  # Indicates that the error is not a device error.
@@ -294,7 +294,7 @@ module Seam
294
294
  # Known values:
295
295
  # - `salto_ks_subscription_limit_exceeded`
296
296
  attr_accessor :error_code
297
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
297
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
298
298
  # @return [TrueClass]
299
299
  attr_accessor :is_connected_account_error
300
300
  # Indicates that the error is not a device error.
@@ -315,7 +315,7 @@ module Seam
315
315
  # Known values:
316
316
  # - `insufficient_permissions`
317
317
  attr_accessor :error_code
318
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
318
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
319
319
  # @return [TrueClass]
320
320
  attr_accessor :is_connected_account_error
321
321
  # Indicates that the error is not a device error.
@@ -336,7 +336,7 @@ module Seam
336
336
  # Known values:
337
337
  # - `dormakaba_sites_disconnected`
338
338
  attr_accessor :error_code
339
- # Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error.
339
+ # Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
340
340
  # @return [TrueClass]
341
341
  attr_accessor :is_connected_account_error
342
342
  # Indicates that the error is not a device error.
@@ -422,7 +422,7 @@ module Seam
422
422
  date_accessor :created_at
423
423
  end
424
424
 
425
- # Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
425
+ # Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
426
426
  class EmptyBackupAccessCodePool < Errors
427
427
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
428
428
  # @return [String]
@@ -512,14 +512,14 @@ module Seam
512
512
  date_accessor :created_at
513
513
  end
514
514
 
515
- # 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).
515
+ # 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).
516
516
  class BridgeDisconnected < Errors
517
517
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
518
518
  # @return [String]
519
519
  # Known values:
520
520
  # - `bridge_disconnected`
521
521
  attr_accessor :error_code
522
- # Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
522
+ # Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
523
523
  # @return [Boolean, nil]
524
524
  attr_accessor :is_bridge_error
525
525
  # Indicates whether the error is related specifically to the connected account.
@@ -546,7 +546,7 @@ module Seam
546
546
  # - `code_constraints_violated`
547
547
  # - `failed_to_issue`
548
548
  # - `failed_to_update`
549
- # - `failed_to_expire`
549
+ # - `failed_to_remove`
550
550
  # - `account_disconnected`
551
551
  # - `salto_ks_subscription_limit_exceeded`
552
552
  # - `insufficient_permissions`
@@ -580,7 +580,7 @@ module Seam
580
580
  "code_constraints_violated" => CodeConstraintsViolated,
581
581
  "failed_to_issue" => FailedToIssue,
582
582
  "failed_to_update" => FailedToUpdate,
583
- "failed_to_expire" => FailedToExpire,
583
+ "failed_to_remove" => FailedToRemove,
584
584
  "account_disconnected" => AccountDisconnected,
585
585
  "salto_ks_subscription_limit_exceeded" => SaltoKsSubscriptionLimitExceeded,
586
586
  "insufficient_permissions" => InsufficientPermissions,
@@ -893,13 +893,13 @@ module Seam
893
893
  # Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.
894
894
  # @return [DormakabaOracodeMetadata, nil]
895
895
  resource_accessor :dormakaba_oracode_metadata, DormakabaOracodeMetadata
896
- # Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
896
+ # Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
897
897
  # @return [Array<Errors>]
898
898
  resource_list_accessor :errors, Errors
899
899
  # Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.
900
900
  # @return [Array<PendingMutations>]
901
901
  resource_list_accessor :pending_mutations, PendingMutations
902
- # Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
902
+ # Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
903
903
  # @return [Array<Warnings>]
904
904
  resource_list_accessor :warnings, Warnings
905
905
  # Unique identifier for the access code.
@@ -947,7 +947,7 @@ module Seam
947
947
  # Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
948
948
  # @return [String, nil]
949
949
  attr_accessor :pulled_backup_access_code_id
950
- # Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
950
+ # Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
951
951
  # @return [String]
952
952
  # Known values:
953
953
  # - `setting`
@@ -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 AccessMethod < 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.
@@ -4,9 +4,9 @@ module Seam
4
4
  module Resources
5
5
  # 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.
6
6
  #
7
- # Some access control systems use [access group](https://docs.seam.co/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.
7
+ # 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.
8
8
  #
9
- # To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
9
+ # 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).
10
10
  class AcsAccessGroup < 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 group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
22
+ # Indicates that the [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) 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).
23
23
  class FailedToCreateOnAcsSystem < Errors
24
24
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
25
25
  # @return [String]
@@ -2,13 +2,13 @@
2
2
 
3
3
  module Seam
4
4
  module Resources
5
- # Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
5
+ # 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).
6
6
  #
7
7
  # 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.
8
8
  #
9
9
  # 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.
10
10
  #
11
- # For granting a person access to a space, [Access Grants](https://docs.seam.co/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.
11
+ # 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.
12
12
  class AcsCredential < BaseResource
13
13
  class AkilesMetadata < BaseResource
14
14
  # ID of the Akiles member PIN.
@@ -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 [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is waiting to be issued.
82
+ # Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is waiting to be issued.
83
83
  class WaitingToBeIssued < 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 schedule of one of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials)'s children was modified externally.
97
+ # Indicates that the schedule of one of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials)'s children was modified externally.
98
98
  class ScheduleExternallyModified < Warnings
99
99
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
100
100
  # @return [String]
@@ -109,7 +109,7 @@ module Seam
109
109
  date_accessor :created_at
110
110
  end
111
111
 
112
- # Indicates that the schedule of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.
112
+ # Indicates that the schedule of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.
113
113
  class ScheduleModified < Warnings
114
114
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
115
115
  # @return [String]
@@ -124,7 +124,7 @@ module Seam
124
124
  date_accessor :created_at
125
125
  end
126
126
 
127
- # Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is being deleted.
127
+ # Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is being deleted.
128
128
  class BeingDeleted < Warnings
129
129
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
130
130
  # @return [String]
@@ -139,7 +139,7 @@ module Seam
139
139
  date_accessor :created_at
140
140
  end
141
141
 
142
- # An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.
142
+ # An unknown issue occurred while syncing the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.
143
143
  class UnknownIssueWithAcsCredential < Warnings
144
144
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
145
145
  # @return [String]
@@ -154,7 +154,7 @@ module Seam
154
154
  date_accessor :created_at
155
155
  end
156
156
 
157
- # Access permissions for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.
157
+ # Access permissions for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.
158
158
  class NeedsToBeReissued < Warnings
159
159
  # Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
160
160
  # @return [String]
@@ -219,22 +219,22 @@ module Seam
219
219
  }.freeze
220
220
  end
221
221
 
222
- # Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
222
+ # Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
223
223
  # @return [AkilesMetadata, nil]
224
224
  resource_accessor :akiles_metadata, AkilesMetadata
225
- # Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
225
+ # Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
226
226
  # @return [AssaAbloyVostioMetadata, nil]
227
227
  resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
228
- # Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
228
+ # Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
229
229
  # @return [VisionlineMetadata, nil]
230
230
  resource_accessor :visionline_metadata, VisionlineMetadata
231
- # Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
231
+ # Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
232
232
  # @return [Array<Errors>]
233
233
  resource_list_accessor :errors, Errors
234
- # Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
234
+ # Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
235
235
  # @return [Array<Warnings>]
236
236
  resource_list_accessor :warnings, Warnings
237
- # Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
237
+ # Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
238
238
  # @return [String]
239
239
  # Known values:
240
240
  # - `code`
@@ -242,34 +242,34 @@ module Seam
242
242
  # - `mobile_key`
243
243
  # - `cloud_key`
244
244
  attr_accessor :access_method
245
- # ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
245
+ # ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
246
246
  # @return [String]
247
247
  attr_accessor :acs_credential_id
248
248
  # ID of the credential pool to which the credential belongs.
249
249
  # @return [String, nil]
250
250
  attr_accessor :acs_credential_pool_id
251
- # ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
251
+ # ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
252
252
  # @return [String]
253
253
  attr_accessor :acs_system_id
254
- # ID of the [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
254
+ # ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
255
255
  # @return [String, nil]
256
256
  attr_accessor :acs_user_id
257
- # Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
257
+ # Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
258
258
  # @return [String, nil]
259
259
  attr_accessor :card_number
260
- # Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
260
+ # Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
261
261
  # @return [String, nil]
262
262
  attr_accessor :code
263
- # ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
263
+ # ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
264
264
  # @return [String]
265
265
  attr_accessor :connected_account_id
266
- # Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type.
266
+ # Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
267
267
  # @return [String]
268
268
  attr_accessor :display_name
269
- # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
269
+ # Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
270
270
  # @return [String, nil]
271
271
  attr_accessor :ends_at
272
- # Brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
272
+ # Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
273
273
  # @return [String, nil]
274
274
  # Known values:
275
275
  # - `pti_card`
@@ -287,46 +287,46 @@ module Seam
287
287
  # - `kisi_credential`
288
288
  # - `akiles_credential`
289
289
  attr_accessor :external_type
290
- # Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type.
290
+ # Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type.
291
291
  # @return [String, nil]
292
292
  attr_accessor :external_type_display_name
293
- # Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
293
+ # Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
294
294
  # @return [Boolean, nil]
295
295
  attr_accessor :is_issued
296
- # Indicates whether the latest state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
296
+ # Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
297
297
  # @return [Boolean, nil]
298
298
  attr_accessor :is_latest_desired_state_synced_with_provider
299
299
  # Indicates whether Seam manages the credential.
300
300
  # @return [TrueClass]
301
301
  attr_accessor :is_managed
302
- # Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
302
+ # Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
303
303
  # @return [Boolean, nil]
304
304
  attr_accessor :is_multi_phone_sync_credential
305
- # Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
305
+ # Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
306
306
  # @return [Boolean, nil]
307
307
  attr_accessor :is_one_time_use
308
- # ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
308
+ # ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
309
309
  # @return [String, nil]
310
310
  attr_accessor :parent_acs_credential_id
311
- # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
311
+ # Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
312
312
  # @return [String, nil]
313
313
  attr_accessor :starts_at
314
- # ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
314
+ # ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs.
315
315
  # @return [String, nil]
316
316
  attr_accessor :user_identity_id
317
- # ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
317
+ # ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
318
318
  # @return [String]
319
319
  attr_accessor :workspace_id
320
320
 
321
- # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created.
321
+ # Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created.
322
322
  # @return [Time]
323
323
  date_accessor :created_at
324
324
 
325
- # Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
325
+ # Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
326
326
  # @return [Time, nil]
327
327
  date_accessor :issued_at
328
328
 
329
- # Date and time at which the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
329
+ # Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
330
330
  # @return [Time, nil]
331
331
  date_accessor :latest_desired_state_synced_with_provider_at
332
332
  end
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Seam
4
4
  module Resources
5
- # Represents a hardware device that encodes [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
5
+ # 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).
6
6
  #
7
7
  # 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:
8
8
  #
@@ -13,9 +13,9 @@ module Seam
13
13
  #
14
14
  # 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.
15
15
  #
16
- # See [Working with Card Encoders and Scanners](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
16
+ # See [Working with Card Encoders and Scanners](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
17
17
  #
18
- # To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
18
+ # 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).
19
19
  class AcsEncoder < BaseResource
20
20
  class Errors < BaseResource
21
21
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -31,26 +31,26 @@ module Seam
31
31
  date_accessor :created_at
32
32
  end
33
33
 
34
- # Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
34
+ # Errors associated with the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
35
35
  # @return [Array<Errors>]
36
36
  resource_list_accessor :errors, Errors
37
- # ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
37
+ # ID of the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
38
38
  # @return [String]
39
39
  attr_accessor :acs_encoder_id
40
- # ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
40
+ # ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
41
41
  # @return [String]
42
42
  attr_accessor :acs_system_id
43
- # ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
43
+ # ID of the connected account that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
44
44
  # @return [String]
45
45
  attr_accessor :connected_account_id
46
- # Display name for the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
46
+ # Display name for the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
47
47
  # @return [String]
48
48
  attr_accessor :display_name
49
- # ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
49
+ # ID of the workspace that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
50
50
  # @return [String]
51
51
  attr_accessor :workspace_id
52
52
 
53
- # Date and time at which the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created.
53
+ # Date and time at which the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created.
54
54
  # @return [Time]
55
55
  date_accessor :created_at
56
56
  end