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
@@ -16,17 +16,17 @@ module Seam
16
16
  @unmanaged ||= Seam::Clients::AccessCodesUnmanaged.new(client: @client, defaults: @defaults)
17
17
  end
18
18
 
19
- # Creates a new [access code](https://docs.seam.co/low-level-apis/access-codes). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.
19
+ # Creates a new [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.
20
20
  # @param device_id [String] ID of the device for which you want to create the new access code.
21
- # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
21
+ # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
22
22
  # @param attempt_for_offline_device [Boolean, nil]
23
23
  # @param code [String, nil] Code to be used for access.
24
- # @param common_code_key [String, nil] Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
24
+ # @param common_code_key [String, nil] Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
25
25
  # @param ends_at [String, nil] Date and time at which the validity of the new access code 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`.
26
- # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
27
- # @param is_offline_access_code [Boolean, nil] Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes).
28
- # @param is_one_time_use [Boolean, nil] Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.
29
- # @param max_time_rounding [String, nil] Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
26
+ # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
27
+ # @param is_offline_access_code [Boolean, nil] Indicates whether the access code is an [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes).
28
+ # @param is_one_time_use [Boolean, nil] Indicates whether the [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.
29
+ # @param max_time_rounding [String, nil] Maximum rounding adjustment. To create a daily-bound [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
30
30
  # @param name [String, nil] Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
31
31
  #
32
32
  # Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
@@ -34,10 +34,10 @@ module Seam
34
34
  # To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
35
35
  #
36
36
  # To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
37
- # @param prefer_native_scheduling [Boolean, nil] Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
37
+ # @param prefer_native_scheduling [Boolean, nil] Indicates whether [native scheduling](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
38
38
  # @param preferred_code_length [Float, nil] Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
39
39
  # @param starts_at [String, nil] Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
40
- # @param use_backup_access_code_pool [Boolean, nil] Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).
40
+ # @param use_backup_access_code_pool [Boolean, nil] Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code).
41
41
  # @param use_offline_access_code [Boolean, nil]
42
42
  # @deprecated use_offline_access_code: Use `is_offline_access_code` instead.
43
43
  # @return [Seam::Resources::AccessCode] OK
@@ -47,7 +47,7 @@ module Seam
47
47
  Seam::Resources::AccessCode.load_from_response(res.body["access_code"])
48
48
  end
49
49
 
50
- # Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
50
+ # Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
51
51
  #
52
52
  # Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.
53
53
  #
@@ -55,16 +55,16 @@ module Seam
55
55
  #
56
56
  # If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.
57
57
  #
58
- # See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
58
+ # See also [Creating and Updating Multiple Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
59
59
  #
60
- # 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.
60
+ # 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.
61
61
  # @param device_ids [Array<String>] IDs of the devices for which you want to create the new access codes.
62
- # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
62
+ # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
63
63
  # @param attempt_for_offline_device [Boolean, nil]
64
64
  # @param behavior_when_code_cannot_be_shared [String, nil] Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.
65
65
  # @param code [String, nil] Code to be used for access.
66
66
  # @param ends_at [String, nil] Date and time at which the validity of the new access code 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`.
67
- # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
67
+ # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
68
68
  # @param name [String, nil] Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
69
69
  #
70
70
  # Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
@@ -72,10 +72,10 @@ module Seam
72
72
  # To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
73
73
  #
74
74
  # To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
75
- # @param prefer_native_scheduling [Boolean, nil] Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
75
+ # @param prefer_native_scheduling [Boolean, nil] Indicates whether [native scheduling](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
76
76
  # @param preferred_code_length [Float, nil] Preferred code length. If the affected devices do not support the preferred code length, Seam reverts to using the shortest supported code length.
77
77
  # @param starts_at [String, nil] Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
78
- # @param use_backup_access_code_pool [Boolean, nil] Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code).
78
+ # @param use_backup_access_code_pool [Boolean, nil] Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code).
79
79
  # @return [Seam::Resources::AccessCode] OK
80
80
  def create_multiple(device_ids:, allow_external_modification: nil, attempt_for_offline_device: nil, behavior_when_code_cannot_be_shared: nil, code: nil, ends_at: nil, is_external_modification_allowed: nil, name: nil, prefer_native_scheduling: nil, preferred_code_length: nil, starts_at: nil, use_backup_access_code_pool: nil)
81
81
  res = @client.put("/access_codes/create_multiple", {device_ids: device_ids, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, behavior_when_code_cannot_be_shared: behavior_when_code_cannot_be_shared, code: code, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, name: name, prefer_native_scheduling: prefer_native_scheduling, preferred_code_length: preferred_code_length, starts_at: starts_at, use_backup_access_code_pool: use_backup_access_code_pool}.compact)
@@ -83,7 +83,7 @@ module Seam
83
83
  Seam::Resources::AccessCode.load_from_response(res.body["access_codes"])
84
84
  end
85
85
 
86
- # Deletes an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
86
+ # Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
87
87
  # @param access_code_id [String] ID of the access code that you want to delete.
88
88
  # @param device_id [String, nil] ID of the device for which you want to delete the access code.
89
89
  # @return [nil] OK
@@ -93,7 +93,7 @@ module Seam
93
93
  nil
94
94
  end
95
95
 
96
- # Generates a code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes), given a device ID.
96
+ # Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID.
97
97
  # @param device_id [String] ID of the device for which you want to generate a code.
98
98
  # @return [Seam::Resources::AccessCode] OK
99
99
  def generate_code(device_id:)
@@ -102,7 +102,7 @@ module Seam
102
102
  Seam::Resources::AccessCode.load_from_response(res.body["generated_code"])
103
103
  end
104
104
 
105
- # Returns a specified [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
105
+ # Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
106
106
  #
107
107
  # You must specify either `access_code_id` or both `device_id` and `code`.
108
108
  # @param access_code_id [String, nil] ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
@@ -119,7 +119,7 @@ module Seam
119
119
  Seam::Resources::AccessCode.load_from_response(res.body["access_code"])
120
120
  end
121
121
 
122
- # Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
122
+ # Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
123
123
  #
124
124
  # Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
125
125
  # @param access_code_ids [Array<String>, nil] IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
@@ -143,7 +143,7 @@ module Seam
143
143
  Seam::Resources::AccessCode.load_from_response(res.body["access_codes"])
144
144
  end
145
145
 
146
- # Retrieves a backup access code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes).
146
+ # Retrieves a backup access code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
147
147
  #
148
148
  # A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
149
149
  #
@@ -174,16 +174,16 @@ module Seam
174
174
  nil
175
175
  end
176
176
 
177
- # Updates a specified active or upcoming [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
177
+ # Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
178
178
  #
179
- # See also [Modifying Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes).
179
+ # See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes).
180
180
  # @param access_code_id [String] ID of the access code that you want to update.
181
- # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
181
+ # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
182
182
  # @param attempt_for_offline_device [Boolean, nil]
183
183
  # @param code [String, nil] Code to be used for access.
184
184
  # @param device_id [String, nil] ID of the device containing the access code that you want to update.
185
185
  # @param ends_at [String, nil] Date and time at which the validity of the new access code 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`.
186
- # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
186
+ # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
187
187
  # @param is_managed [Boolean, nil] Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.
188
188
  # @param name [String, nil] Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
189
189
  #
@@ -193,7 +193,7 @@ module Seam
193
193
  #
194
194
  # To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
195
195
  # @param starts_at [String, nil] Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
196
- # @param type [String, nil] Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).
196
+ # @param type [String, nil] Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).
197
197
  # @return [nil] OK
198
198
  def update(access_code_id:, allow_external_modification: nil, attempt_for_offline_device: nil, code: nil, device_id: nil, ends_at: nil, is_external_modification_allowed: nil, is_managed: nil, name: nil, starts_at: nil, type: nil)
199
199
  @client.patch("/access_codes/update", {access_code_id: access_code_id, allow_external_modification: allow_external_modification, attempt_for_offline_device: attempt_for_offline_device, code: code, device_id: device_id, ends_at: ends_at, is_external_modification_allowed: is_external_modification_allowed, is_managed: is_managed, name: name, starts_at: starts_at, type: type}.compact)
@@ -201,11 +201,11 @@ module Seam
201
201
  nil
202
202
  end
203
203
 
204
- # Updates [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
204
+ # Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
205
205
  #
206
206
  # Specify the `common_code_key` to identify the set of access codes that you want to update.
207
207
  #
208
- # See also [Update Linked Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).
208
+ # See also [Update Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).
209
209
  # @param common_code_key [String] Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.
210
210
  # @param ends_at [String, nil] Date and time at which the validity of the new access code 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`.
211
211
  # @param name [String, nil] Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
@@ -8,7 +8,7 @@ module Seam
8
8
  @defaults = defaults
9
9
  end
10
10
 
11
- # Simulates the creation of an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
11
+ # Simulates the creation of an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
12
12
  # @param code [String] Code of the simulated unmanaged access code.
13
13
  # @param device_id [String] ID of the device for which you want to simulate the creation of an unmanaged access code.
14
14
  # @param name [String] Name of the simulated unmanaged access code.
@@ -8,15 +8,15 @@ module Seam
8
8
  @defaults = defaults
9
9
  end
10
10
 
11
- # Converts an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/low-level-apis/smart-locks/access-codes).
11
+ # Converts an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
12
12
  #
13
13
  # An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.
14
14
  #
15
15
  # Note that not all device providers support converting an unmanaged access code to a managed access code.
16
16
  # @param access_code_id [String] ID of the unmanaged access code that you want to convert to a managed access code.
17
- # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
17
+ # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
18
18
  # @param force [Boolean, nil] Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.
19
- # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
19
+ # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
20
20
  # @return [nil] OK
21
21
  def convert_to_managed(access_code_id:, allow_external_modification: nil, force: nil, is_external_modification_allowed: nil)
22
22
  @client.patch("/access_codes/unmanaged/convert_to_managed", {access_code_id: access_code_id, allow_external_modification: allow_external_modification, force: force, is_external_modification_allowed: is_external_modification_allowed}.compact)
@@ -24,7 +24,7 @@ module Seam
24
24
  nil
25
25
  end
26
26
 
27
- # Deletes an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
27
+ # Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
28
28
  # @param access_code_id [String] ID of the unmanaged access code that you want to delete.
29
29
  # @return [nil] OK
30
30
  def delete(access_code_id:)
@@ -33,7 +33,7 @@ module Seam
33
33
  nil
34
34
  end
35
35
 
36
- # Returns a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
36
+ # Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
37
37
  #
38
38
  # You must specify either `access_code_id` or both `device_id` and `code`.
39
39
  # @param access_code_id [String, nil] ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
@@ -50,7 +50,7 @@ module Seam
50
50
  Seam::Resources::UnmanagedAccessCode.load_from_response(res.body["access_code"])
51
51
  end
52
52
 
53
- # Returns a list of all [unmanaged access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
53
+ # Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
54
54
  # @param device_id [String] ID of the device for which you want to list unmanaged access codes.
55
55
  # @param limit [Float, nil] Numerical limit on the number of unmanaged access codes to return.
56
56
  # @param page_cursor [String, Seam::Null, nil] Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
@@ -63,12 +63,12 @@ module Seam
63
63
  Seam::Resources::UnmanagedAccessCode.load_from_response(res.body["access_codes"])
64
64
  end
65
65
 
66
- # Updates a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
66
+ # Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
67
67
  # @param access_code_id [String] ID of the unmanaged access code that you want to update.
68
68
  # @param is_managed [Boolean]
69
- # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
69
+ # @param allow_external_modification [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
70
70
  # @param force [Boolean, nil] Indicates whether to force the unmanaged access code update.
71
- # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
71
+ # @param is_external_modification_allowed [Boolean, nil] Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
72
72
  # @return [nil] OK
73
73
  def update(access_code_id:, is_managed:, allow_external_modification: nil, force: nil, is_external_modification_allowed: nil)
74
74
  @client.patch("/access_codes/unmanaged/update", {access_code_id: access_code_id, is_managed: is_managed, allow_external_modification: allow_external_modification, force: force, is_external_modification_allowed: is_external_modification_allowed}.compact)
@@ -12,12 +12,12 @@ module Seam
12
12
  @unmanaged ||= Seam::Clients::AccessGrantsUnmanaged.new(client: @client, defaults: @defaults)
13
13
  end
14
14
 
15
- # Creates a new [Access Grant](https://docs.seam.co/use-cases/granting-access/access-grants). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.
15
+ # Creates a new [Access Grant](https://www.seam.co/docs/use-cases/granting-access). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.
16
16
  # @param requested_access_methods [Array<Hash>]
17
17
  # @param access_grant_key [String, nil] Unique key for the access grant within the workspace.
18
- # @param acs_entrance_ids [Array<String>, nil] Set of IDs of the [entrances](https://docs.seam.co/api/acs/systems/list) to which access is being granted.
18
+ # @param acs_entrance_ids [Array<String>, nil] Set of IDs of the [entrances](https://www.seam.co/docs/api/acs/systems/list) to which access is being granted.
19
19
  # @param customization_profile_id [String, nil] ID of the customization profile to apply to the Access Grant and its access methods.
20
- # @param device_ids [Array<String>, nil] Set of IDs of the [devices](https://docs.seam.co/api/devices/list) to which access is being granted.
20
+ # @param device_ids [Array<String>, nil] Set of IDs of the [devices](https://www.seam.co/docs/api/devices/list) to which access is being granted.
21
21
  # @param ends_at [String, Seam::Null, nil] Date and time at which the validity of the new grant 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`.
22
22
  # @param location [Hash, nil]
23
23
  # @deprecated location: Create a space first, then reference it using `space_ids`.
@@ -41,7 +41,7 @@ module Seam
41
41
  nil
42
42
  end
43
43
 
44
- # Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
44
+ # Encodes an existing access method onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
45
45
  # @param access_method_id [String] ID of the `access_method` to encode onto a card.
46
46
  # @param acs_encoder_id [String] ID of the `acs_encoder` to use to encode the `access_method`.
47
47
  # @return [Seam::Resources::ActionAttempt] OK
@@ -93,7 +93,7 @@ module Seam
93
93
  Seam::Resources::AccessMethod.load_from_response(res.body["access_methods"])
94
94
  end
95
95
 
96
- # Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation.
96
+ # Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation.
97
97
  # @param access_method_id [String] ID of the cloud_key `access_method` to use for the unlock operation.
98
98
  # @param acs_entrance_id [String] ID of the entrance to unlock.
99
99
  # @return [Seam::Resources::ActionAttempt] OK
@@ -8,7 +8,7 @@ module Seam
8
8
  @defaults = defaults
9
9
  end
10
10
 
11
- # Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
11
+ # Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
12
12
  # @param acs_access_group_id [String] ID of the access group to which you want to add an access system user.
13
13
  # @param acs_user_id [String, nil] ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.
14
14
  # @param user_identity_id [String, nil] ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
@@ -19,7 +19,7 @@ module Seam
19
19
  nil
20
20
  end
21
21
 
22
- # Deletes a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
22
+ # Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
23
23
  # @param acs_access_group_id [String] ID of the access group that you want to delete.
24
24
  # @return [nil] OK
25
25
  def delete(acs_access_group_id:)
@@ -28,7 +28,7 @@ module Seam
28
28
  nil
29
29
  end
30
30
 
31
- # Returns a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
31
+ # Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
32
32
  # @param acs_access_group_id [String] ID of the access group that you want to get.
33
33
  # @return [Seam::Resources::AcsAccessGroup] OK
34
34
  def get(acs_access_group_id:)
@@ -37,7 +37,7 @@ module Seam
37
37
  Seam::Resources::AcsAccessGroup.load_from_response(res.body["acs_access_group"])
38
38
  end
39
39
 
40
- # Returns a list of all [access groups](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
40
+ # Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
41
41
  # @param acs_system_id [String, nil] ID of the access system for which you want to retrieve all access groups.
42
42
  # @param acs_user_id [String, nil] ID of the access system user for which you want to retrieve all access groups.
43
43
  # @param search [String, nil] String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`.
@@ -49,7 +49,7 @@ module Seam
49
49
  Seam::Resources::AcsAccessGroup.load_from_response(res.body["acs_access_groups"])
50
50
  end
51
51
 
52
- # Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
52
+ # Returns a list of all accessible entrances for a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
53
53
  # @param acs_access_group_id [String] ID of the access group for which you want to retrieve all accessible entrances.
54
54
  # @return [Seam::Resources::AcsEntrance] OK
55
55
  def list_accessible_entrances(acs_access_group_id:)
@@ -58,7 +58,7 @@ module Seam
58
58
  Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
59
59
  end
60
60
 
61
- # Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
61
+ # Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
62
62
  # @param acs_access_group_id [String] ID of the access group for which you want to retrieve all access system users.
63
63
  # @return [Seam::Resources::AcsUser] OK
64
64
  def list_users(acs_access_group_id:)
@@ -67,7 +67,7 @@ module Seam
67
67
  Seam::Resources::AcsUser.load_from_response(res.body["acs_users"])
68
68
  end
69
69
 
70
- # Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
70
+ # Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
71
71
  # @param acs_access_group_id [String] ID of the access group from which you want to remove an access system user.
72
72
  # @param acs_user_id [String, nil] ID of the access system user that you want to remove from an access group.
73
73
  # @param user_identity_id [String, nil] ID of the user identity associated with the user that you want to remove from an access group.
@@ -8,7 +8,7 @@ module Seam
8
8
  @defaults = defaults
9
9
  end
10
10
 
11
- # Assigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
11
+ # Assigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
12
12
  # @param acs_credential_id [String] ID of the credential that you want to assign to an access system user.
13
13
  # @param acs_user_id [String, nil] ID of the access system user to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id.
14
14
  # @param user_identity_id [String, nil] ID of the user identity to whom you want to assign a credential. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
@@ -19,16 +19,16 @@ module Seam
19
19
  nil
20
20
  end
21
21
 
22
- # Creates a new [credential](https://docs.seam.co/low-level-apis/managing-credentials) for a specified [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://docs.seam.co/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
22
+ # Creates a new [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) for a specified [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
23
23
  # @param access_method [String] Access method for the new credential. Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
24
24
  # @param acs_system_id [String, nil] ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
25
25
  # @param acs_user_id [String, nil] ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.
26
- # @param allowed_acs_entrance_ids [Array<String>, nil] Set of IDs of the [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access.
26
+ # @param allowed_acs_entrance_ids [Array<String>, nil] Set of IDs of the [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for which the new credential grants access.
27
27
  # @param assa_abloy_vostio_metadata [Hash, nil] Vostio-specific metadata for the new credential.
28
- # @param code [String, nil] Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/device-and-system-integration-guides).
28
+ # @param code [String, nil] Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://www.seam.co/docs/device-and-system-integration-guides).
29
29
  # @param credential_manager_acs_system_id [String, nil] ACS system ID of the credential manager for the new credential.
30
30
  # @param ends_at [Time, nil] Date and time at which the validity of the new credential 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`.
31
- # @param is_multi_phone_sync_credential [Boolean, nil] Indicates whether the new credential 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).
31
+ # @param is_multi_phone_sync_credential [Boolean, nil] Indicates whether the new credential 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).
32
32
  # @param salto_space_metadata [Hash, nil] Salto Space-specific metadata for the new credential.
33
33
  # @param starts_at [Time, nil] Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
34
34
  # @param user_identity_id [String, nil] ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.
@@ -40,7 +40,7 @@ module Seam
40
40
  Seam::Resources::AcsCredential.load_from_response(res.body["acs_credential"])
41
41
  end
42
42
 
43
- # Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
43
+ # Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
44
44
  # @param acs_credential_id [String] ID of the credential that you want to delete.
45
45
  # @return [nil] OK
46
46
  def delete(acs_credential_id:)
@@ -49,7 +49,7 @@ module Seam
49
49
  nil
50
50
  end
51
51
 
52
- # Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
52
+ # Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
53
53
  # @param acs_credential_id [String] ID of the credential that you want to get.
54
54
  # @return [Seam::Resources::AcsCredential] OK
55
55
  def get(acs_credential_id:)
@@ -58,7 +58,7 @@ module Seam
58
58
  Seam::Resources::AcsCredential.load_from_response(res.body["acs_credential"])
59
59
  end
60
60
 
61
- # Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
61
+ # Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
62
62
  # @param acs_system_id [String, nil] ID of the access system for which you want to retrieve all credentials.
63
63
  # @param acs_user_id [String, nil] ID of the access system user for which you want to retrieve all credentials.
64
64
  # @param created_before [Time, nil] Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created.
@@ -74,7 +74,7 @@ module Seam
74
74
  Seam::Resources::AcsCredential.load_from_response(res.body["acs_credentials"])
75
75
  end
76
76
 
77
- # Returns a list of all [entrances](https://docs.seam.co/api/acs/entrances) to which a [credential](https://docs.seam.co/api/acs/credentials) grants access.
77
+ # Returns a list of all [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a [credential](https://www.seam.co/docs/api/acs/credentials/object) grants access.
78
78
  # @param acs_credential_id [String] ID of the credential for which you want to retrieve all entrances to which the credential grants access.
79
79
  # @return [Seam::Resources::AcsEntrance] OK
80
80
  def list_accessible_entrances(acs_credential_id:)
@@ -83,7 +83,7 @@ module Seam
83
83
  Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
84
84
  end
85
85
 
86
- # Unassigns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).
86
+ # Unassigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
87
87
  # @param acs_credential_id [String] ID of the credential that you want to unassign from an access system user.
88
88
  # @param acs_user_id [String, nil] ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
89
89
  # @param user_identity_id [String, nil] ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.
@@ -94,7 +94,7 @@ module Seam
94
94
  nil
95
95
  end
96
96
 
97
- # Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
97
+ # Updates the code and ends at date and time for a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
98
98
  # @param acs_credential_id [String] ID of the credential that you want to update.
99
99
  # @param code [String, nil] Replacement access (PIN) code for the credential that you want to update.
100
100
  # @param ends_at [Time, nil] Replacement date and time at which the validity of the credential 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 the `starts_at` value that you set when creating the credential.
@@ -14,7 +14,7 @@ module Seam
14
14
  @simulate ||= Seam::Clients::AcsEncodersSimulate.new(client: @client, defaults: @defaults)
15
15
  end
16
16
 
17
- # Encodes an existing [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
17
+ # Encodes an existing [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
18
18
  # @param acs_encoder_id [String] ID of the `acs_encoder` to use to encode the `acs_credential`.
19
19
  # @param access_method_id [String, nil] ID of the `access_method` to encode onto a card.
20
20
  # @param acs_credential_id [String, nil] ID of the `acs_credential` to encode onto a card.
@@ -27,7 +27,7 @@ module Seam
27
27
  Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
28
28
  end
29
29
 
30
- # Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
30
+ # Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
31
31
  # @param acs_encoder_id [String] ID of the encoder that you want to get.
32
32
  # @return [Seam::Resources::AcsEncoder] OK
33
33
  def get(acs_encoder_id:)
@@ -36,7 +36,7 @@ module Seam
36
36
  Seam::Resources::AcsEncoder.load_from_response(res.body["acs_encoder"])
37
37
  end
38
38
 
39
- # Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
39
+ # Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
40
40
  # @param acs_encoder_ids [Array<String>, nil] IDs of the encoders that you want to retrieve.
41
41
  # @param acs_system_id [String, nil] ID of the access system for which you want to retrieve all encoders.
42
42
  # @param acs_system_ids [Array<String>, nil] IDs of the access systems for which you want to retrieve all encoders.
@@ -49,7 +49,7 @@ module Seam
49
49
  Seam::Resources::AcsEncoder.load_from_response(res.body["acs_encoders"])
50
50
  end
51
51
 
52
- # Scans an encoded [acs_credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
52
+ # Scans an encoded [acs_credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
53
53
  # @param acs_encoder_id [String] ID of the encoder to use for the scan.
54
54
  # @param salto_ks_metadata [Hash, nil] Salto KS-specific metadata for the scan action.
55
55
  # @return [Seam::Resources::ActionAttempt] OK
@@ -61,7 +61,7 @@ module Seam
61
61
  Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
62
62
  end
63
63
 
64
- # Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
64
+ # Scans a physical card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
65
65
  # @param acs_encoder_id [String] ID of the `acs_encoder` to use to scan the credential.
66
66
  # @param acs_user_id [String, nil] ID of the `acs_user` to assign the scanned credential to.
67
67
  # @param salto_ks_metadata [Hash, nil] Salto KS-specific metadata for the scan action.
@@ -8,7 +8,7 @@ module Seam
8
8
  @defaults = defaults
9
9
  end
10
10
 
11
- # Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
11
+ # Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
12
12
  # @param acs_encoder_id [String] ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
13
13
  # @param acs_credential_id [String, nil] ID of the `acs_credential` that will fail to be encoded onto a card in the next request.
14
14
  # @param error_code [String, nil] Code of the error to simulate.
@@ -19,7 +19,7 @@ module Seam
19
19
  nil
20
20
  end
21
21
 
22
- # Simulates that the next attempt to encode a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
22
+ # Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
23
23
  # @param acs_encoder_id [String] ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`.
24
24
  # @param scenario [String, nil] Scenario to simulate.
25
25
  # @return [nil] OK
@@ -29,7 +29,7 @@ module Seam
29
29
  nil
30
30
  end
31
31
 
32
- # Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
32
+ # Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
33
33
  # @param acs_encoder_id [String] ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request.
34
34
  # @param acs_credential_id_on_seam [String, nil]
35
35
  # @param error_code [String, nil]
@@ -40,7 +40,7 @@ module Seam
40
40
  nil
41
41
  end
42
42
 
43
- # Simulates that the next attempt to scan a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
43
+ # Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
44
44
  # @param acs_encoder_id [String] ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`.
45
45
  # @param acs_credential_id_on_seam [String, nil] ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation.
46
46
  # @param scenario [String, nil] Scenario to simulate.
@@ -10,7 +10,7 @@ module Seam
10
10
  @defaults = defaults
11
11
  end
12
12
 
13
- # Returns a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
13
+ # Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
14
14
  # @param acs_entrance_id [String] ID of the entrance that you want to get.
15
15
  # @return [Seam::Resources::AcsEntrance] OK
16
16
  def get(acs_entrance_id:)
@@ -19,7 +19,7 @@ module Seam
19
19
  Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrance"])
20
20
  end
21
21
 
22
- # Grants a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
22
+ # Grants a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
23
23
  # @param acs_entrance_id [String] ID of the entrance to which you want to grant an access system user access.
24
24
  # @param acs_user_id [String, nil] ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.
25
25
  # @param user_identity_id [String, nil] ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.
@@ -30,7 +30,7 @@ module Seam
30
30
  nil
31
31
  end
32
32
 
33
- # Returns a list of all [access system entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
33
+ # Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
34
34
  # @param access_method_id [String, nil] ID of the access method for which you want to retrieve all entrances to which it grants access.
35
35
  # @param acs_credential_id [String, nil] ID of the credential for which you want to retrieve all entrances.
36
36
  # @param acs_entrance_ids [Array<String>, nil] IDs of the entrances for which you want to retrieve all entrances.
@@ -50,7 +50,7 @@ module Seam
50
50
  Seam::Resources::AcsEntrance.load_from_response(res.body["acs_entrances"])
51
51
  end
52
52
 
53
- # Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).
53
+ # Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
54
54
  # @param acs_entrance_id [String] ID of the entrance for which you want to list all credentials that grant access.
55
55
  # @param include_if [Array<String>, nil] Conditions that credentials must meet to be included in the returned list.
56
56
  # @return [Seam::Resources::AcsCredential] OK
@@ -60,7 +60,7 @@ module Seam
60
60
  Seam::Resources::AcsCredential.load_from_response(res.body["acs_credentials"])
61
61
  end
62
62
 
63
- # Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.
63
+ # Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.
64
64
  # @param acs_credential_id [String] ID of the cloud_key credential to use for the unlock operation.
65
65
  # @param acs_entrance_id [String] ID of the entrance to unlock.
66
66
  # @return [Seam::Resources::ActionAttempt] OK