diff --git a/package-lock.json b/package-lock.json index 5cad20a6..26c00811 100644 --- a/package-lock.json +++ b/package-lock.json @@ -17,7 +17,7 @@ "@seamapi/blueprint": "^1.10.0", "@seamapi/fake-seam-connect": "^2.0.4", "@seamapi/smith": "^1.1.0", - "@seamapi/types": "1.1075.0", + "@seamapi/types": "1.1078.1", "@types/jsonwebtoken": "^9.0.6", "@types/node": "^24.10.9", "ava": "^8.0.1", @@ -1133,9 +1133,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.1075.0", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.1075.0.tgz", - "integrity": "sha512-134KCyANlwNf8XFeXIjNUUWdFOs7Nz0fUd5w8/DIuYeFGjzfzazCAoMfZD8dLu0DVQlrByHdmckKJp8GzVD84A==", + "version": "1.1078.1", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.1078.1.tgz", + "integrity": "sha512-j+Pu189xRqLqYOr93LX7ADxOOM2dMTNSOsgu/NgiPVgRj6zJh9oqst6igEQMtCid9W2kNl+eFIdUxgocmzp5iA==", "dev": true, "license": "MIT", "engines": { diff --git a/package.json b/package.json index d8a2ef75..8b6bdc84 100644 --- a/package.json +++ b/package.json @@ -88,7 +88,7 @@ "@seamapi/blueprint": "^1.10.0", "@seamapi/fake-seam-connect": "^2.0.4", "@seamapi/smith": "^1.1.0", - "@seamapi/types": "1.1075.0", + "@seamapi/types": "1.1078.1", "@types/jsonwebtoken": "^9.0.6", "@types/node": "^24.10.9", "ava": "^8.0.1", diff --git a/src/lib/resources/access-code.ts b/src/lib/resources/access-code.ts index d70c12f5..25b8ffd9 100644 --- a/src/lib/resources/access-code.ts +++ b/src/lib/resources/access-code.ts @@ -4,15 +4,15 @@ */ /** - * Represents a smart lock [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Represents a smart lock [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * 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. * - * 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. + * 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. * - * 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. + * 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. * - * 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. + * 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. */ export type AccessCode = { /** @@ -88,7 +88,7 @@ export type AccessCode = { */ ends_at?: string | null | undefined /** - * Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). */ errors: Array< /** @@ -356,7 +356,7 @@ export type AccessCode = { /** * Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'failed_to_expire' + error_code: 'failed_to_remove' /** * Indicates that this is an access code error. @@ -382,7 +382,7 @@ export type AccessCode = { error_code: 'account_disconnected' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -410,7 +410,7 @@ export type AccessCode = { error_code: 'salto_ks_subscription_limit_exceeded' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -438,7 +438,7 @@ export type AccessCode = { error_code: 'insufficient_permissions' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -466,7 +466,7 @@ export type AccessCode = { error_code: 'dormakaba_sites_disconnected' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -572,7 +572,7 @@ export type AccessCode = { */ message: string } /** - * Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + * Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. */ | { /** @@ -687,7 +687,7 @@ export type AccessCode = { */ message: string } /** - * 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). + * 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). */ | { /** @@ -701,7 +701,7 @@ export type AccessCode = { error_code: 'bridge_disconnected' /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined /** @@ -953,7 +953,7 @@ export type AccessCode = { */ starts_at?: string | null | undefined /** - * 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). + * 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). * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. */ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown' @@ -964,7 +964,7 @@ export type AccessCode = { type: 'time_bound' | 'ongoing' /** - * Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). */ warnings: Array< /** diff --git a/src/lib/resources/access-grant.ts b/src/lib/resources/access-grant.ts index 06a19cec..4e3bc31a 100644 --- a/src/lib/resources/access-grant.ts +++ b/src/lib/resources/access-grant.ts @@ -49,7 +49,7 @@ export type AccessGrant = { */ ends_at: string | null /** - * Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access). + * Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */ errors: Array< /** @@ -244,11 +244,11 @@ export type AccessGrant = { user_identity_id: string /** - * Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). + * Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */ warnings: Array< /** - * Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted. + * Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted. */ | { /** @@ -323,7 +323,7 @@ export type AccessGrant = { */ warning_code: 'overprovisioned_access' } /** - * Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated. + * Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated. */ | { /** diff --git a/src/lib/resources/access-method.ts b/src/lib/resources/access-method.ts index b4547a69..ad430baa 100644 --- a/src/lib/resources/access-method.ts +++ b/src/lib/resources/access-method.ts @@ -40,11 +40,11 @@ export type AccessMethod = { display_status: string /** - * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */ errors: Array< /** - * 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. + * 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. */ { /** @@ -99,7 +99,7 @@ export type AccessMethod = { mode: 'code' | 'card' | 'mobile_key' | 'cloud_key' /** - * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. + * 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. */ pending_mutations: Array< /** @@ -228,11 +228,11 @@ export type AccessMethod = { > /** - * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */ warnings: Array< /** - * Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted. + * Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted. */ | { /** @@ -250,7 +250,7 @@ export type AccessMethod = { */ warning_code: 'being_deleted' } /** - * Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated. + * 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. */ | { /** @@ -290,7 +290,7 @@ export type AccessMethod = { */ warning_code: 'pulled_backup_access_code' } /** - * 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. + * 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. */ | { /** @@ -308,7 +308,7 @@ export type AccessMethod = { */ warning_code: 'delay_in_issuing' } /** - * 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. + * 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. */ | { /** @@ -326,7 +326,7 @@ export type AccessMethod = { */ warning_code: 'user_identity_missing_email_address' } /** - * 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. + * 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. */ | { /** diff --git a/src/lib/resources/acs-access-group.ts b/src/lib/resources/acs-access-group.ts index aebe8d70..85683286 100644 --- a/src/lib/resources/acs-access-group.ts +++ b/src/lib/resources/acs-access-group.ts @@ -6,9 +6,9 @@ /** * 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. * - * 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. + * 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. * - * 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). + * 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). */ export type AcsAccessGroup = { /** @@ -76,7 +76,7 @@ export type AcsAccessGroup = { */ errors: Array< /** - * 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). + * 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). */ { /** diff --git a/src/lib/resources/acs-credential.ts b/src/lib/resources/acs-credential.ts index 8774fcc3..8a159e1f 100644 --- a/src/lib/resources/acs-credential.ts +++ b/src/lib/resources/acs-credential.ts @@ -4,22 +4,22 @@ */ /** - * 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). + * 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). * * 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. * * 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. * - * 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. + * 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. */ export type AcsCredential = { /** - * Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. + * 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`. */ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key' /** - * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ acs_credential_id: string @@ -28,16 +28,16 @@ export type AcsCredential = { */ acs_credential_pool_id?: string | undefined /** - * 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). + * 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). */ acs_system_id: string /** - * 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. + * 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. */ acs_user_id?: string | undefined /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ akiles_metadata?: | { @@ -48,7 +48,7 @@ export type AcsCredential = { } | undefined /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ assa_abloy_vostio_metadata?: | { @@ -79,34 +79,34 @@ export type AcsCredential = { } | undefined /** - * Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ card_number?: string | null | undefined /** - * Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ code?: string | null | undefined /** - * 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. + * 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. */ connected_account_id: string /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string /** - * Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ display_name: string /** - * 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`. + * 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`. */ ends_at?: string | undefined /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ errors: Array<{ /** @@ -120,7 +120,7 @@ export type AcsCredential = { }> /** - * 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`. + * 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`. */ external_type?: | 'pti_card' @@ -139,15 +139,15 @@ export type AcsCredential = { | 'akiles_credential' | undefined /** - * Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * 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. */ external_type_display_name?: string | undefined /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */ is_issued?: boolean | undefined /** - * 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. + * 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. */ is_latest_desired_state_synced_with_provider?: boolean | null | undefined /** @@ -156,35 +156,35 @@ export type AcsCredential = { is_managed: true /** - * 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). + * 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). */ is_multi_phone_sync_credential?: boolean | undefined /** - * 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. + * 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. */ is_one_time_use?: boolean | undefined /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */ issued_at?: string | null | undefined /** - * 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. + * 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. */ latest_desired_state_synced_with_provider_at?: string | null | undefined /** - * ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ parent_acs_credential_id?: string | undefined /** - * 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. + * 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. */ starts_at?: string | undefined /** - * 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. + * 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. */ user_identity_id?: string | undefined /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ visionline_metadata?: | { @@ -223,11 +223,11 @@ export type AcsCredential = { } | undefined /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ warnings: Array< /** - * Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is waiting to be issued. + * Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is waiting to be issued. */ | { /** @@ -245,7 +245,7 @@ export type AcsCredential = { */ warning_code: 'waiting_to_be_issued' } /** - * 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. + * 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. */ | { /** @@ -263,7 +263,7 @@ export type AcsCredential = { */ warning_code: 'schedule_externally_modified' } /** - * 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. + * 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. */ | { /** @@ -281,7 +281,7 @@ export type AcsCredential = { */ warning_code: 'schedule_modified' } /** - * Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is being deleted. + * Indicates that the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is being deleted. */ | { /** @@ -299,7 +299,7 @@ export type AcsCredential = { */ warning_code: 'being_deleted' } /** - * 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. + * 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. */ | { /** @@ -317,7 +317,7 @@ export type AcsCredential = { */ warning_code: 'unknown_issue_with_acs_credential' } /** - * 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. + * 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. */ | { /** @@ -366,7 +366,7 @@ export type AcsCredential = { > /** - * ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ workspace_id: string } diff --git a/src/lib/resources/acs-encoder.ts b/src/lib/resources/acs-encoder.ts index f05d484a..38300993 100644 --- a/src/lib/resources/acs-encoder.ts +++ b/src/lib/resources/acs-encoder.ts @@ -4,7 +4,7 @@ */ /** - * 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). + * 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). * * 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: * @@ -15,38 +15,38 @@ * * 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. * - * See [Working with Card Encoders and Scanners](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * See [Working with Card Encoders and Scanners](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). * - * 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). + * 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). */ export type AcsEncoder = { /** - * ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * ID of the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ acs_encoder_id: string /** - * 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). + * 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). */ acs_system_id: string /** - * ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * 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). */ connected_account_id: string /** - * Date and time at which the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created. + * 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. */ created_at: string /** - * Display name for the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Display name for the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ display_name: string /** - * Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Errors associated with the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ errors: Array<{ /** @@ -66,7 +66,7 @@ export type AcsEncoder = { }> /** - * ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * ID of the workspace that contains the [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ workspace_id: string } diff --git a/src/lib/resources/acs-entrance.ts b/src/lib/resources/acs-entrance.ts index 3e9e69f5..c4dc4977 100644 --- a/src/lib/resources/acs-entrance.ts +++ b/src/lib/resources/acs-entrance.ts @@ -4,23 +4,23 @@ */ /** - * Represents an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Represents an [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) within an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * * In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance. */ export type AcsEntrance = { /** - * ID of the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ acs_entrance_id: string /** - * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ acs_system_id: string /** - * Akiles-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Akiles-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ akiles_metadata?: | { @@ -54,7 +54,7 @@ export type AcsEntrance = { } | undefined /** - * ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ assa_abloy_vostio_metadata?: | { @@ -82,7 +82,7 @@ export type AcsEntrance = { } | undefined /** - * Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Avigilon Alta-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ avigilon_alta_metadata?: | { @@ -117,7 +117,7 @@ export type AcsEntrance = { } | undefined /** - * Brivo-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Brivo-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ brivo_metadata?: | { @@ -156,22 +156,22 @@ export type AcsEntrance = { */ can_unlock_with_mobile_key?: boolean | undefined /** - * ID of the [connected account](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the [connected account](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ connected_account_id: string /** - * Date and time at which the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) was created. + * Date and time at which the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was created. */ created_at: string /** - * Display name for the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Display name for the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ display_name: string /** - * dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * dormakaba Ambiance-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ dormakaba_ambiance_metadata?: | { @@ -182,7 +182,7 @@ export type AcsEntrance = { } | undefined /** - * dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * dormakaba Community-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ dormakaba_community_metadata?: | { @@ -193,7 +193,7 @@ export type AcsEntrance = { } | undefined /** - * Errors associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ errors: Array<{ /** @@ -213,7 +213,7 @@ export type AcsEntrance = { }> /** - * Hotek-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Hotek-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ hotek_metadata?: | { @@ -232,11 +232,11 @@ export type AcsEntrance = { } | undefined /** - * Indicates whether the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) is currently locked. + * Indicates whether the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) is currently locked. */ is_locked?: boolean | undefined /** - * Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Latch-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ latch_metadata?: | { @@ -259,7 +259,7 @@ export type AcsEntrance = { } | undefined /** - * Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Salto KS-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ salto_ks_metadata?: | { @@ -298,7 +298,7 @@ export type AcsEntrance = { } | undefined /** - * Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Salto Space-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ salto_space_metadata?: | { @@ -334,7 +334,7 @@ export type AcsEntrance = { space_ids: Array /** - * Visionline-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Visionline-specific metadata associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ visionline_metadata?: | { @@ -371,7 +371,7 @@ export type AcsEntrance = { } | undefined /** - * Warnings associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Warnings associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ warnings: Array< /** diff --git a/src/lib/resources/acs-system.ts b/src/lib/resources/acs-system.ts index 9237ece2..3be1705d 100644 --- a/src/lib/resources/acs-system.ts +++ b/src/lib/resources/acs-system.ts @@ -4,54 +4,54 @@ */ /** - * Represents an [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Represents an [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * - * Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users/object) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials/object) to grant access to the `acs_user`s. + * Within an `acs_system`, create [`acs_user`s](https://www.seam.co/docs/api/acs/users/object) and [`acs_credential`s](https://www.seam.co/docs/api/acs/credentials/object) to grant access to the `acs_user`s. * - * For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs). + * For details about the resources associated with an access control system, see the [access control systems namespace](https://www.seam.co/docs/api/acs/object). */ export type AcsSystem = { /** - * Number of access groups in the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Number of access groups in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ acs_access_group_count?: number | undefined /** - * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ acs_system_id: string /** - * Number of users in the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Number of users in the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ acs_user_count?: number | undefined /** - * ID of the connected account associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * ID of the connected account associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ connected_account_id: string /** - * IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). * @deprecated Use `connected_account_id`. */ connected_account_ids: Array /** - * Date and time at which the [access control system](https://docs.seam.co/low-level-apis/access-systems) was created. + * Date and time at which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) was created. */ created_at: string /** - * ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/low-level-apis/access-systems). + * ID of the default credential manager `acs_system` for this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ default_credential_manager_acs_system_id?: string | null | undefined /** - * Errors associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Errors associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ errors: Array< /** - * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. - * This error might also occur if Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/core-concepts/workspaces). - * 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). + * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + * This error might also occur if Seam Bridge is connected to the wrong [workspace](https://www.seam.co/docs/core-concepts/workspaces). + * 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). */ | { /** @@ -69,8 +69,8 @@ export type AcsSystem = { */ message: string } /** - * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if 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). + * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + * 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). */ | { /** @@ -84,7 +84,7 @@ export type AcsSystem = { error_code: 'bridge_disconnected' /** - * Indicates whether the error is related to the [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to the [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined /** @@ -92,9 +92,9 @@ export type AcsSystem = { */ message: string } /** - * Indicates that [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). - * For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/core-concepts/workspaces). - * See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-visionline_instance_unreachable). + * Indicates that [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://www.seam.co/docs/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). + * For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces). + * See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-visionline_instance_unreachable). */ | { /** @@ -130,7 +130,7 @@ export type AcsSystem = { */ message: string } /** - * Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://docs.seam.co/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system. + * Indicates that Seam's integration user does not have sufficient permissions on the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems). Access cannot be managed until permissions are restored. See the error message for specifics, then either reauthorize the connected account in Seam or grant the integration user the required permissions in the provider's system. */ | { /** @@ -148,7 +148,7 @@ export type AcsSystem = { */ message: string } /** - * Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue. + * Indicates that the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system) to resolve the issue. */ | { /** @@ -166,7 +166,7 @@ export type AcsSystem = { */ message: string } /** - * Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) to restore access. + * Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) to restore access. */ | { /** @@ -184,7 +184,7 @@ export type AcsSystem = { */ message: string } /** - * Indicates that the [access control system](https://docs.seam.co/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. + * Indicates that the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. */ | { /** @@ -223,7 +223,7 @@ export type AcsSystem = { > /** - * Brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. + * Brand-specific terminology for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) type. */ external_type?: | 'pti_site' @@ -245,16 +245,16 @@ export type AcsSystem = { | 'akiles_organization' | undefined /** - * Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/low-level-apis/access-systems) type. + * Display name that corresponds to the brand-specific terminology for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) type. */ external_type_display_name?: string | undefined /** - * Alternative text for the [access control system](https://docs.seam.co/low-level-apis/access-systems) image. + * Alternative text for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) image. */ image_alt_text: string /** - * URL for the image that represents the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * URL for the image that represents the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ image_url: string @@ -264,17 +264,17 @@ export type AcsSystem = { is_credential_manager: boolean /** - * Location information for the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Location information for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ location: { /** - * Time zone in which the [access control system](https://docs.seam.co/low-level-apis/access-systems) is located. + * Time zone in which the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is located. */ time_zone: string | null } /** - * Name of the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Name of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ name: string @@ -305,12 +305,12 @@ export type AcsSystem = { */ system_type_display_name?: string | undefined /** - * Visionline-specific metadata for the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Visionline-specific metadata for the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ visionline_metadata?: | { /** - * IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge) on the local network. + * IP address or hostname of the main Visionline server relative to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge) on the local network. */ lan_address?: string | undefined /** @@ -324,7 +324,7 @@ export type AcsSystem = { } | undefined /** - * Warnings associated with the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * Warnings associated with the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ warnings: Array< /** @@ -346,7 +346,7 @@ export type AcsSystem = { */ warning_code: 'salto_ks_subscription_limit_almost_reached' } /** - * Indicates the [access control system](https://docs.seam.co/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Indicates the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ | { /** @@ -386,7 +386,7 @@ export type AcsSystem = { */ warning_code: 'setup_required' } /** - * Indicates that Seam encountered an unexpected error while syncing this [access control system](https://docs.seam.co/low-level-apis/access-systems), so its users, credentials, and access groups may be out of date. Seam retries on every sync cycle and clears this warning once a sync succeeds; if it persists, contact [support](mailto:support@seam.co). + * Indicates that Seam encountered an unexpected error while syncing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems), so its users, credentials, and access groups may be out of date. Seam retries on every sync cycle and clears this warning once a sync succeeds; if it persists, contact [support](mailto:support@seam.co). */ | { /** @@ -407,7 +407,7 @@ export type AcsSystem = { > /** - * ID of the workspace that contains the [access control system](https://docs.seam.co/low-level-apis/access-systems). + * ID of the workspace that contains the [access control system](https://www.seam.co/docs/low-level-apis/access-systems). */ workspace_id: string } diff --git a/src/lib/resources/acs-user.ts b/src/lib/resources/acs-user.ts index 5a8320f1..1ad1c74b 100644 --- a/src/lib/resources/acs-user.ts +++ b/src/lib/resources/acs-user.ts @@ -4,15 +4,15 @@ */ /** - * Represents a [user](https://docs.seam.co/low-level-apis/access-systems/user-management) in an [access system](https://docs.seam.co/low-level-apis/access-systems). + * Represents a [user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access system](https://www.seam.co/docs/low-level-apis/access-systems). * * An access system user typically refers to an individual who requires access, like an employee or resident. Each user can possess multiple credentials that serve as their keys or identifiers for access. The type of credential can vary widely. For example, in the Salto system, a user can have a PIN code, a mobile app account, and a fob. In other platforms, it is not uncommon for a user to have more than one of the same credential type, such as multiple key cards. Additionally, these credentials can have a schedule or validity period. * - * For details about how to configure users in your access system, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems). + * For details about how to configure users in your access system, see the corresponding [system integration guide](https://www.seam.co/docs/device-and-system-integration-guides#access-control-systems). */ export type AcsUser = { /** - * `starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/low-level-apis/access-systems/user-management) access. + * `starts_at` and `ends_at` timestamps for the [access system user's](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access. */ access_schedule?: | { @@ -27,27 +27,27 @@ export type AcsUser = { } | undefined /** - * ID of the [access system](https://docs.seam.co/low-level-apis/access-systems) that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * ID of the [access system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ acs_system_id: string /** - * ID of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * ID of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ acs_user_id: string /** - * The ID of the connected account that is associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * The ID of the connected account that is associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ connected_account_id: string /** - * Date and time at which the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created. + * Date and time at which the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created. */ created_at: string /** - * Display name for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Display name for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ display_name: string @@ -56,15 +56,15 @@ export type AcsUser = { */ email?: string | undefined /** - * Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ email_address?: string | undefined /** - * Errors associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Errors associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ errors: Array< /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems) outside of Seam. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems) outside of Seam. */ | { /** @@ -79,7 +79,7 @@ export type AcsUser = { */ message: string } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. */ | { /** @@ -94,7 +94,7 @@ export type AcsUser = { */ message: string } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) 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). + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not created on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). */ | { /** @@ -109,7 +109,7 @@ export type AcsUser = { */ message: string } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not updated 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). + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not updated on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). */ | { /** @@ -124,7 +124,7 @@ export type AcsUser = { */ message: string } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was not deleted 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). + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was not deleted on the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). */ | { /** @@ -139,7 +139,7 @@ export type AcsUser = { */ message: string } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created from the Seam API but also exists on Mission Control. This is unsupported. Contact Seam [support](mailto:support@seam.co). */ | { /** @@ -157,7 +157,7 @@ export type AcsUser = { > /** - * Brand-specific terminology for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) type. + * Brand-specific terminology for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) type. */ external_type?: | 'pti_user' @@ -171,11 +171,11 @@ export type AcsUser = { | 'kisi_user' | undefined /** - * Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) type. + * Display name that corresponds to the brand-specific terminology for the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) type. */ external_type_display_name?: string | undefined /** - * Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ full_name?: string | undefined /** @@ -188,11 +188,11 @@ export type AcsUser = { is_managed: true /** - * Indicates whether the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is currently [suspended](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users). + * Indicates whether the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is currently [suspended](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users). */ is_suspended?: boolean | undefined /** - * Pending mutations associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. + * Pending mutations associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. */ pending_mutations?: | Array< @@ -493,11 +493,11 @@ export type AcsUser = { > | undefined /** - * Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). + * Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ phone_number?: string | undefined /** - * Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Salto KS-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ salto_ks_metadata?: | { @@ -508,7 +508,7 @@ export type AcsUser = { } | undefined /** - * Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Salto Space-specific metadata associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ salto_space_metadata?: | { @@ -523,27 +523,27 @@ export type AcsUser = { } | undefined /** - * Email address of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Email address of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ user_identity_email_address?: string | null | undefined /** - * Full name of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Full name of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ user_identity_full_name?: string | null | undefined /** - * ID of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * ID of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ user_identity_id?: string | undefined /** - * Phone number of the user identity associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). + * Phone number of the user identity associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ user_identity_phone_number?: string | null | undefined /** - * Warnings associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Warnings associated with the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ warnings: Array< /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://docs.seam.co/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is being deleted from the [access system](https://www.seam.co/docs/low-level-apis/access-systems). This is a temporary state, and the access system user will be deleted shortly. */ | { /** @@ -558,7 +558,7 @@ export type AcsUser = { warning_code: 'being_deleted' } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. */ | { /** @@ -573,7 +573,7 @@ export type AcsUser = { warning_code: 'salto_ks_user_not_subscribed' } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) exists but is not currently able to gain access—for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) exists but is not currently able to gain access—for example, because their access schedule has not started yet or has ended, the access system has reached its limit for active users, or they have been unsubscribed or deactivated. Refer to the warning message for the provider-specific reason. This is distinct from `is_suspended`, which indicates the user has been explicitly blocked. */ | { /** @@ -588,7 +588,7 @@ export type AcsUser = { warning_code: 'acs_user_inactive' } /** - * An unknown issue occurred while syncing the state of this [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. + * An unknown issue occurred while syncing the state of this [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. */ | { /** @@ -603,7 +603,7 @@ export type AcsUser = { warning_code: 'unknown_issue_with_acs_user' } /** - * Indicates that the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user. + * Indicates that the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) was created on Latch Mission Control. Please use the Latch Mission Control to manage this user. */ | { /** @@ -621,7 +621,7 @@ export type AcsUser = { > /** - * ID of the workspace that contains the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * ID of the workspace that contains the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ workspace_id: string } diff --git a/src/lib/resources/action-attempt.ts b/src/lib/resources/action-attempt.ts index b71897fe..424305f0 100644 --- a/src/lib/resources/action-attempt.ts +++ b/src/lib/resources/action-attempt.ts @@ -192,15 +192,15 @@ export type ActionAttempt = */ acs_credential_on_encoder: { /** - * A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * A number or string that physically identifies the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ card_number: string | null /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string | null /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) will stop being usable. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable. */ ends_at: string | null /** @@ -208,60 +208,60 @@ export type ActionAttempt = */ is_issued: boolean | null /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) becomes usable. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable. */ starts_at: string | null /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ visionline_metadata?: | { /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is cancelled. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled. */ cancelled?: boolean | undefined /** - * Format of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ card_format?: 'TLCode' | 'rfid48' | undefined /** - * Holder of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ card_holder?: string | undefined /** - * Card ID for the Visionline card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ card_id?: string | undefined /** - * IDs of the common [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * IDs of the common [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ common_acs_entrance_ids?: Array | undefined /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is discarded. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded. */ discarded?: boolean | undefined /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is expired. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired. */ expired?: boolean | undefined /** - * IDs of the guest [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * IDs of the guest [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ guest_acs_entrance_ids?: Array | undefined /** - * Number of issued cards associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ number_of_issued_cards?: number | undefined /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is overridden. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden. */ overridden?: boolean | undefined /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is overwritten. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten. */ overwritten?: boolean | undefined /** - * Indicates whether the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is pending auto-update. + * Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update. */ pending_auto_update?: boolean | undefined } @@ -272,12 +272,12 @@ export type ActionAttempt = */ acs_credential_on_seam: { /** - * Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. + * 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`. */ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key' /** - * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ acs_credential_id: string @@ -286,16 +286,16 @@ export type ActionAttempt = */ acs_credential_pool_id?: string | undefined /** - * 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). + * 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). */ acs_system_id: string /** - * 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. + * 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. */ acs_user_id?: string | undefined /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ akiles_metadata?: | { @@ -306,7 +306,7 @@ export type ActionAttempt = } | undefined /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ assa_abloy_vostio_metadata?: | { @@ -337,34 +337,34 @@ export type ActionAttempt = } | undefined /** - * Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ card_number?: string | null | undefined /** - * Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ code?: string | null | undefined /** - * 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. + * 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. */ connected_account_id: string /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string /** - * Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ display_name: string /** - * 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`. + * 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`. */ ends_at?: string | undefined /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ errors: Array<{ /** @@ -378,7 +378,7 @@ export type ActionAttempt = }> /** - * 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`. + * 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`. */ external_type?: | 'pti_card' @@ -397,15 +397,15 @@ export type ActionAttempt = | 'akiles_credential' | undefined /** - * Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * 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. */ external_type_display_name?: string | undefined /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */ is_issued?: boolean | undefined /** - * 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. + * 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. */ is_latest_desired_state_synced_with_provider?: boolean | null | undefined @@ -413,36 +413,36 @@ export type ActionAttempt = is_managed: true | false /** - * 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). + * 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). */ is_multi_phone_sync_credential?: boolean | undefined /** - * 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. + * 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. */ is_one_time_use?: boolean | undefined /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */ issued_at?: string | null | undefined /** - * 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. + * 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. */ latest_desired_state_synced_with_provider_at?: string | null | undefined /** - * ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ parent_acs_credential_id?: string | undefined /** - * 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. + * 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. */ starts_at?: string | undefined /** - * 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. + * 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. */ user_identity_id?: string | undefined /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ visionline_metadata?: | { @@ -481,7 +481,7 @@ export type ActionAttempt = } | undefined /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ warnings: Array<{ /** @@ -517,7 +517,7 @@ export type ActionAttempt = }> /** - * ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ workspace_id: string } | null @@ -613,12 +613,12 @@ export type ActionAttempt = */ result: { /** - * Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. + * 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`. */ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key' /** - * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ acs_credential_id: string @@ -627,16 +627,16 @@ export type ActionAttempt = */ acs_credential_pool_id?: string | undefined /** - * 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). + * 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). */ acs_system_id: string /** - * 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. + * 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. */ acs_user_id?: string | undefined /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ akiles_metadata?: | { @@ -647,7 +647,7 @@ export type ActionAttempt = } | undefined /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ assa_abloy_vostio_metadata?: | { @@ -678,34 +678,34 @@ export type ActionAttempt = } | undefined /** - * Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ card_number?: string | null | undefined /** - * Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ code?: string | null | undefined /** - * 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. + * 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. */ connected_account_id: string /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string /** - * Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ display_name: string /** - * 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`. + * 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`. */ ends_at?: string | undefined /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ errors: Array<{ /** @@ -719,7 +719,7 @@ export type ActionAttempt = }> /** - * 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`. + * 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`. */ external_type?: | 'pti_card' @@ -738,15 +738,15 @@ export type ActionAttempt = | 'akiles_credential' | undefined /** - * Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * 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. */ external_type_display_name?: string | undefined /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */ is_issued?: boolean | undefined /** - * 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. + * 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. */ is_latest_desired_state_synced_with_provider?: boolean | null | undefined @@ -754,35 +754,35 @@ export type ActionAttempt = is_managed: true | false /** - * 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). + * 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). */ is_multi_phone_sync_credential?: boolean | undefined /** - * 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. + * 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. */ is_one_time_use?: boolean | undefined /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */ issued_at?: string | null | undefined /** - * 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. + * 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. */ latest_desired_state_synced_with_provider_at?: string | null | undefined /** - * ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ parent_acs_credential_id?: string | undefined /** - * 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. + * 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. */ starts_at?: string | undefined /** - * 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. + * 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. */ user_identity_id?: string | undefined /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ visionline_metadata?: | { @@ -821,7 +821,7 @@ export type ActionAttempt = } | undefined /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ warnings: Array<{ /** @@ -857,7 +857,7 @@ export type ActionAttempt = }> /** - * ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ workspace_id: string } @@ -940,12 +940,12 @@ export type ActionAttempt = */ result: { /** - * Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. + * 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`. */ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key' /** - * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ acs_credential_id: string @@ -954,16 +954,16 @@ export type ActionAttempt = */ acs_credential_pool_id?: string | undefined /** - * 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). + * 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). */ acs_system_id: string /** - * 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. + * 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. */ acs_user_id?: string | undefined /** - * Akiles-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ akiles_metadata?: | { @@ -974,7 +974,7 @@ export type ActionAttempt = } | undefined /** - * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ assa_abloy_vostio_metadata?: | { @@ -1005,34 +1005,34 @@ export type ActionAttempt = } | undefined /** - * Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ card_number?: string | null | undefined /** - * Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ code?: string | null | undefined /** - * 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. + * 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. */ connected_account_id: string /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */ created_at: string /** - * Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */ display_name: string /** - * 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`. + * 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`. */ ends_at?: string | undefined /** - * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ errors: Array<{ /** @@ -1046,7 +1046,7 @@ export type ActionAttempt = }> /** - * 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`. + * 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`. */ external_type?: | 'pti_card' @@ -1065,15 +1065,15 @@ export type ActionAttempt = | 'akiles_credential' | undefined /** - * Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. + * 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. */ external_type_display_name?: string | undefined /** - * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. + * Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */ is_issued?: boolean | undefined /** - * 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. + * 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. */ is_latest_desired_state_synced_with_provider?: boolean | null | undefined @@ -1083,35 +1083,35 @@ export type ActionAttempt = is_managed: true /** - * 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). + * 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). */ is_multi_phone_sync_credential?: boolean | undefined /** - * 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. + * 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. */ is_one_time_use?: boolean | undefined /** - * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card. + * Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */ issued_at?: string | null | undefined /** - * 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. + * 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. */ latest_desired_state_synced_with_provider_at?: string | null | undefined /** - * ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ parent_acs_credential_id?: string | undefined /** - * 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. + * 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. */ starts_at?: string | undefined /** - * 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. + * 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. */ user_identity_id?: string | undefined /** - * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ visionline_metadata?: | { @@ -1150,7 +1150,7 @@ export type ActionAttempt = } | undefined /** - * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ warnings: Array<{ /** @@ -1186,7 +1186,7 @@ export type ActionAttempt = }> /** - * ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ workspace_id: string } @@ -1294,7 +1294,7 @@ export type ActionAttempt = display_status: string /** - * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */ errors: Array<{ /** @@ -1348,7 +1348,7 @@ export type ActionAttempt = mode: 'code' | 'card' | 'mobile_key' | 'cloud_key' /** - * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. + * 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. */ pending_mutations: Array<{ /** @@ -1397,7 +1397,7 @@ export type ActionAttempt = }> /** - * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */ warnings: Array<{ /** diff --git a/src/lib/resources/client-session.ts b/src/lib/resources/client-session.ts index d52099a3..80685191 100644 --- a/src/lib/resources/client-session.ts +++ b/src/lib/resources/client-session.ts @@ -4,7 +4,7 @@ */ /** - * Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions. + * Represents a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions. * * You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides. * @@ -12,7 +12,7 @@ * * A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own. * - * See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). + * See also [Get Started with React](https://www.seam.co/docs/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */ export type ClientSession = { /** @@ -21,49 +21,49 @@ export type ClientSession = { client_session_id: string /** - * IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ connect_webview_ids: Array /** - * IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ connected_account_ids: Array /** - * Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. + * Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) was created. */ created_at: string /** - * Customer key associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Customer key associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ customer_key?: string | undefined /** - * Number of devices associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Number of devices associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ device_count: number /** - * Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) expires. + * Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) expires. */ expires_at: string /** - * Client session token associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Client session token associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ token: string /** - * Your user ID for the user associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Your user ID for the user associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ user_identifier_key: string | null /** - * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. + * ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. */ user_identity_id?: string | undefined /** - * IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. + * IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. * @deprecated Use `user_identity_id` instead. */ user_identity_ids: Array diff --git a/src/lib/resources/connect-webview.ts b/src/lib/resources/connect-webview.ts index 737ac890..1d97aa4f 100644 --- a/src/lib/resources/connect-webview.ts +++ b/src/lib/resources/connect-webview.ts @@ -4,7 +4,7 @@ */ /** - * Represents a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Represents a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API. * @@ -25,7 +25,7 @@ export type ConnectWebview = { > /** - * List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). + * List of accepted [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */ accepted_providers: Array @@ -39,7 +39,7 @@ export type ConnectWebview = { */ authorized_at: string | null /** - * Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. + * Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */ automatically_manage_new_devices: boolean @@ -58,7 +58,7 @@ export type ConnectWebview = { created_at: string /** - * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. + * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. */ custom_metadata: Record @@ -85,7 +85,7 @@ export type ConnectWebview = { login_successful: boolean /** - * Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). + * Selected provider of the Connect Webview, one of the [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */ selected_provider: string | null /** @@ -99,7 +99,7 @@ export type ConnectWebview = { url: string /** - * Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. + * Indicates whether Seam should [finish syncing all devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview. */ wait_for_device_creation: boolean diff --git a/src/lib/resources/connected-account.ts b/src/lib/resources/connected-account.ts index ddaae9ae..231be273 100644 --- a/src/lib/resources/connected-account.ts +++ b/src/lib/resources/connected-account.ts @@ -4,7 +4,7 @@ */ /** - * Represents a [connected account](https://docs.seam.co/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. + * Represents a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */ export type ConnectedAccount = { /** @@ -24,7 +24,7 @@ export type ConnectedAccount = { account_type_display_name: string /** - * Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API. + * Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API. */ automatically_manage_new_devices: boolean @@ -38,7 +38,7 @@ export type ConnectedAccount = { */ created_at?: string | undefined /** - * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. + * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. */ custom_metadata: Record @@ -78,7 +78,7 @@ export type ConnectedAccount = { error_code: 'account_disconnected' /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined /** @@ -90,7 +90,7 @@ export type ConnectedAccount = { */ message: string } /** - * 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). + * 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). */ | { /** @@ -104,7 +104,7 @@ export type ConnectedAccount = { error_code: 'bridge_disconnected' /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined /** @@ -130,7 +130,7 @@ export type ConnectedAccount = { error_code: 'salto_ks_subscription_limit_exceeded' /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined /** @@ -185,7 +185,7 @@ export type ConnectedAccount = { error_code: 'dormakaba_sites_disconnected' /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined /** diff --git a/src/lib/resources/device-provider.ts b/src/lib/resources/device-provider.ts index f81da0be..27b481c5 100644 --- a/src/lib/resources/device-provider.ts +++ b/src/lib/resources/device-provider.ts @@ -145,6 +145,7 @@ export type DeviceProvider = { | 'sifely' | 'thirty_three_lock' | 'ring' + | 'tapo' | 'ical' | 'lodgify' | 'hostaway' diff --git a/src/lib/resources/device.ts b/src/lib/resources/device.ts index 50197e9c..613a437c 100644 --- a/src/lib/resources/device.ts +++ b/src/lib/resources/device.ts @@ -4,7 +4,7 @@ */ /** - * Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam. + * Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam. */ export type Device = { /** @@ -88,7 +88,7 @@ export type Device = { */ can_unlock_with_code?: boolean | undefined /** - * Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags). + * Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags). */ capabilities_supported: Array< | 'access_code' @@ -110,7 +110,7 @@ export type Device = { created_at: string /** - * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. + * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. */ custom_metadata: Record @@ -211,6 +211,7 @@ export type Device = { | 'ios_phone' | 'android_phone' | 'ring_camera' + | 'tapo_camera' /** * Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. @@ -236,7 +237,7 @@ export type Device = { error_code: 'account_disconnected' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -264,7 +265,7 @@ export type Device = { error_code: 'salto_ks_subscription_limit_exceeded' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -292,7 +293,7 @@ export type Device = { error_code: 'insufficient_permissions' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -320,7 +321,7 @@ export type Device = { error_code: 'dormakaba_sites_disconnected' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -426,7 +427,7 @@ export type Device = { */ message: string } /** - * Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + * Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. */ | { /** @@ -541,7 +542,7 @@ export type Device = { */ message: string } /** - * 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). + * 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). */ | { /** @@ -555,7 +556,7 @@ export type Device = { error_code: 'bridge_disconnected' /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined /** @@ -570,7 +571,7 @@ export type Device = { > /** - * Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). */ is_managed: true @@ -1791,6 +1792,25 @@ export type Device = { serial_no?: string | undefined } | undefined + /** + * Metadata for a Tapo camera. + */ + tapo_metadata?: + | { + /** + * Firmware version reported by the camera. + */ + firmware_version?: string | undefined + /** + * Hardware version reported by the camera. + */ + hardware_version?: string | undefined + /** + * Model reported by the Tapo camera. + */ + model?: string | undefined + } + | undefined /** * Metadata for a Tedee device. */ @@ -2023,7 +2043,7 @@ export type Device = { */ auto_lock_enabled?: boolean | undefined /** - * Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). + * Indicates whether the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://www.seam.co/docs/api/devices/update). */ backup_access_code_pool_enabled?: boolean | undefined /** @@ -2203,37 +2223,37 @@ export type Device = { */ supported_code_lengths?: Array | undefined /** - * Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). + * Indicates whether the device supports a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes). */ supports_backup_access_code_pool?: boolean | undefined /** - * Active [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). * @deprecated Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead. */ active_thermostat_schedule?: | { /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ climate_preset_key: string /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string /** - * ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device. + * ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device. */ device_id: string /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string /** - * Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ errors: Array<{ /** @@ -2253,24 +2273,24 @@ export type Device = { }> /** - * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. + * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. */ is_override_allowed?: boolean | undefined /** - * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ max_override_period_minutes?: number | null | undefined /** - * User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ name: string | null /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at: string /** - * ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ thermostat_schedule_id: string @@ -2282,7 +2302,7 @@ export type Device = { | null | undefined /** - * ID of the active [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ active_thermostat_schedule_id?: string | null | undefined /** @@ -2292,27 +2312,27 @@ export type Device = { | Array<'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied'> | undefined /** - * Available [climate presets](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. + * Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. */ available_climate_presets?: | Array<{ /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. */ can_delete: boolean /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. */ can_edit: boolean /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. */ can_use_with_thermostat_daily_programs: boolean /** - * Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ climate_preset_key: string @@ -2328,15 +2348,15 @@ export type Device = { | 'unoccupied' | undefined /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_fahrenheit?: number | undefined /** - * Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ display_name: string @@ -2360,30 +2380,30 @@ export type Device = { } | undefined /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */ fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_fahrenheit?: number | undefined /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */ hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined /** - * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). * @deprecated Use 'thermostat_schedule.is_override_allowed' */ manual_override_allowed: boolean /** - * User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ name?: string | null | undefined }> @@ -2403,19 +2423,19 @@ export type Device = { current_climate_setting?: | { /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. */ can_delete?: boolean | undefined /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. */ can_edit?: boolean | undefined /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. */ can_use_with_thermostat_daily_programs?: boolean | undefined /** - * Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ climate_preset_key?: string | undefined /** @@ -2430,15 +2450,15 @@ export type Device = { | 'unoccupied' | undefined /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_fahrenheit?: number | undefined /** - * Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ display_name?: string | undefined /** @@ -2461,29 +2481,29 @@ export type Device = { } | undefined /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */ fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_fahrenheit?: number | undefined /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */ hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined /** - * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). * @deprecated Use 'thermostat_schedule.is_override_allowed' */ manual_override_allowed?: boolean | undefined /** - * User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ name?: string | null | undefined } @@ -2494,19 +2514,19 @@ export type Device = { default_climate_setting?: | { /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. */ can_delete?: boolean | undefined /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. */ can_edit?: boolean | undefined /** - * Indicates whether the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + * Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. */ can_use_with_thermostat_daily_programs?: boolean | undefined /** - * Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ climate_preset_key?: string | undefined /** @@ -2521,15 +2541,15 @@ export type Device = { | 'unoccupied' | undefined /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_fahrenheit?: number | undefined /** - * Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ display_name?: string | undefined /** @@ -2552,35 +2572,35 @@ export type Device = { } | undefined /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */ fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_fahrenheit?: number | undefined /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */ hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined /** - * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). * @deprecated Use 'thermostat_schedule.is_override_allowed' */ manual_override_allowed?: boolean | undefined /** - * User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ name?: string | null | undefined } | undefined /** - * Key of the [fallback climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. + * Key of the [fallback climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. */ fallback_climate_preset_key?: string | null | undefined /** @@ -2604,19 +2624,19 @@ export type Device = { */ is_temporary_manual_override_active?: boolean | undefined /** - * Maximum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. + * Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. */ max_cooling_set_point_celsius?: number | undefined /** - * Maximum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. + * Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. */ max_cooling_set_point_fahrenheit?: number | undefined /** - * Maximum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. + * Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. */ max_heating_set_point_celsius?: number | undefined /** - * Maximum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. + * Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. */ max_heating_set_point_fahrenheit?: number | undefined /** @@ -2629,27 +2649,27 @@ export type Device = { max_unique_climate_presets_per_thermostat_weekly_program?: number | undefined /** - * Minimum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. + * Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. */ min_cooling_set_point_celsius?: number | undefined /** - * Minimum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. + * Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. */ min_cooling_set_point_fahrenheit?: number | undefined /** - * Minimum [temperature difference](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode. + * Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode. */ min_heating_cooling_delta_celsius?: number | undefined /** - * Minimum [temperature difference](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode. + * Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode. */ min_heating_cooling_delta_fahrenheit?: number | undefined /** - * Minimum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. + * Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. */ min_heating_set_point_celsius?: number | undefined /** - * Minimum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. + * Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. */ min_heating_set_point_fahrenheit?: number | undefined /** @@ -2665,24 +2685,24 @@ export type Device = { */ temperature_fahrenheit?: number | undefined /** - * Current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ temperature_threshold?: | { /** - * Lower limit in °C within the current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Lower limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ lower_limit_celsius: number | null /** - * Lower limit in °F within the current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Lower limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ lower_limit_fahrenheit: number | null /** - * Upper limit in °C within the current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Upper limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ upper_limit_celsius: number | null /** - * Upper limit in °F within the current [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + * Upper limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. */ upper_limit_fahrenheit: number | null } @@ -2692,7 +2712,7 @@ export type Device = { */ thermostat_daily_program_period_precision_minutes?: number | undefined /** - * Configured [daily programs](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + * Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */ thermostat_daily_programs?: | Array<{ @@ -2715,7 +2735,7 @@ export type Device = { */ periods: Array<{ /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string @@ -2737,7 +2757,7 @@ export type Device = { }> | undefined /** - * Current [weekly program](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + * Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. */ thermostat_weekly_program?: | { diff --git a/src/lib/resources/event.ts b/src/lib/resources/event.ts index 0b93bf7e..d113b062 100644 --- a/src/lib/resources/event.ts +++ b/src/lib/resources/event.ts @@ -4,7 +4,7 @@ */ /** - * An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was created. + * An [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was created. */ export type SeamEvent = | { @@ -1932,7 +1932,7 @@ export type SeamEvent = access_grant_id: string /** - * ID of the affected [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the affected [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ acs_entrance_id: string @@ -1969,7 +1969,7 @@ export type SeamEvent = access_grant_id: string /** - * ID of the affected [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * ID of the affected [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ acs_entrance_id: string @@ -5739,7 +5739,7 @@ export type SeamEvent = */ is_via_nfc?: boolean | undefined /** - * Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. + * Method by which the lock was unlocked. `keycode`: an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */ method: | 'keycode' @@ -5911,11 +5911,11 @@ export type SeamEvent = connected_account_id: string /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_fahrenheit?: number | undefined /** @@ -5948,19 +5948,19 @@ export type SeamEvent = event_type: 'thermostat.manually_adjusted' /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */ fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_fahrenheit?: number | undefined /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */ hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined diff --git a/src/lib/resources/noise-threshold.ts b/src/lib/resources/noise-threshold.ts index 79fe8e76..8121f10e 100644 --- a/src/lib/resources/noise-threshold.ts +++ b/src/lib/resources/noise-threshold.ts @@ -4,7 +4,7 @@ */ /** - * Represents a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. + * Represents a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. */ export type NoiseThreshold = { /** @@ -33,7 +33,7 @@ export type NoiseThreshold = { noise_threshold_id: string /** - * Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors). + * Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors). */ noise_threshold_nrs?: number | undefined /** diff --git a/src/lib/resources/phone.ts b/src/lib/resources/phone.ts index 02f081d8..0ca12ec8 100644 --- a/src/lib/resources/phone.ts +++ b/src/lib/resources/phone.ts @@ -13,7 +13,7 @@ export type Phone = { created_at: string /** - * Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. + * Optional [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */ custom_metadata: Record diff --git a/src/lib/resources/thermostat-daily-program.ts b/src/lib/resources/thermostat-daily-program.ts index a5815eb8..d27d4205 100644 --- a/src/lib/resources/thermostat-daily-program.ts +++ b/src/lib/resources/thermostat-daily-program.ts @@ -26,7 +26,7 @@ export type ThermostatDailyProgram = { */ periods: Array<{ /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key: string diff --git a/src/lib/resources/thermostat-schedule.ts b/src/lib/resources/thermostat-schedule.ts index 23e7c1a5..05cd13f6 100644 --- a/src/lib/resources/thermostat-schedule.ts +++ b/src/lib/resources/thermostat-schedule.ts @@ -4,31 +4,31 @@ */ /** - * Represents a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. + * Represents a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */ export type ThermostatSchedule = { /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ climate_preset_key: string /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. */ created_at: string /** - * ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device. + * ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device. */ device_id: string /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ ends_at: string /** - * Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ errors: Array<{ /** @@ -48,24 +48,24 @@ export type ThermostatSchedule = { }> /** - * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. + * Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. */ is_override_allowed?: boolean | undefined /** - * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ max_override_period_minutes?: number | null | undefined /** - * User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ name: string | null /** - * Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */ starts_at: string /** - * ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ thermostat_schedule_id: string diff --git a/src/lib/resources/unmanaged-access-code.ts b/src/lib/resources/unmanaged-access-code.ts index cc08778c..068e41e2 100644 --- a/src/lib/resources/unmanaged-access-code.ts +++ b/src/lib/resources/unmanaged-access-code.ts @@ -4,7 +4,7 @@ */ /** - * Represents an [unmanaged smart lock access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Represents an [unmanaged smart lock access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). * * 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. * @@ -14,7 +14,7 @@ * * Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes: * - * - [Kwikset](https://docs.seam.co/device-and-system-integration-guides/kwikset-locks) + * - [Kwikset](https://www.seam.co/docs/device-and-system-integration-guides/kwikset-locks) */ export type UnmanagedAccessCode = { /** @@ -94,7 +94,7 @@ export type UnmanagedAccessCode = { */ ends_at?: string | null | undefined /** - * Errors associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Errors associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). */ errors: Array< /** @@ -362,7 +362,7 @@ export type UnmanagedAccessCode = { /** * Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */ - error_code: 'failed_to_expire' + error_code: 'failed_to_remove' /** * Indicates that this is an access code error. @@ -388,7 +388,7 @@ export type UnmanagedAccessCode = { error_code: 'account_disconnected' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -416,7 +416,7 @@ export type UnmanagedAccessCode = { error_code: 'salto_ks_subscription_limit_exceeded' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -444,7 +444,7 @@ export type UnmanagedAccessCode = { error_code: 'insufficient_permissions' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -472,7 +472,7 @@ export type UnmanagedAccessCode = { error_code: 'dormakaba_sites_disconnected' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -578,7 +578,7 @@ export type UnmanagedAccessCode = { */ message: string } /** - * Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + * Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. */ | { /** @@ -693,7 +693,7 @@ export type UnmanagedAccessCode = { */ message: string } /** - * 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). + * 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). */ | { /** @@ -707,7 +707,7 @@ export type UnmanagedAccessCode = { error_code: 'bridge_disconnected' /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined /** @@ -746,7 +746,7 @@ export type UnmanagedAccessCode = { type: 'time_bound' | 'ongoing' /** - * Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Warnings associated with the [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). */ warnings: Array< /** diff --git a/src/lib/resources/unmanaged-access-grant.ts b/src/lib/resources/unmanaged-access-grant.ts index f8fb7087..0bedc8c8 100644 --- a/src/lib/resources/unmanaged-access-grant.ts +++ b/src/lib/resources/unmanaged-access-grant.ts @@ -32,7 +32,7 @@ export type UnmanagedAccessGrant = { */ ends_at: string | null /** - * Errors associated with the [access grant](https://docs.seam.co/use-cases/granting-access). + * Errors associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */ errors: Array< /** @@ -222,11 +222,11 @@ export type UnmanagedAccessGrant = { */ user_identity_id?: string | undefined /** - * Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). + * Warnings associated with the [access grant](https://www.seam.co/docs/use-cases/granting-access). */ warnings: Array< /** - * Indicates that the [access grant](https://docs.seam.co/use-cases/granting-access) is being deleted. + * Indicates that the [access grant](https://www.seam.co/docs/use-cases/granting-access) is being deleted. */ | { /** @@ -301,7 +301,7 @@ export type UnmanagedAccessGrant = { */ warning_code: 'overprovisioned_access' } /** - * Indicates that the access times for this [access grant](https://docs.seam.co/use-cases/granting-access) are being updated. + * Indicates that the access times for this [access grant](https://www.seam.co/docs/use-cases/granting-access) are being updated. */ | { /** diff --git a/src/lib/resources/unmanaged-access-method.ts b/src/lib/resources/unmanaged-access-method.ts index 62ea4c0a..b45a5986 100644 --- a/src/lib/resources/unmanaged-access-method.ts +++ b/src/lib/resources/unmanaged-access-method.ts @@ -32,11 +32,11 @@ export type UnmanagedAccessMethod = { display_status: string /** - * Errors associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */ errors: Array< /** - * 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. + * 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. */ { /** @@ -87,7 +87,7 @@ export type UnmanagedAccessMethod = { mode: 'code' | 'card' | 'mobile_key' | 'cloud_key' /** - * Pending mutations for the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. + * 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. */ pending_mutations: Array< /** @@ -216,11 +216,11 @@ export type UnmanagedAccessMethod = { > /** - * Warnings associated with the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant). + * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */ warnings: Array< /** - * Indicates that the [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) is being deleted. + * Indicates that the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant) is being deleted. */ | { /** @@ -238,7 +238,7 @@ export type UnmanagedAccessMethod = { */ warning_code: 'being_deleted' } /** - * Indicates that the access times for this [access method](https://docs.seam.co/use-cases/granting-access/creating-an-access-grant) are being updated. + * 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. */ | { /** @@ -278,7 +278,7 @@ export type UnmanagedAccessMethod = { */ warning_code: 'pulled_backup_access_code' } /** - * 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. + * 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. */ | { /** @@ -296,7 +296,7 @@ export type UnmanagedAccessMethod = { */ warning_code: 'delay_in_issuing' } /** - * 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. + * 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. */ | { /** @@ -314,7 +314,7 @@ export type UnmanagedAccessMethod = { */ warning_code: 'user_identity_missing_email_address' } /** - * 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. + * 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. */ | { /** diff --git a/src/lib/resources/unmanaged-device.ts b/src/lib/resources/unmanaged-device.ts index c6fce057..cfe2fb98 100644 --- a/src/lib/resources/unmanaged-device.ts +++ b/src/lib/resources/unmanaged-device.ts @@ -4,7 +4,7 @@ */ /** - * Represents an [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * Represents an [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). */ export type UnmanagedDevice = { /** @@ -88,7 +88,7 @@ export type UnmanagedDevice = { */ can_unlock_with_code?: boolean | undefined /** - * Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags). + * Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags). */ capabilities_supported: Array< | 'access_code' @@ -110,7 +110,7 @@ export type UnmanagedDevice = { created_at: string /** - * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. + * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted. */ custom_metadata: Record @@ -166,6 +166,7 @@ export type UnmanagedDevice = { | 'ios_phone' | 'android_phone' | 'ring_camera' + | 'tapo_camera' /** * Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. @@ -191,7 +192,7 @@ export type UnmanagedDevice = { error_code: 'account_disconnected' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -219,7 +220,7 @@ export type UnmanagedDevice = { error_code: 'salto_ks_subscription_limit_exceeded' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -247,7 +248,7 @@ export type UnmanagedDevice = { error_code: 'insufficient_permissions' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -275,7 +276,7 @@ export type UnmanagedDevice = { error_code: 'dormakaba_sites_disconnected' /** - * Indicates that the error is a [connected account](https://docs.seam.co/api/connected_accounts) error. + * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error. */ is_connected_account_error: true @@ -381,7 +382,7 @@ export type UnmanagedDevice = { */ message: string } /** - * Indicates that the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. + * Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty. */ | { /** @@ -496,7 +497,7 @@ export type UnmanagedDevice = { */ message: string } /** - * 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). + * 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). */ | { /** @@ -510,7 +511,7 @@ export type UnmanagedDevice = { error_code: 'bridge_disconnected' /** - * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge). + * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge). */ is_bridge_error?: boolean | undefined /** diff --git a/src/lib/resources/user-identity.ts b/src/lib/resources/user-identity.ts index 56cfb247..9bb74fea 100644 --- a/src/lib/resources/user-identity.ts +++ b/src/lib/resources/user-identity.ts @@ -4,7 +4,7 @@ */ /** - * Represents a [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. + * Represents a [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */ export type UserIdentity = { /** diff --git a/src/lib/resources/webhook.ts b/src/lib/resources/webhook.ts index b5bf9d6c..267f3776 100644 --- a/src/lib/resources/webhook.ts +++ b/src/lib/resources/webhook.ts @@ -4,19 +4,19 @@ */ /** - * Represents a [webhook](https://docs.seam.co/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive. + * Represents a [webhook](https://www.seam.co/docs/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive. */ export type Webhook = { /** - * Types of events that the [webhook](https://docs.seam.co/developer-tools/webhooks) should receive. + * Types of events that the [webhook](https://www.seam.co/docs/developer-tools/webhooks) should receive. */ event_types?: Array | undefined /** - * Secret associated with the [webhook](https://docs.seam.co/developer-tools/webhooks). + * Secret associated with the [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ secret?: string | undefined /** - * URL for the [webhook](https://docs.seam.co/developer-tools/webhooks). + * URL for the [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ url: string diff --git a/src/lib/resources/workspace.ts b/src/lib/resources/workspace.ts index 62df3046..c6645adc 100644 --- a/src/lib/resources/workspace.ts +++ b/src/lib/resources/workspace.ts @@ -4,39 +4,39 @@ */ /** - * Represents a Seam [workspace](https://docs.seam.co/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/core-concepts/workspaces#production-workspaces). + * Represents a Seam [workspace](https://www.seam.co/docs/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://www.seam.co/docs/core-concepts/workspaces#production-workspaces). */ export type Workspace = { /** - * Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces). + * Company name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces). * @deprecated Use `connect_partner_name` instead. */ company_name: string /** - * Seam Connect partner name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces). + * Seam Connect partner name associated with the [workspace](https://www.seam.co/docs/core-concepts/workspaces). */ connect_partner_name: string | null connect_webview_customization: { /** - * URL of the inviter logo for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * URL of the inviter logo for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ inviter_logo_url?: string | undefined /** - * Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Logo shape for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ logo_shape?: 'circle' | 'square' | undefined /** - * Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Primary button color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_color?: string | undefined /** - * Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Primary button text color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_text_color?: string | undefined /** - * Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Success message for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ success_message?: string | undefined } @@ -47,17 +47,17 @@ export type Workspace = { is_publishable_key_auth_enabled: boolean /** - * Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Indicates whether the workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ is_sandbox: boolean /** - * Indicates whether the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. + * Indicates whether the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. */ is_suspended: boolean /** - * Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). + * Name of the [workspace](https://www.seam.co/docs/core-concepts/workspaces). */ name: string @@ -66,7 +66,7 @@ export type Workspace = { */ organization_id: string | null /** - * Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications. + * Publishable key for the [workspace](https://www.seam.co/docs/core-concepts/workspaces). This key is used to identify the workspace in client-side applications. */ publishable_key?: string | undefined /** diff --git a/src/lib/routes/access-codes/access-codes.ts b/src/lib/routes/access-codes/access-codes.ts index b7383c5a..ee4cd861 100644 --- a/src/lib/routes/access-codes/access-codes.ts +++ b/src/lib/routes/access-codes/access-codes.ts @@ -174,7 +174,7 @@ export class SeamHttpAccessCodes { } /** - * 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. + * 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. */ create( parameters: AccessCodesCreateParameters, @@ -194,7 +194,7 @@ export class SeamHttpAccessCodes { } /** - * Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. + * Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. * * 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. * @@ -202,9 +202,9 @@ export class SeamHttpAccessCodes { * * 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`. * - * 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). + * 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). * - * 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. + * 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. */ createMultiple( parameters: AccessCodesCreateMultipleParameters, @@ -224,7 +224,7 @@ export class SeamHttpAccessCodes { } /** - * Deletes an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). */ delete( parameters: AccessCodesDeleteParameters, @@ -244,7 +244,7 @@ export class SeamHttpAccessCodes { } /** - * Generates a code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes), given a device ID. + * Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID. */ generateCode( parameters: AccessCodesGenerateCodeParameters, @@ -264,7 +264,7 @@ export class SeamHttpAccessCodes { } /** - * Returns a specified [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * You must specify either `access_code_id` or both `device_id` and `code`. */ @@ -286,7 +286,7 @@ export class SeamHttpAccessCodes { } /** - * Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */ @@ -318,7 +318,7 @@ export class SeamHttpAccessCodes { } /** - * 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). + * 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). * * 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. * @@ -368,9 +368,9 @@ export class SeamHttpAccessCodes { } /** - * Updates a specified active or upcoming [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * - * See also [Modifying Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes). + * See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes). */ update( parameters: AccessCodesUpdateParameters, @@ -390,11 +390,11 @@ export class SeamHttpAccessCodes { } /** - * Updates [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. + * Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. * * Specify the `common_code_key` to identify the set of access codes that you want to update. * - * 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). + * 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). */ updateMultiple( parameters: AccessCodesUpdateMultipleParameters, @@ -416,7 +416,7 @@ export class SeamHttpAccessCodes { export type AccessCodesCreateParameters = { /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * 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`. */ allow_external_modification?: boolean | undefined @@ -426,7 +426,7 @@ export type AccessCodesCreateParameters = { */ code?: string | undefined /** - * 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). + * 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). */ common_code_key?: string | undefined /** @@ -439,19 +439,19 @@ export type AccessCodesCreateParameters = { */ ends_at?: string | undefined /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * 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`. */ is_external_modification_allowed?: boolean | undefined /** - * Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes). + * 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). */ is_offline_access_code?: boolean | undefined /** - * 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. + * 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. */ is_one_time_use?: boolean | undefined /** - * 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`. + * 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`. */ max_time_rounding?: '1hour' | '1day' | '1h' | '1d' | undefined /** @@ -465,7 +465,7 @@ export type AccessCodesCreateParameters = { */ name?: string | undefined /** - * 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`. + * 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`. */ prefer_native_scheduling?: boolean | undefined /** @@ -477,7 +477,7 @@ export type AccessCodesCreateParameters = { */ starts_at?: string | undefined /** - * 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). + * 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). */ use_backup_access_code_pool?: boolean | undefined /** @@ -500,7 +500,7 @@ export interface AccessCodesCreateOptions {} export type AccessCodesCreateMultipleParameters = { /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * 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`. */ allow_external_modification?: boolean | undefined @@ -524,7 +524,7 @@ export type AccessCodesCreateMultipleParameters = { */ ends_at?: string | undefined /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * 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`. */ is_external_modification_allowed?: boolean | undefined /** @@ -538,7 +538,7 @@ export type AccessCodesCreateMultipleParameters = { */ name?: string | undefined /** - * 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`. + * 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`. */ prefer_native_scheduling?: boolean | undefined /** @@ -550,7 +550,7 @@ export type AccessCodesCreateMultipleParameters = { */ starts_at?: string | undefined /** - * 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). + * 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). */ use_backup_access_code_pool?: boolean | undefined } @@ -764,7 +764,7 @@ export type AccessCodesUpdateParameters = { access_code_id: string /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * 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`. */ allow_external_modification?: boolean | undefined @@ -782,7 +782,7 @@ export type AccessCodesUpdateParameters = { */ ends_at?: string | undefined /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. + * 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`. */ is_external_modification_allowed?: boolean | undefined /** @@ -804,7 +804,7 @@ export type AccessCodesUpdateParameters = { */ starts_at?: string | undefined /** - * 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). + * 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). */ type?: 'ongoing' | 'time_bound' | undefined } diff --git a/src/lib/routes/access-codes/simulate/simulate.ts b/src/lib/routes/access-codes/simulate/simulate.ts index 33e8906b..2d04016e 100644 --- a/src/lib/routes/access-codes/simulate/simulate.ts +++ b/src/lib/routes/access-codes/simulate/simulate.ts @@ -162,7 +162,7 @@ export class SeamHttpAccessCodesSimulate { } /** - * 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). + * 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). */ createUnmanagedAccessCode( parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters, diff --git a/src/lib/routes/access-codes/unmanaged/unmanaged.ts b/src/lib/routes/access-codes/unmanaged/unmanaged.ts index 16921a9a..9d0ae7a3 100644 --- a/src/lib/routes/access-codes/unmanaged/unmanaged.ts +++ b/src/lib/routes/access-codes/unmanaged/unmanaged.ts @@ -163,7 +163,7 @@ export class SeamHttpAccessCodesUnmanaged { } /** - * 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). + * 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). * * 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. * @@ -187,7 +187,7 @@ export class SeamHttpAccessCodesUnmanaged { } /** - * Deletes an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). */ delete( parameters: AccessCodesUnmanagedDeleteParameters, @@ -207,7 +207,7 @@ export class SeamHttpAccessCodesUnmanaged { } /** - * Returns a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). * * You must specify either `access_code_id` or both `device_id` and `code`. */ @@ -229,7 +229,7 @@ export class SeamHttpAccessCodesUnmanaged { } /** - * Returns a list of all [unmanaged access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). */ list( parameters: AccessCodesUnmanagedListParameters, @@ -250,7 +250,7 @@ export class SeamHttpAccessCodesUnmanaged { } /** - * Updates a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). */ update( parameters: AccessCodesUnmanagedUpdateParameters, @@ -277,7 +277,7 @@ export type AccessCodesUnmanagedConvertToManagedParameters = { access_code_id: string /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. + * Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. */ allow_external_modification?: boolean | undefined /** @@ -285,7 +285,7 @@ export type AccessCodesUnmanagedConvertToManagedParameters = { */ force?: boolean | undefined /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. + * Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed. */ is_external_modification_allowed?: boolean | undefined } @@ -395,7 +395,7 @@ export type AccessCodesUnmanagedUpdateParameters = { access_code_id: string /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. + * Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. */ allow_external_modification?: boolean | undefined /** @@ -403,7 +403,7 @@ export type AccessCodesUnmanagedUpdateParameters = { */ force?: boolean | undefined /** - * Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. + * Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. */ is_external_modification_allowed?: boolean | undefined diff --git a/src/lib/routes/access-grants/access-grants.ts b/src/lib/routes/access-grants/access-grants.ts index b1599a1e..becc6622 100644 --- a/src/lib/routes/access-grants/access-grants.ts +++ b/src/lib/routes/access-grants/access-grants.ts @@ -170,7 +170,7 @@ export class SeamHttpAccessGrants { } /** - * 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. + * 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. */ create( parameters: AccessGrantsCreateParameters, @@ -328,7 +328,7 @@ export type AccessGrantsCreateParameters = { */ access_grant_key?: string | undefined /** - * Set of IDs of the [entrances](https://docs.seam.co/api/acs/systems/list) to which access is being granted. + * Set of IDs of the [entrances](https://www.seam.co/docs/api/acs/systems/list) to which access is being granted. */ acs_entrance_ids?: Array | undefined /** @@ -336,7 +336,7 @@ export type AccessGrantsCreateParameters = { */ customization_profile_id?: string | undefined /** - * Set of IDs of the [devices](https://docs.seam.co/api/devices/list) to which access is being granted. + * Set of IDs of the [devices](https://www.seam.co/docs/api/devices/list) to which access is being granted. */ device_ids?: Array | undefined /** diff --git a/src/lib/routes/access-methods/access-methods.ts b/src/lib/routes/access-methods/access-methods.ts index 5b2517f9..aa5fbe89 100644 --- a/src/lib/routes/access-methods/access-methods.ts +++ b/src/lib/routes/access-methods/access-methods.ts @@ -221,7 +221,7 @@ export class SeamHttpAccessMethods { } /** - * 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). + * 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). */ encode( parameters: AccessMethodsEncodeParameters, @@ -314,7 +314,7 @@ export class SeamHttpAccessMethods { } /** - * 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. + * 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. */ unlockDoor( parameters: AccessMethodsUnlockDoorParameters, diff --git a/src/lib/routes/acs/access-groups/access-groups.ts b/src/lib/routes/acs/access-groups/access-groups.ts index 49be6654..24ee2a9f 100644 --- a/src/lib/routes/acs/access-groups/access-groups.ts +++ b/src/lib/routes/acs/access-groups/access-groups.ts @@ -164,7 +164,7 @@ export class SeamHttpAcsAccessGroups { } /** - * 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). + * 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). */ addUser( parameters: AcsAccessGroupsAddUserParameters, @@ -184,7 +184,7 @@ export class SeamHttpAcsAccessGroups { } /** - * Deletes a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). */ delete( parameters: AcsAccessGroupsDeleteParameters, @@ -204,7 +204,7 @@ export class SeamHttpAcsAccessGroups { } /** - * Returns a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). */ get( parameters: AcsAccessGroupsGetParameters, @@ -224,7 +224,7 @@ export class SeamHttpAcsAccessGroups { } /** - * Returns a list of all [access groups](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). */ list( parameters?: AcsAccessGroupsListParameters, @@ -244,7 +244,7 @@ export class SeamHttpAcsAccessGroups { } /** - * 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). + * 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). */ listAccessibleEntrances( parameters: AcsAccessGroupsListAccessibleEntrancesParameters, @@ -264,7 +264,7 @@ export class SeamHttpAcsAccessGroups { } /** - * 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). + * 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). */ listUsers( parameters: AcsAccessGroupsListUsersParameters, @@ -284,7 +284,7 @@ export class SeamHttpAcsAccessGroups { } /** - * 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). + * 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). */ removeUser( parameters: AcsAccessGroupsRemoveUserParameters, diff --git a/src/lib/routes/acs/credentials/credentials.ts b/src/lib/routes/acs/credentials/credentials.ts index 59fe48c3..e8928883 100644 --- a/src/lib/routes/acs/credentials/credentials.ts +++ b/src/lib/routes/acs/credentials/credentials.ts @@ -163,7 +163,7 @@ export class SeamHttpAcsCredentials { } /** - * 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). + * 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). */ assign( parameters: AcsCredentialsAssignParameters, @@ -183,7 +183,7 @@ export class SeamHttpAcsCredentials { } /** - * 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. + * 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. */ create( parameters: AcsCredentialsCreateParameters, @@ -203,7 +203,7 @@ export class SeamHttpAcsCredentials { } /** - * Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ delete( parameters: AcsCredentialsDeleteParameters, @@ -223,7 +223,7 @@ export class SeamHttpAcsCredentials { } /** - * Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ get( parameters: AcsCredentialsGetParameters, @@ -243,7 +243,7 @@ export class SeamHttpAcsCredentials { } /** - * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ list( parameters?: AcsCredentialsListParameters, @@ -264,7 +264,7 @@ export class SeamHttpAcsCredentials { } /** - * 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. + * 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. */ listAccessibleEntrances( parameters: AcsCredentialsListAccessibleEntrancesParameters, @@ -284,7 +284,7 @@ export class SeamHttpAcsCredentials { } /** - * 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). + * 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). */ unassign( parameters: AcsCredentialsUnassignParameters, @@ -304,7 +304,7 @@ export class SeamHttpAcsCredentials { } /** - * Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * 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). */ update( parameters: AcsCredentialsUpdateParameters, @@ -364,7 +364,7 @@ export type AcsCredentialsCreateParameters = { */ acs_user_id?: string | undefined /** - * 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. + * 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. */ allowed_acs_entrance_ids?: Array | undefined /** @@ -382,7 +382,7 @@ export type AcsCredentialsCreateParameters = { } | undefined /** - * 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). + * 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). */ code?: string | undefined /** @@ -394,7 +394,7 @@ export type AcsCredentialsCreateParameters = { */ ends_at?: string | Date | Temporal.Instant | undefined /** - * 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). + * 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). */ is_multi_phone_sync_credential?: boolean | undefined /** @@ -403,7 +403,7 @@ export type AcsCredentialsCreateParameters = { salto_space_metadata?: | { /** - * Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). + * Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://www.seam.co/docs/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). */ assign_new_key?: boolean | undefined } diff --git a/src/lib/routes/acs/encoders/encoders.ts b/src/lib/routes/acs/encoders/encoders.ts index 765fd0f7..bfb758a8 100644 --- a/src/lib/routes/acs/encoders/encoders.ts +++ b/src/lib/routes/acs/encoders/encoders.ts @@ -170,7 +170,7 @@ export class SeamHttpAcsEncoders { } /** - * 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` + * 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` */ encodeCredential( parameters: AcsEncodersEncodeCredentialParameters, @@ -195,7 +195,7 @@ export class SeamHttpAcsEncoders { } /** - * Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ get( parameters: AcsEncodersGetParameters, @@ -215,7 +215,7 @@ export class SeamHttpAcsEncoders { } /** - * Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ list( parameters?: AcsEncodersListParameters, @@ -236,7 +236,7 @@ export class SeamHttpAcsEncoders { } /** - * 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). + * 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). */ scanCredential( parameters: AcsEncodersScanCredentialParameters, @@ -261,7 +261,7 @@ export class SeamHttpAcsEncoders { } /** - * 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`. + * 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`. */ scanToAssignCredential( parameters: AcsEncodersScanToAssignCredentialParameters, diff --git a/src/lib/routes/acs/encoders/simulate/simulate.ts b/src/lib/routes/acs/encoders/simulate/simulate.ts index 1ea81622..7412f709 100644 --- a/src/lib/routes/acs/encoders/simulate/simulate.ts +++ b/src/lib/routes/acs/encoders/simulate/simulate.ts @@ -161,7 +161,7 @@ export class SeamHttpAcsEncodersSimulate { } /** - * 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). + * 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). */ nextCredentialEncodeWillFail( parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters, @@ -181,7 +181,7 @@ export class SeamHttpAcsEncodersSimulate { } /** - * 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). + * 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). */ nextCredentialEncodeWillSucceed( parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters, @@ -201,7 +201,7 @@ export class SeamHttpAcsEncodersSimulate { } /** - * 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). + * 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). */ nextCredentialScanWillFail( parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters, @@ -221,7 +221,7 @@ export class SeamHttpAcsEncodersSimulate { } /** - * 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). + * 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). */ nextCredentialScanWillSucceed( parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters, diff --git a/src/lib/routes/acs/entrances/entrances.ts b/src/lib/routes/acs/entrances/entrances.ts index 6ddce67f..8cf17ad0 100644 --- a/src/lib/routes/acs/entrances/entrances.ts +++ b/src/lib/routes/acs/entrances/entrances.ts @@ -165,7 +165,7 @@ export class SeamHttpAcsEntrances { } /** - * Returns a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ get( parameters: AcsEntrancesGetParameters, @@ -185,7 +185,7 @@ export class SeamHttpAcsEntrances { } /** - * 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). + * 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). */ grantAccess( parameters: AcsEntrancesGrantAccessParameters, @@ -205,7 +205,7 @@ export class SeamHttpAcsEntrances { } /** - * Returns a list of all [access system entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ list( parameters?: AcsEntrancesListParameters, @@ -226,7 +226,7 @@ export class SeamHttpAcsEntrances { } /** - * 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). + * 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). */ listCredentialsWithAccess( parameters: AcsEntrancesListCredentialsWithAccessParameters, @@ -246,7 +246,7 @@ export class SeamHttpAcsEntrances { } /** - * 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. + * 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. */ unlock( parameters: AcsEntrancesUnlockParameters, diff --git a/src/lib/routes/acs/systems/systems.ts b/src/lib/routes/acs/systems/systems.ts index 5c91826f..8b45337b 100644 --- a/src/lib/routes/acs/systems/systems.ts +++ b/src/lib/routes/acs/systems/systems.ts @@ -162,7 +162,7 @@ export class SeamHttpAcsSystems { } /** - * Returns a specified [access system](https://docs.seam.co/low-level-apis/access-systems). + * Returns a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems). */ get( parameters: AcsSystemsGetParameters, @@ -182,7 +182,7 @@ export class SeamHttpAcsSystems { } /** - * Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems). + * Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems). * * To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace. */ @@ -204,7 +204,7 @@ export class SeamHttpAcsSystems { } /** - * Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/low-level-apis/access-systems). + * Returns a list of all credential manager systems that are compatible with a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems). * * Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body. */ diff --git a/src/lib/routes/acs/users/users.ts b/src/lib/routes/acs/users/users.ts index c67ded7d..de76b467 100644 --- a/src/lib/routes/acs/users/users.ts +++ b/src/lib/routes/acs/users/users.ts @@ -164,7 +164,7 @@ export class SeamHttpAcsUsers { } /** - * 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). + * 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). */ addToAccessGroup( parameters: AcsUsersAddToAccessGroupParameters, @@ -184,7 +184,7 @@ export class SeamHttpAcsUsers { } /** - * Creates a new [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Creates a new [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ create( parameters: AcsUsersCreateParameters, @@ -204,7 +204,7 @@ export class SeamHttpAcsUsers { } /** - * Deletes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Deletes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ delete( parameters: AcsUsersDeleteParameters, @@ -228,7 +228,7 @@ export class SeamHttpAcsUsers { } /** - * Returns a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Returns a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ get( parameters: AcsUsersGetParameters, @@ -252,7 +252,7 @@ export class SeamHttpAcsUsers { } /** - * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ list( parameters?: AcsUsersListParameters, @@ -273,7 +273,7 @@ export class SeamHttpAcsUsers { } /** - * Lists the [entrances](https://docs.seam.co/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) has access. + * Lists the [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) has access. */ listAccessibleEntrances( parameters: AcsUsersListAccessibleEntrancesParameters, @@ -297,7 +297,7 @@ export class SeamHttpAcsUsers { } /** - * 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). + * 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). */ removeFromAccessGroup( parameters: AcsUsersRemoveFromAccessGroupParameters, @@ -317,7 +317,7 @@ export class SeamHttpAcsUsers { } /** - * Revokes access to all [entrances](https://docs.seam.co/api/acs/entrances) for a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Revokes access to all [entrances](https://www.seam.co/docs/api/acs/entrances/object) for a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ revokeAccessToAllEntrances( parameters: AcsUsersRevokeAccessToAllEntrancesParameters, @@ -341,7 +341,7 @@ export class SeamHttpAcsUsers { } /** - * [Suspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/api/acs/users/unsuspend) them. + * [Suspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://www.seam.co/docs/api/acs/users/unsuspend) them. */ suspend( parameters: AcsUsersSuspendParameters, @@ -365,7 +365,7 @@ export class SeamHttpAcsUsers { } /** - * [Unsuspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access. + * [Unsuspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). While [suspending an access system user](https://www.seam.co/docs/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access. */ unsuspend( parameters: AcsUsersUnsuspendParameters, @@ -389,7 +389,7 @@ export class SeamHttpAcsUsers { } /** - * Updates the properties of a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Updates the properties of a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ update( parameters: AcsUsersUpdateParameters, @@ -470,7 +470,7 @@ export type AcsUsersCreateParameters = { */ email?: string | undefined /** - * Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ email_address?: string | undefined /** @@ -479,7 +479,7 @@ export type AcsUsersCreateParameters = { full_name: string /** - * Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). + * Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ phone_number?: string | undefined /** @@ -779,11 +779,11 @@ export type AcsUsersUpdateParameters = RequireAtLeastOne< */ email?: string | undefined /** - * Email address of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ email_address?: string | undefined /** - * Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ full_name?: string | undefined /** @@ -791,7 +791,7 @@ export type AcsUsersUpdateParameters = RequireAtLeastOne< */ hid_acs_system_id?: string | undefined /** - * Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). + * Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`). */ phone_number?: string | undefined /** diff --git a/src/lib/routes/action-attempts/action-attempts.ts b/src/lib/routes/action-attempts/action-attempts.ts index 696bdb38..cba7c359 100644 --- a/src/lib/routes/action-attempts/action-attempts.ts +++ b/src/lib/routes/action-attempts/action-attempts.ts @@ -162,7 +162,7 @@ export class SeamHttpActionAttempts { } /** - * Returns a specified [action attempt](https://docs.seam.co/core-concepts/action-attempts). + * Returns a specified [action attempt](https://www.seam.co/docs/core-concepts/action-attempts). */ get( parameters: ActionAttemptsGetParameters, @@ -187,7 +187,7 @@ export class SeamHttpActionAttempts { } /** - * Returns a list of the [action attempts](https://docs.seam.co/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s. + * Returns a list of the [action attempts](https://www.seam.co/docs/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s. */ list( parameters?: ActionAttemptsListParameters, diff --git a/src/lib/routes/client-sessions/client-sessions.ts b/src/lib/routes/client-sessions/client-sessions.ts index 40902c93..80463e80 100644 --- a/src/lib/routes/client-sessions/client-sessions.ts +++ b/src/lib/routes/client-sessions/client-sessions.ts @@ -162,7 +162,7 @@ export class SeamHttpClientSessions { } /** - * Creates a new [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Creates a new [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ create( parameters?: ClientSessionsCreateParameters, @@ -182,7 +182,7 @@ export class SeamHttpClientSessions { } /** - * Deletes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Deletes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ delete( parameters: ClientSessionsDeleteParameters, @@ -202,7 +202,7 @@ export class SeamHttpClientSessions { } /** - * Returns a specified [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Returns a specified [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ get( parameters?: ClientSessionsGetParameters, @@ -222,7 +222,7 @@ export class SeamHttpClientSessions { } /** - * Returns a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist. + * Returns a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist. */ getOrCreate( parameters?: ClientSessionsGetOrCreateParameters, @@ -242,7 +242,7 @@ export class SeamHttpClientSessions { } /** - * Grants a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews), [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on. + * Grants a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews), [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on. */ grantAccess( parameters: ClientSessionsGrantAccessParameters, @@ -269,7 +269,7 @@ export class SeamHttpClientSessions { } /** - * Returns a list of all [client sessions](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Returns a list of all [client sessions](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ list( parameters?: ClientSessionsListParameters, @@ -289,9 +289,9 @@ export class SeamHttpClientSessions { } /** - * Revokes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Revokes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). * - * Note that [deleting a client session](https://docs.seam.co/api/client_sessions/delete) is a separate action. + * Note that [deleting a client session](https://www.seam.co/docs/api/client_sessions/delete) is a separate action. */ revoke( parameters: ClientSessionsRevokeParameters, @@ -313,11 +313,11 @@ export class SeamHttpClientSessions { export type ClientSessionsCreateParameters = { /** - * IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) for which you want to create a client session. + * IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to create a client session. */ connect_webview_ids?: Array | undefined /** - * IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) for which you want to create a client session. + * IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) for which you want to create a client session. */ connected_account_ids?: Array | undefined /** @@ -337,11 +337,11 @@ export type ClientSessionsCreateParameters = { */ user_identifier_key?: string | undefined /** - * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. + * ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. */ user_identity_id?: string | undefined /** - * IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. + * IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. * @deprecated Use `user_identity_id` instead. */ user_identity_ids?: Array | undefined @@ -400,11 +400,11 @@ export interface ClientSessionsGetOptions {} export type ClientSessionsGetOrCreateParameters = { /** - * IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session). + * IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session). */ connect_webview_ids?: Array | undefined /** - * IDs of the [connected accounts](https://docs.seam.co/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session). + * IDs of the [connected accounts](https://www.seam.co/docs/api/connected_accounts/object) that you want to associate with the client session (or that are already associated with the existing client session). */ connected_account_ids?: Array | undefined /** @@ -416,11 +416,11 @@ export type ClientSessionsGetOrCreateParameters = { */ user_identifier_key?: string | undefined /** - * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). + * ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */ user_identity_id?: string | undefined /** - * IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. + * IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. * @deprecated Use `user_identity_id`. */ user_identity_ids?: Array | undefined @@ -447,11 +447,11 @@ export type ClientSessionsGrantAccessParameters = RequireAtLeastOne< */ client_session_id?: string | undefined /** - * IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) that you want to associate with the client session. + * IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session. */ connect_webview_ids?: Array | undefined /** - * IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that you want to associate with the client session. + * IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that you want to associate with the client session. */ connected_account_ids?: Array | undefined /** @@ -459,11 +459,11 @@ export type ClientSessionsGrantAccessParameters = RequireAtLeastOne< */ user_identifier_key?: string | undefined /** - * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. + * ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */ user_identity_id?: string | undefined /** - * IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. + * IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. * @deprecated Use `user_identity_id`. */ user_identity_ids?: Array | undefined @@ -491,7 +491,7 @@ export type ClientSessionsListParameters = { */ client_session_id?: string | undefined /** - * ID of the [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview. + * ID of the [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview. */ connect_webview_id?: string | null | undefined /** @@ -499,7 +499,7 @@ export type ClientSessionsListParameters = { */ user_identifier_key?: string | undefined /** - * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a user identity. + * ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a user identity. */ user_identity_id?: string | null | undefined /** diff --git a/src/lib/routes/connect-webviews/connect-webviews.ts b/src/lib/routes/connect-webviews/connect-webviews.ts index e6677dae..ec909332 100644 --- a/src/lib/routes/connect-webviews/connect-webviews.ts +++ b/src/lib/routes/connect-webviews/connect-webviews.ts @@ -162,13 +162,13 @@ export class SeamHttpConnectWebviews { } /** - * Creates a new [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Creates a new [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * To enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview. * * You should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users. * - * See also: [Connect Webview Process](https://docs.seam.co/core-concepts/connect-webviews/connect-webview-process). + * See also: [Connect Webview Process](https://www.seam.co/docs/core-concepts/connect-webviews/connect-webview-process). */ create( parameters?: ConnectWebviewsCreateParameters, @@ -188,7 +188,7 @@ export class SeamHttpConnectWebviews { } /** - * Deletes a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Deletes a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews. */ @@ -210,7 +210,7 @@ export class SeamHttpConnectWebviews { } /** - * Returns a specified [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Returns a specified [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * Unless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected. */ @@ -232,7 +232,7 @@ export class SeamHttpConnectWebviews { } /** - * Returns a list of all [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews). + * Returns a list of all [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews). */ list( parameters?: ConnectWebviewsListParameters, @@ -263,7 +263,7 @@ export type ConnectWebviewsCreateParameters = { > | undefined /** - * Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with no filters. + * Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with no filters. */ accepted_providers?: | Array< @@ -324,6 +324,7 @@ export type ConnectWebviewsCreateParameters = { | 'sifely' | 'thirty_three_lock' | 'ring' + | 'tapo' | 'ical' | 'lodgify' | 'hostaway' @@ -339,11 +340,11 @@ export type ConnectWebviewsCreateParameters = { > | undefined /** - * Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). + * Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */ automatically_manage_new_devices?: boolean | undefined /** - * Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. + * Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://www.seam.co/docs/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. */ custom_metadata?: Record | undefined /** @@ -363,7 +364,7 @@ export type ConnectWebviewsCreateParameters = { */ excluded_providers?: Array | undefined /** - * Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/api/devices/list_device_providers) with the desired `provider_category` filter. + * Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with the desired `provider_category` filter. */ provider_category?: | 'stable' @@ -377,7 +378,7 @@ export type ConnectWebviewsCreateParameters = { | 'internal_beta' | undefined /** - * Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). + * Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */ wait_for_device_creation?: boolean | undefined } @@ -431,7 +432,7 @@ export interface ConnectWebviewsGetOptions {} export type ConnectWebviewsListParameters = { /** - * Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. + * Custom metadata pairs by which you want to [filter Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. */ custom_metadata_has?: Record | undefined /** diff --git a/src/lib/routes/connected-accounts/connected-accounts.ts b/src/lib/routes/connected-accounts/connected-accounts.ts index 7276353b..e4d65fd3 100644 --- a/src/lib/routes/connected-accounts/connected-accounts.ts +++ b/src/lib/routes/connected-accounts/connected-accounts.ts @@ -172,7 +172,7 @@ export class SeamHttpConnectedAccounts { } /** - * Deletes a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts). + * Deletes a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). * * Deleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider. * @@ -196,7 +196,7 @@ export class SeamHttpConnectedAccounts { } /** - * Returns a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts). + * Returns a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). */ get( parameters: ConnectedAccountsGetParameters, @@ -216,7 +216,7 @@ export class SeamHttpConnectedAccounts { } /** - * Returns a list of all [connected accounts](https://docs.seam.co/core-concepts/connected-accounts). + * Returns a list of all [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts). */ list( parameters?: ConnectedAccountsListParameters, @@ -237,7 +237,7 @@ export class SeamHttpConnectedAccounts { } /** - * Request a [connected account](https://docs.seam.co/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`. + * Request a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`. */ sync( parameters: ConnectedAccountsSyncParameters, @@ -257,7 +257,7 @@ export class SeamHttpConnectedAccounts { } /** - * Updates a [connected account](https://docs.seam.co/core-concepts/connected-accounts). + * Updates a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). */ update( parameters: ConnectedAccountsUpdateParameters, @@ -392,7 +392,7 @@ export type ConnectedAccountsUpdateParameters = { > | undefined /** - * Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). */ automatically_manage_new_devices?: boolean | undefined /** @@ -401,7 +401,7 @@ export type ConnectedAccountsUpdateParameters = { connected_account_id: string /** - * Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. + * Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://www.seam.co/docs/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. */ custom_metadata?: Record | undefined /** diff --git a/src/lib/routes/connected-accounts/simulate/simulate.ts b/src/lib/routes/connected-accounts/simulate/simulate.ts index 2e2e2099..194369b4 100644 --- a/src/lib/routes/connected-accounts/simulate/simulate.ts +++ b/src/lib/routes/connected-accounts/simulate/simulate.ts @@ -164,7 +164,7 @@ export class SeamHttpConnectedAccountsSimulate { } /** - * Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ disconnect( parameters: ConnectedAccountsSimulateDisconnectParameters, diff --git a/src/lib/routes/devices/devices.ts b/src/lib/routes/devices/devices.ts index 181eb169..24b88a61 100644 --- a/src/lib/routes/devices/devices.ts +++ b/src/lib/routes/devices/devices.ts @@ -175,7 +175,7 @@ export class SeamHttpDevices { } /** - * Returns a specified [device](https://docs.seam.co/core-concepts/devices). + * Returns a specified [device](https://www.seam.co/docs/core-concepts/devices). * * You must specify either `device_id` or `name`. */ @@ -197,7 +197,7 @@ export class SeamHttpDevices { } /** - * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices). + * Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices). */ list( parameters?: DevicesListParameters, @@ -220,9 +220,9 @@ export class SeamHttpDevices { /** * Returns a list of all device providers. * - * The information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. + * The information that this endpoint returns for each provider includes a set of [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. * - * When you create a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). + * When you create a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */ listDeviceProviders( parameters?: DevicesListDeviceProvidersParameters, @@ -262,9 +262,9 @@ export class SeamHttpDevices { } /** - * Updates a specified [device](https://docs.seam.co/core-concepts/devices). + * Updates a specified [device](https://www.seam.co/docs/core-concepts/devices). * - * You can add or change [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * You can add or change [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). */ update( parameters: DevicesUpdateParameters, @@ -325,7 +325,7 @@ export type DevicesListParameters = { */ created_before?: string | Date | Temporal.Instant | undefined /** - * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. + * Set of key:value [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. */ custom_metadata_has?: Record | undefined /** @@ -383,6 +383,7 @@ export type DevicesListParameters = { | 'ios_phone' | 'android_phone' | 'ring_camera' + | 'tapo_camera' | undefined /** * Array of device types for which you want to list devices. @@ -432,6 +433,7 @@ export type DevicesListParameters = { | 'ios_phone' | 'android_phone' | 'ring_camera' + | 'tapo_camera' > | undefined /** @@ -486,6 +488,7 @@ export type DevicesListParameters = { | 'tado' | 'ultraloq' | 'ring' + | 'tapo' | 'ical' | 'lodgify' | 'hostaway' @@ -1909,11 +1912,11 @@ export interface DevicesReportProviderMetadataOptions {} export type DevicesUpdateParameters = { /** - * Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use. + * Indicates whether the device's [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use. */ backup_access_code_pool_enabled?: boolean | undefined /** - * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. + * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://www.seam.co/docs/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. */ custom_metadata?: Record | undefined /** diff --git a/src/lib/routes/devices/simulate/simulate.ts b/src/lib/routes/devices/simulate/simulate.ts index 5e0adb94..d71fbfbe 100644 --- a/src/lib/routes/devices/simulate/simulate.ts +++ b/src/lib/routes/devices/simulate/simulate.ts @@ -161,7 +161,7 @@ export class SeamHttpDevicesSimulate { } /** - * Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). + * Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). */ connect( parameters: DevicesSimulateConnectParameters, @@ -204,7 +204,7 @@ export class SeamHttpDevicesSimulate { } /** - * Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). + * Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). */ disconnect( parameters: DevicesSimulateDisconnectParameters, @@ -270,7 +270,7 @@ export class SeamHttpDevicesSimulate { } /** - * Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). + * Simulates removing a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). */ remove( parameters: DevicesSimulateRemoveParameters, diff --git a/src/lib/routes/devices/unmanaged/unmanaged.ts b/src/lib/routes/devices/unmanaged/unmanaged.ts index 0bb238cf..50630ed7 100644 --- a/src/lib/routes/devices/unmanaged/unmanaged.ts +++ b/src/lib/routes/devices/unmanaged/unmanaged.ts @@ -163,9 +163,9 @@ export class SeamHttpDevicesUnmanaged { } /** - * Returns a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * Returns a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). * - * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). * * You must specify either `device_id` or `name`. */ @@ -187,9 +187,9 @@ export class SeamHttpDevicesUnmanaged { } /** - * Returns a list of all [unmanaged devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * Returns a list of all [unmanaged devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). * - * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). */ list( parameters?: DevicesUnmanagedListParameters, @@ -210,9 +210,9 @@ export class SeamHttpDevicesUnmanaged { } /** - * Updates a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`. + * Updates a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`. * - * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). */ update( parameters: DevicesUnmanagedUpdateParameters, @@ -330,6 +330,7 @@ export type DevicesUnmanagedListParameters = { | 'ios_phone' | 'android_phone' | 'ring_camera' + | 'tapo_camera' | undefined /** * Array of device types for which you want to list devices. @@ -379,6 +380,7 @@ export type DevicesUnmanagedListParameters = { | 'ios_phone' | 'android_phone' | 'ring_camera' + | 'tapo_camera' > | undefined /** @@ -433,6 +435,7 @@ export type DevicesUnmanagedListParameters = { | 'tado' | 'ultraloq' | 'ring' + | 'tapo' | 'ical' | 'lodgify' | 'hostaway' diff --git a/src/lib/routes/events/events.ts b/src/lib/routes/events/events.ts index 18c2a908..da4d2c40 100644 --- a/src/lib/routes/events/events.ts +++ b/src/lib/routes/events/events.ts @@ -163,7 +163,7 @@ export class SeamHttpEvents { } /** - * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to retrieve an event that already took place. + * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. */ get( parameters: EventsGetParameters, @@ -183,7 +183,7 @@ export class SeamHttpEvents { } /** - * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to filter or see events that already took place. + * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. */ list( parameters: EventsListParameters, @@ -359,7 +359,7 @@ export type EventsListParameters = RequireAtLeastOne< | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.failed_to_update' - | 'access_code.failed_to_expire' + | 'access_code.failed_to_remove' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' @@ -479,7 +479,7 @@ export type EventsListParameters = RequireAtLeastOne< | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.failed_to_update' - | 'access_code.failed_to_expire' + | 'access_code.failed_to_remove' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' diff --git a/src/lib/routes/instant-keys/instant-keys.ts b/src/lib/routes/instant-keys/instant-keys.ts index 3a700e9d..d32d29f8 100644 --- a/src/lib/routes/instant-keys/instant-keys.ts +++ b/src/lib/routes/instant-keys/instant-keys.ts @@ -163,7 +163,7 @@ export class SeamHttpInstantKeys { } /** - * Deletes a specified [Instant Key](https://docs.seam.co/capability-guides/instant-keys). + * Deletes a specified [Instant Key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys). */ delete( parameters: InstantKeysDeleteParameters, @@ -183,7 +183,7 @@ export class SeamHttpInstantKeys { } /** - * Gets an [instant key](https://docs.seam.co/capability-guides/instant-keys). + * Gets an [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys). */ get( parameters: InstantKeysGetParameters, @@ -203,7 +203,7 @@ export class SeamHttpInstantKeys { } /** - * Returns a list of all [instant keys](https://docs.seam.co/capability-guides/instant-keys). + * Returns a list of all [instant keys](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys). */ list( parameters?: InstantKeysListParameters, diff --git a/src/lib/routes/locks/locks.ts b/src/lib/routes/locks/locks.ts index b67fce4e..c330bef0 100644 --- a/src/lib/routes/locks/locks.ts +++ b/src/lib/routes/locks/locks.ts @@ -171,7 +171,7 @@ export class SeamHttpLocks { } /** - * Configures the auto-lock setting for a specified [lock](https://docs.seam.co/low-level-apis/smart-locks). + * Configures the auto-lock setting for a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks). */ configureAutoLock( parameters: LocksConfigureAutoLockParameters, @@ -196,7 +196,7 @@ export class SeamHttpLocks { } /** - * Returns a specified [lock](https://docs.seam.co/low-level-apis/smart-locks). + * Returns a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks). * @deprecated Use `/devices/get` instead. */ get( @@ -217,7 +217,7 @@ export class SeamHttpLocks { } /** - * Returns a list of all [locks](https://docs.seam.co/low-level-apis/smart-locks). + * Returns a list of all [locks](https://www.seam.co/docs/low-level-apis/smart-locks). */ list( parameters?: LocksListParameters, @@ -237,7 +237,7 @@ export class SeamHttpLocks { } /** - * Locks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock). + * Locks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock). */ lockDoor( parameters: LocksLockDoorParameters, @@ -262,7 +262,7 @@ export class SeamHttpLocks { } /** - * Unlocks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock). + * Unlocks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock). */ unlockDoor( parameters: LocksUnlockDoorParameters, diff --git a/src/lib/routes/locks/simulate/simulate.ts b/src/lib/routes/locks/simulate/simulate.ts index 98bc16e6..94c9e506 100644 --- a/src/lib/routes/locks/simulate/simulate.ts +++ b/src/lib/routes/locks/simulate/simulate.ts @@ -163,7 +163,7 @@ export class SeamHttpLocksSimulate { } /** - * Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates the entry of a code on a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ keypadCodeEntry( parameters: LocksSimulateKeypadCodeEntryParameters, @@ -188,7 +188,7 @@ export class SeamHttpLocksSimulate { } /** - * Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates a manual lock action using a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ manualLockViaKeypad( parameters: LocksSimulateManualLockViaKeypadParameters, diff --git a/src/lib/routes/noise-sensors/noise-sensors.ts b/src/lib/routes/noise-sensors/noise-sensors.ts index a6ba774c..adc28fa6 100644 --- a/src/lib/routes/noise-sensors/noise-sensors.ts +++ b/src/lib/routes/noise-sensors/noise-sensors.ts @@ -176,7 +176,7 @@ export class SeamHttpNoiseSensors { } /** - * Returns a list of all [noise sensors](https://docs.seam.co/capability-guides/noise-sensors). + * Returns a list of all [noise sensors](https://www.seam.co/docs/capability-guides/noise-sensors). */ list( parameters?: NoiseSensorsListParameters, diff --git a/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts b/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts index 889f4e2b..988df355 100644 --- a/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +++ b/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts @@ -165,7 +165,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds { } /** - * Creates a new [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. + * Creates a new [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. */ create( parameters: NoiseSensorsNoiseThresholdsCreateParameters, @@ -185,7 +185,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds { } /** - * Deletes a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Deletes a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). */ delete( parameters: NoiseSensorsNoiseThresholdsDeleteParameters, @@ -205,7 +205,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds { } /** - * Returns a specified [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Returns a specified [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). */ get( parameters: NoiseSensorsNoiseThresholdsGetParameters, @@ -225,7 +225,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds { } /** - * Returns a list of all [noise thresholds](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Returns a list of all [noise thresholds](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). */ list( parameters: NoiseSensorsNoiseThresholdsListParameters, @@ -245,7 +245,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds { } /** - * Updates a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Updates a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). */ update( parameters: NoiseSensorsNoiseThresholdsUpdateParameters, @@ -285,7 +285,7 @@ export type NoiseSensorsNoiseThresholdsCreateParameters = { */ noise_threshold_decibels?: number | undefined /** - * Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors). + * Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors). */ noise_threshold_nrs?: number | undefined /** @@ -398,7 +398,7 @@ export type NoiseSensorsNoiseThresholdsUpdateParameters = { noise_threshold_id: string /** - * Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors). + * Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors). */ noise_threshold_nrs?: number | undefined /** diff --git a/src/lib/routes/noise-sensors/simulate/simulate.ts b/src/lib/routes/noise-sensors/simulate/simulate.ts index e0e125bf..9a692580 100644 --- a/src/lib/routes/noise-sensors/simulate/simulate.ts +++ b/src/lib/routes/noise-sensors/simulate/simulate.ts @@ -161,7 +161,7 @@ export class SeamHttpNoiseSensorsSimulate { } /** - * Simulates the triggering of a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates the triggering of a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ triggerNoiseThreshold( parameters: NoiseSensorsSimulateTriggerNoiseThresholdParameters, diff --git a/src/lib/routes/phones/phones.ts b/src/lib/routes/phones/phones.ts index ea527821..9be5a3a1 100644 --- a/src/lib/routes/phones/phones.ts +++ b/src/lib/routes/phones/phones.ts @@ -168,7 +168,7 @@ export class SeamHttpPhones { } /** - * Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process). + * Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process). */ deactivate( parameters: PhonesDeactivateParameters, @@ -188,7 +188,7 @@ export class SeamHttpPhones { } /** - * Returns a specified [phone](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity). + * Returns a specified [phone](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity). */ get( parameters: PhonesGetParameters, @@ -208,7 +208,7 @@ export class SeamHttpPhones { } /** - * Returns a list of all [phones](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. + * Returns a list of all [phones](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. */ list( parameters?: PhonesListParameters, @@ -262,7 +262,7 @@ export interface PhonesGetOptions {} export type PhonesListParameters = { /** - * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones. + * ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones. */ acs_credential_id?: string | undefined /** diff --git a/src/lib/routes/phones/simulate/simulate.ts b/src/lib/routes/phones/simulate/simulate.ts index 1639dfa6..ac6a474d 100644 --- a/src/lib/routes/phones/simulate/simulate.ts +++ b/src/lib/routes/phones/simulate/simulate.ts @@ -162,7 +162,7 @@ export class SeamHttpPhonesSimulate { } /** - * Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity). + * Creates a new simulated phone in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://www.seam.co/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity). */ createSandboxPhone( parameters: PhonesSimulateCreateSandboxPhoneParameters, diff --git a/src/lib/routes/seam-http-endpoints-without-workspace.ts b/src/lib/routes/seam-http-endpoints-without-workspace.ts index d27ffa1e..62538081 100644 --- a/src/lib/routes/seam-http-endpoints-without-workspace.ts +++ b/src/lib/routes/seam-http-endpoints-without-workspace.ts @@ -92,7 +92,7 @@ export class SeamHttpEndpointsWithoutWorkspace { } /** - * Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces). + * Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces). */ get '/workspaces/create'(): ( parameters: WorkspacesCreateParameters, @@ -108,7 +108,7 @@ export class SeamHttpEndpointsWithoutWorkspace { } /** - * Returns a list of [workspaces](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. */ get '/workspaces/list'(): ( parameters?: WorkspacesListParameters, diff --git a/src/lib/routes/seam-http-endpoints.ts b/src/lib/routes/seam-http-endpoints.ts index 4c814326..4357b16c 100644 --- a/src/lib/routes/seam-http-endpoints.ts +++ b/src/lib/routes/seam-http-endpoints.ts @@ -887,7 +887,7 @@ export class SeamHttpEndpoints { } /** - * 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. + * 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. */ get '/access_codes/create'(): ( parameters: AccessCodesCreateParameters, @@ -903,7 +903,7 @@ export class SeamHttpEndpoints { } /** - * Creates new [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. + * Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. * * 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. * @@ -911,9 +911,9 @@ export class SeamHttpEndpoints { * * 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`. * - * 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). + * 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). * - * 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. + * 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. */ get '/access_codes/create_multiple'(): ( parameters: AccessCodesCreateMultipleParameters, @@ -929,7 +929,7 @@ export class SeamHttpEndpoints { } /** - * Deletes an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). */ get '/access_codes/delete'(): ( parameters: AccessCodesDeleteParameters, @@ -945,7 +945,7 @@ export class SeamHttpEndpoints { } /** - * Generates a code for an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes), given a device ID. + * Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID. */ get '/access_codes/generate_code'(): ( parameters: AccessCodesGenerateCodeParameters, @@ -961,7 +961,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * You must specify either `access_code_id` or both `device_id` and `code`. */ @@ -979,7 +979,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * * Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`. */ @@ -997,7 +997,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). * * 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. * @@ -1039,9 +1039,9 @@ export class SeamHttpEndpoints { } /** - * Updates a specified active or upcoming [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes). + * Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). * - * See also [Modifying Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/modifying-access-codes). + * See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes). */ get '/access_codes/update'(): ( parameters: AccessCodesUpdateParameters, @@ -1057,11 +1057,11 @@ export class SeamHttpEndpoints { } /** - * Updates [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. + * Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices. * * Specify the `common_code_key` to identify the set of access codes that you want to update. * - * 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). + * 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). */ get '/access_codes/update_multiple'(): ( parameters: AccessCodesUpdateMultipleParameters, @@ -1077,7 +1077,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/access_codes/simulate/create_unmanaged_access_code'(): ( parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters, @@ -1095,7 +1095,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). * * 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. * @@ -1115,7 +1115,7 @@ export class SeamHttpEndpoints { } /** - * Deletes an [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). */ get '/access_codes/unmanaged/delete'(): ( parameters: AccessCodesUnmanagedDeleteParameters, @@ -1131,7 +1131,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). * * You must specify either `access_code_id` or both `device_id` and `code`. */ @@ -1149,7 +1149,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [unmanaged access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). */ get '/access_codes/unmanaged/list'(): ( parameters: AccessCodesUnmanagedListParameters, @@ -1165,7 +1165,7 @@ export class SeamHttpEndpoints { } /** - * Updates a specified [unmanaged access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). + * Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes). */ get '/access_codes/unmanaged/update'(): ( parameters: AccessCodesUnmanagedUpdateParameters, @@ -1181,7 +1181,7 @@ export class SeamHttpEndpoints { } /** - * 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. + * 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. */ get '/access_grants/create'(): ( parameters: AccessGrantsCreateParameters, @@ -1377,7 +1377,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/access_methods/encode'(): ( parameters: AccessMethodsEncodeParameters, @@ -1441,7 +1441,7 @@ export class SeamHttpEndpoints { } /** - * 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. + * 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. */ get '/access_methods/unlock_door'(): ( parameters: AccessMethodsUnlockDoorParameters, @@ -1489,7 +1489,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/access_groups/add_user'(): ( parameters: AcsAccessGroupsAddUserParameters, @@ -1505,7 +1505,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). */ get '/acs/access_groups/delete'(): ( parameters: AcsAccessGroupsDeleteParameters, @@ -1521,7 +1521,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). */ get '/acs/access_groups/get'(): ( parameters: AcsAccessGroupsGetParameters, @@ -1537,7 +1537,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [access groups](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). + * Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups). */ get '/acs/access_groups/list'(): ( parameters?: AcsAccessGroupsListParameters, @@ -1553,7 +1553,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/access_groups/list_accessible_entrances'(): ( parameters: AcsAccessGroupsListAccessibleEntrancesParameters, @@ -1569,7 +1569,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/access_groups/list_users'(): ( parameters: AcsAccessGroupsListUsersParameters, @@ -1585,7 +1585,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/access_groups/remove_user'(): ( parameters: AcsAccessGroupsRemoveUserParameters, @@ -1601,7 +1601,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/credentials/assign'(): ( parameters: AcsCredentialsAssignParameters, @@ -1617,7 +1617,7 @@ export class SeamHttpEndpoints { } /** - * 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. + * 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. */ get '/acs/credentials/create'(): ( parameters: AcsCredentialsCreateParameters, @@ -1633,7 +1633,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ get '/acs/credentials/delete'(): ( parameters: AcsCredentialsDeleteParameters, @@ -1649,7 +1649,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ get '/acs/credentials/get'(): ( parameters: AcsCredentialsGetParameters, @@ -1665,7 +1665,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ get '/acs/credentials/list'(): ( parameters?: AcsCredentialsListParameters, @@ -1681,7 +1681,7 @@ export class SeamHttpEndpoints { } /** - * 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. + * 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. */ get '/acs/credentials/list_accessible_entrances'(): ( parameters: AcsCredentialsListAccessibleEntrancesParameters, @@ -1697,7 +1697,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/credentials/unassign'(): ( parameters: AcsCredentialsUnassignParameters, @@ -1713,7 +1713,7 @@ export class SeamHttpEndpoints { } /** - * Updates the code and ends at date and time for a specified [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * 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). */ get '/acs/credentials/update'(): ( parameters: AcsCredentialsUpdateParameters, @@ -1729,7 +1729,7 @@ export class SeamHttpEndpoints { } /** - * 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` + * 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` */ get '/acs/encoders/encode_credential'(): ( parameters: AcsEncodersEncodeCredentialParameters, @@ -1745,7 +1745,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ get '/acs/encoders/get'(): ( parameters: AcsEncodersGetParameters, @@ -1761,7 +1761,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). + * Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ get '/acs/encoders/list'(): ( parameters?: AcsEncodersListParameters, @@ -1777,7 +1777,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/encoders/scan_credential'(): ( parameters: AcsEncodersScanCredentialParameters, @@ -1793,7 +1793,7 @@ export class SeamHttpEndpoints { } /** - * 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`. + * 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`. */ get '/acs/encoders/scan_to_assign_credential'(): ( parameters: AcsEncodersScanToAssignCredentialParameters, @@ -1809,7 +1809,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/encoders/simulate/next_credential_encode_will_fail'(): ( parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters, @@ -1827,7 +1827,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/encoders/simulate/next_credential_encode_will_succeed'(): ( parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters, @@ -1847,7 +1847,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/encoders/simulate/next_credential_scan_will_fail'(): ( parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters, @@ -1865,7 +1865,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/encoders/simulate/next_credential_scan_will_succeed'(): ( parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters, @@ -1885,7 +1885,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ get '/acs/entrances/get'(): ( parameters: AcsEntrancesGetParameters, @@ -1901,7 +1901,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/entrances/grant_access'(): ( parameters: AcsEntrancesGrantAccessParameters, @@ -1917,7 +1917,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [access system entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). + * Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details). */ get '/acs/entrances/list'(): ( parameters?: AcsEntrancesListParameters, @@ -1933,7 +1933,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/entrances/list_credentials_with_access'(): ( parameters: AcsEntrancesListCredentialsWithAccessParameters, @@ -1949,7 +1949,7 @@ export class SeamHttpEndpoints { } /** - * 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. + * 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. */ get '/acs/entrances/unlock'(): ( parameters: AcsEntrancesUnlockParameters, @@ -1965,7 +1965,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [access system](https://docs.seam.co/low-level-apis/access-systems). + * Returns a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems). */ get '/acs/systems/get'(): ( parameters: AcsSystemsGetParameters, @@ -1981,7 +1981,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems). + * Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems). * * To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace. */ @@ -1999,7 +1999,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/low-level-apis/access-systems). + * Returns a list of all credential manager systems that are compatible with a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems). * * Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body. */ @@ -2037,7 +2037,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/users/add_to_access_group'(): ( parameters: AcsUsersAddToAccessGroupParameters, @@ -2053,7 +2053,7 @@ export class SeamHttpEndpoints { } /** - * Creates a new [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Creates a new [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ get '/acs/users/create'(): ( parameters: AcsUsersCreateParameters, @@ -2069,7 +2069,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). + * Deletes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */ get '/acs/users/delete'(): ( parameters: AcsUsersDeleteParameters, @@ -2085,7 +2085,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Returns a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ get '/acs/users/get'(): ( parameters: AcsUsersGetParameters, @@ -2101,7 +2101,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ get '/acs/users/list'(): ( parameters?: AcsUsersListParameters, @@ -2117,7 +2117,7 @@ export class SeamHttpEndpoints { } /** - * Lists the [entrances](https://docs.seam.co/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) has access. + * Lists the [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) has access. */ get '/acs/users/list_accessible_entrances'(): ( parameters: AcsUsersListAccessibleEntrancesParameters, @@ -2133,7 +2133,7 @@ export class SeamHttpEndpoints { } /** - * 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). + * 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). */ get '/acs/users/remove_from_access_group'(): ( parameters: AcsUsersRemoveFromAccessGroupParameters, @@ -2149,7 +2149,7 @@ export class SeamHttpEndpoints { } /** - * Revokes access to all [entrances](https://docs.seam.co/api/acs/entrances) for a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Revokes access to all [entrances](https://www.seam.co/docs/api/acs/entrances/object) for a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ get '/acs/users/revoke_access_to_all_entrances'(): ( parameters: AcsUsersRevokeAccessToAllEntrancesParameters, @@ -2165,7 +2165,7 @@ export class SeamHttpEndpoints { } /** - * [Suspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/api/acs/users/unsuspend) them. + * [Suspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://www.seam.co/docs/api/acs/users/unsuspend) them. */ get '/acs/users/suspend'(): ( parameters: AcsUsersSuspendParameters, @@ -2181,7 +2181,7 @@ export class SeamHttpEndpoints { } /** - * [Unsuspends](https://docs.seam.co/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access. + * [Unsuspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). While [suspending an access system user](https://www.seam.co/docs/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access. */ get '/acs/users/unsuspend'(): ( parameters: AcsUsersUnsuspendParameters, @@ -2197,7 +2197,7 @@ export class SeamHttpEndpoints { } /** - * Updates the properties of a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). + * Updates the properties of a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). */ get '/acs/users/update'(): ( parameters: AcsUsersUpdateParameters, @@ -2213,7 +2213,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [action attempt](https://docs.seam.co/core-concepts/action-attempts). + * Returns a specified [action attempt](https://www.seam.co/docs/core-concepts/action-attempts). */ get '/action_attempts/get'(): ( parameters: ActionAttemptsGetParameters, @@ -2229,7 +2229,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of the [action attempts](https://docs.seam.co/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s. + * Returns a list of the [action attempts](https://www.seam.co/docs/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s. */ get '/action_attempts/list'(): ( parameters?: ActionAttemptsListParameters, @@ -2245,7 +2245,7 @@ export class SeamHttpEndpoints { } /** - * Creates a new [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Creates a new [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ get '/client_sessions/create'(): ( parameters?: ClientSessionsCreateParameters, @@ -2261,7 +2261,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Deletes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ get '/client_sessions/delete'(): ( parameters: ClientSessionsDeleteParameters, @@ -2277,7 +2277,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Returns a specified [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ get '/client_sessions/get'(): ( parameters?: ClientSessionsGetParameters, @@ -2293,7 +2293,7 @@ export class SeamHttpEndpoints { } /** - * Returns a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist. + * Returns a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist. */ get '/client_sessions/get_or_create'(): ( parameters?: ClientSessionsGetOrCreateParameters, @@ -2309,7 +2309,7 @@ export class SeamHttpEndpoints { } /** - * Grants a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews), [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on. + * Grants a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews), [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on. */ get '/client_sessions/grant_access'(): ( parameters: ClientSessionsGrantAccessParameters, @@ -2325,7 +2325,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [client sessions](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Returns a list of all [client sessions](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). */ get '/client_sessions/list'(): ( parameters?: ClientSessionsListParameters, @@ -2341,9 +2341,9 @@ export class SeamHttpEndpoints { } /** - * Revokes a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). + * Revokes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). * - * Note that [deleting a client session](https://docs.seam.co/api/client_sessions/delete) is a separate action. + * Note that [deleting a client session](https://www.seam.co/docs/api/client_sessions/delete) is a separate action. */ get '/client_sessions/revoke'(): ( parameters: ClientSessionsRevokeParameters, @@ -2359,13 +2359,13 @@ export class SeamHttpEndpoints { } /** - * Creates a new [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Creates a new [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * To enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview. * * You should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users. * - * See also: [Connect Webview Process](https://docs.seam.co/core-concepts/connect-webviews/connect-webview-process). + * See also: [Connect Webview Process](https://www.seam.co/docs/core-concepts/connect-webviews/connect-webview-process). */ get '/connect_webviews/create'(): ( parameters?: ConnectWebviewsCreateParameters, @@ -2381,7 +2381,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Deletes a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews. */ @@ -2399,7 +2399,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews). + * Returns a specified [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews). * * Unless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected. */ @@ -2417,7 +2417,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews). + * Returns a list of all [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews). */ get '/connect_webviews/list'(): ( parameters?: ConnectWebviewsListParameters, @@ -2433,7 +2433,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts). + * Deletes a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). * * Deleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider. * @@ -2453,7 +2453,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [connected account](https://docs.seam.co/core-concepts/connected-accounts). + * Returns a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). */ get '/connected_accounts/get'(): ( parameters: ConnectedAccountsGetParameters, @@ -2469,7 +2469,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [connected accounts](https://docs.seam.co/core-concepts/connected-accounts). + * Returns a list of all [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts). */ get '/connected_accounts/list'(): ( parameters?: ConnectedAccountsListParameters, @@ -2485,7 +2485,7 @@ export class SeamHttpEndpoints { } /** - * Request a [connected account](https://docs.seam.co/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`. + * Request a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`. */ get '/connected_accounts/sync'(): ( parameters: ConnectedAccountsSyncParameters, @@ -2501,7 +2501,7 @@ export class SeamHttpEndpoints { } /** - * Updates a [connected account](https://docs.seam.co/core-concepts/connected-accounts). + * Updates a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). */ get '/connected_accounts/update'(): ( parameters: ConnectedAccountsUpdateParameters, @@ -2517,7 +2517,7 @@ export class SeamHttpEndpoints { } /** - * Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ get '/connected_accounts/simulate/disconnect'(): ( parameters: ConnectedAccountsSimulateDisconnectParameters, @@ -2585,7 +2585,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [device](https://docs.seam.co/core-concepts/devices). + * Returns a specified [device](https://www.seam.co/docs/core-concepts/devices). * * You must specify either `device_id` or `name`. */ @@ -2603,7 +2603,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices). + * Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices). */ get '/devices/list'(): ( parameters?: DevicesListParameters, @@ -2621,9 +2621,9 @@ export class SeamHttpEndpoints { /** * Returns a list of all device providers. * - * The information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. + * The information that this endpoint returns for each provider includes a set of [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`. * - * When you create a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). + * When you create a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). */ get '/devices/list_device_providers'(): ( parameters?: DevicesListDeviceProvidersParameters, @@ -2655,9 +2655,9 @@ export class SeamHttpEndpoints { } /** - * Updates a specified [device](https://docs.seam.co/core-concepts/devices). + * Updates a specified [device](https://www.seam.co/docs/core-concepts/devices). * - * You can add or change [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * You can add or change [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). */ get '/devices/update'(): ( parameters: DevicesUpdateParameters, @@ -2673,7 +2673,7 @@ export class SeamHttpEndpoints { } /** - * Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). + * Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). */ get '/devices/simulate/connect'(): ( parameters: DevicesSimulateConnectParameters, @@ -2708,7 +2708,7 @@ export class SeamHttpEndpoints { } /** - * Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). + * Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). */ get '/devices/simulate/disconnect'(): ( parameters: DevicesSimulateDisconnectParameters, @@ -2762,7 +2762,7 @@ export class SeamHttpEndpoints { } /** - * Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). + * Simulates removing a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal). */ get '/devices/simulate/remove'(): ( parameters: DevicesSimulateRemoveParameters, @@ -2778,9 +2778,9 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * Returns a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). * - * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). * * You must specify either `device_id` or `name`. */ @@ -2798,9 +2798,9 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [unmanaged devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). + * Returns a list of all [unmanaged devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). * - * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). */ get '/devices/unmanaged/list'(): ( parameters?: DevicesUnmanagedListParameters, @@ -2816,9 +2816,9 @@ export class SeamHttpEndpoints { } /** - * Updates a specified [unmanaged device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`. + * Updates a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`. * - * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). + * An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). */ get '/devices/unmanaged/update'(): ( parameters: DevicesUnmanagedUpdateParameters, @@ -2834,7 +2834,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to retrieve an event that already took place. + * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place. */ get '/events/get'(): ( parameters: EventsGetParameters, @@ -2850,7 +2850,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to filter or see events that already took place. + * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place. */ get '/events/list'(): ( parameters: EventsListParameters, @@ -2866,7 +2866,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a specified [Instant Key](https://docs.seam.co/capability-guides/instant-keys). + * Deletes a specified [Instant Key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys). */ get '/instant_keys/delete'(): ( parameters: InstantKeysDeleteParameters, @@ -2882,7 +2882,7 @@ export class SeamHttpEndpoints { } /** - * Gets an [instant key](https://docs.seam.co/capability-guides/instant-keys). + * Gets an [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys). */ get '/instant_keys/get'(): ( parameters: InstantKeysGetParameters, @@ -2898,7 +2898,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [instant keys](https://docs.seam.co/capability-guides/instant-keys). + * Returns a list of all [instant keys](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys). */ get '/instant_keys/list'(): ( parameters?: InstantKeysListParameters, @@ -2914,7 +2914,7 @@ export class SeamHttpEndpoints { } /** - * Configures the auto-lock setting for a specified [lock](https://docs.seam.co/low-level-apis/smart-locks). + * Configures the auto-lock setting for a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks). */ get '/locks/configure_auto_lock'(): ( parameters: LocksConfigureAutoLockParameters, @@ -2930,7 +2930,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [lock](https://docs.seam.co/low-level-apis/smart-locks). + * Returns a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks). * @deprecated Use `/devices/get` instead. */ get '/locks/get'(): ( @@ -2947,7 +2947,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [locks](https://docs.seam.co/low-level-apis/smart-locks). + * Returns a list of all [locks](https://www.seam.co/docs/low-level-apis/smart-locks). */ get '/locks/list'(): ( parameters?: LocksListParameters, @@ -2963,7 +2963,7 @@ export class SeamHttpEndpoints { } /** - * Locks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock). + * Locks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock). */ get '/locks/lock_door'(): ( parameters: LocksLockDoorParameters, @@ -2979,7 +2979,7 @@ export class SeamHttpEndpoints { } /** - * Unlocks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock). + * Unlocks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock). */ get '/locks/unlock_door'(): ( parameters: LocksUnlockDoorParameters, @@ -2995,7 +2995,7 @@ export class SeamHttpEndpoints { } /** - * Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates the entry of a code on a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ get '/locks/simulate/keypad_code_entry'(): ( parameters: LocksSimulateKeypadCodeEntryParameters, @@ -3011,7 +3011,7 @@ export class SeamHttpEndpoints { } /** - * Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates a manual lock action using a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ get '/locks/simulate/manual_lock_via_keypad'(): ( parameters: LocksSimulateManualLockViaKeypadParameters, @@ -3027,7 +3027,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [noise sensors](https://docs.seam.co/capability-guides/noise-sensors). + * Returns a list of all [noise sensors](https://www.seam.co/docs/capability-guides/noise-sensors). */ get '/noise_sensors/list'(): ( parameters?: NoiseSensorsListParameters, @@ -3043,7 +3043,7 @@ export class SeamHttpEndpoints { } /** - * Creates a new [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. + * Creates a new [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. */ get '/noise_sensors/noise_thresholds/create'(): ( parameters: NoiseSensorsNoiseThresholdsCreateParameters, @@ -3062,7 +3062,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Deletes a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). */ get '/noise_sensors/noise_thresholds/delete'(): ( parameters: NoiseSensorsNoiseThresholdsDeleteParameters, @@ -3081,7 +3081,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Returns a specified [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). */ get '/noise_sensors/noise_thresholds/get'(): ( parameters: NoiseSensorsNoiseThresholdsGetParameters, @@ -3100,7 +3100,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [noise thresholds](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Returns a list of all [noise thresholds](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). */ get '/noise_sensors/noise_thresholds/list'(): ( parameters: NoiseSensorsNoiseThresholdsListParameters, @@ -3119,7 +3119,7 @@ export class SeamHttpEndpoints { } /** - * Updates a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). + * Updates a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). */ get '/noise_sensors/noise_thresholds/update'(): ( parameters: NoiseSensorsNoiseThresholdsUpdateParameters, @@ -3138,7 +3138,7 @@ export class SeamHttpEndpoints { } /** - * Simulates the triggering of a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Simulates the triggering of a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ get '/noise_sensors/simulate/trigger_noise_threshold'(): ( parameters: NoiseSensorsSimulateTriggerNoiseThresholdParameters, @@ -3154,7 +3154,7 @@ export class SeamHttpEndpoints { } /** - * Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process). + * Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process). */ get '/phones/deactivate'(): ( parameters: PhonesDeactivateParameters, @@ -3170,7 +3170,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [phone](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity). + * Returns a specified [phone](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity). */ get '/phones/get'(): ( parameters: PhonesGetParameters, @@ -3186,7 +3186,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [phones](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. + * Returns a list of all [phones](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. */ get '/phones/list'(): ( parameters?: PhonesListParameters, @@ -3202,7 +3202,7 @@ export class SeamHttpEndpoints { } /** - * Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity). + * Creates a new simulated phone in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://www.seam.co/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity). */ get '/phones/simulate/create_sandbox_phone'(): ( parameters: PhonesSimulateCreateSandboxPhoneParameters, @@ -3218,7 +3218,7 @@ export class SeamHttpEndpoints { } /** - * Adds [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) to a specific space. + * Adds [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) to a specific space. */ get '/spaces/add_acs_entrances'(): ( parameters: SpacesAddAcsEntrancesParameters, @@ -3234,7 +3234,7 @@ export class SeamHttpEndpoints { } /** - * Adds a [connected account](https://docs.seam.co/core-concepts/connected-accounts) to a specific space. + * Adds a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to a specific space. */ get '/spaces/add_connected_account'(): ( parameters: SpacesAddConnectedAccountParameters, @@ -3346,7 +3346,7 @@ export class SeamHttpEndpoints { } /** - * Removes [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) from a specific space. + * Removes [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) from a specific space. */ get '/spaces/remove_acs_entrances'(): ( parameters: SpacesRemoveAcsEntrancesParameters, @@ -3362,7 +3362,7 @@ export class SeamHttpEndpoints { } /** - * Removes a [connected account](https://docs.seam.co/core-concepts/connected-accounts) from a specific space. + * Removes a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) from a specific space. */ get '/spaces/remove_connected_account'(): ( parameters: SpacesRemoveConnectedAccountParameters, @@ -3410,7 +3410,7 @@ export class SeamHttpEndpoints { } /** - * Activates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Activates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/activate_climate_preset'(): ( parameters: ThermostatsActivateClimatePresetParameters, @@ -3426,7 +3426,7 @@ export class SeamHttpEndpoints { } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [cool mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [cool mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). */ get '/thermostats/cool'(): ( parameters: ThermostatsCoolParameters, @@ -3442,7 +3442,7 @@ export class SeamHttpEndpoints { } /** - * Creates a [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Creates a [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/create_climate_preset'(): ( parameters: ThermostatsCreateClimatePresetParameters, @@ -3458,7 +3458,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Deletes a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/delete_climate_preset'(): ( parameters: ThermostatsDeleteClimatePresetParameters, @@ -3474,7 +3474,7 @@ export class SeamHttpEndpoints { } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). */ get '/thermostats/heat'(): ( parameters: ThermostatsHeatParameters, @@ -3490,7 +3490,7 @@ export class SeamHttpEndpoints { } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat-cool ("auto") mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). */ get '/thermostats/heat_cool'(): ( parameters: ThermostatsHeatCoolParameters, @@ -3506,7 +3506,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [thermostats](https://docs.seam.co/capability-guides/thermostats). + * Returns a list of all [thermostats](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/list'(): ( parameters?: ThermostatsListParameters, @@ -3522,7 +3522,7 @@ export class SeamHttpEndpoints { } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to ["off" mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). */ get '/thermostats/off'(): ( parameters: ThermostatsOffParameters, @@ -3538,7 +3538,7 @@ export class SeamHttpEndpoints { } /** - * Sets a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Sets a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/set_fallback_climate_preset'(): ( parameters: ThermostatsSetFallbackClimatePresetParameters, @@ -3554,7 +3554,7 @@ export class SeamHttpEndpoints { } /** - * Sets the [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Sets the [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/set_fan_mode'(): ( parameters: ThermostatsSetFanModeParameters, @@ -3570,7 +3570,7 @@ export class SeamHttpEndpoints { } /** - * Sets the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Sets the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/set_hvac_mode'(): ( parameters: ThermostatsSetHvacModeParameters, @@ -3586,7 +3586,7 @@ export class SeamHttpEndpoints { } /** - * Sets a [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. + * Sets a [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. */ get '/thermostats/set_temperature_threshold'(): ( parameters: ThermostatsSetTemperatureThresholdParameters, @@ -3602,7 +3602,7 @@ export class SeamHttpEndpoints { } /** - * Updates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Updates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/update_climate_preset'(): ( parameters: ThermostatsUpdateClimatePresetParameters, @@ -3682,7 +3682,7 @@ export class SeamHttpEndpoints { } /** - * Creates a new [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Creates a new [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/schedules/create'(): ( parameters: ThermostatsSchedulesCreateParameters, @@ -3698,7 +3698,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Deletes a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/schedules/delete'(): ( parameters: ThermostatsSchedulesDeleteParameters, @@ -3714,7 +3714,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Returns a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ get '/thermostats/schedules/get'(): ( parameters: ThermostatsSchedulesGetParameters, @@ -3730,7 +3730,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [thermostat schedules](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Returns a list of all [thermostat schedules](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ get '/thermostats/schedules/list'(): ( parameters: ThermostatsSchedulesListParameters, @@ -3746,7 +3746,7 @@ export class SeamHttpEndpoints { } /** - * Updates a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Updates a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ get '/thermostats/schedules/update'(): ( parameters: ThermostatsSchedulesUpdateParameters, @@ -3762,7 +3762,7 @@ export class SeamHttpEndpoints { } /** - * Simulates having adjusted the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). + * Simulates having adjusted the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://www.seam.co/docs/capability-guides/thermostats). Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). */ get '/thermostats/simulate/hvac_mode_adjusted'(): ( parameters: ThermostatsSimulateHvacModeAdjustedParameters, @@ -3778,7 +3778,7 @@ export class SeamHttpEndpoints { } /** - * Simulates a [thermostat](https://docs.seam.co/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). + * Simulates a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). */ get '/thermostats/simulate/temperature_reached'(): ( parameters: ThermostatsSimulateTemperatureReachedParameters, @@ -3794,7 +3794,7 @@ export class SeamHttpEndpoints { } /** - * Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * You must specify either `user_identity_id` or `user_identity_key` to identify the user identity. * @@ -3814,7 +3814,7 @@ export class SeamHttpEndpoints { } /** - * Creates a new [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Creates a new [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get '/user_identities/create'(): ( parameters?: UserIdentitiesCreateParameters, @@ -3830,7 +3830,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/api/acs/credentials), [acs users](https://docs.seam.co/api/acs/users) and [client sessions](https://docs.seam.co/api/client_sessions). + * Deletes a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://www.seam.co/docs/api/acs/credentials/object), [acs users](https://www.seam.co/docs/api/acs/users/object) and [client sessions](https://www.seam.co/docs/api/client_sessions/object). */ get '/user_identities/delete'(): ( parameters: UserIdentitiesDeleteParameters, @@ -3846,7 +3846,7 @@ export class SeamHttpEndpoints { } /** - * Generates a new [instant key](https://docs.seam.co/capability-guides/instant-keys) for a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Generates a new [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys) for a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get '/user_identities/generate_instant_key'(): ( parameters: UserIdentitiesGenerateInstantKeyParameters, @@ -3862,7 +3862,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get '/user_identities/get'(): ( parameters: UserIdentitiesGetParameters, @@ -3878,7 +3878,7 @@ export class SeamHttpEndpoints { } /** - * Grants a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/core-concepts/devices/). + * Grants a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://www.seam.co/docs/core-concepts/devices). */ get '/user_identities/grant_access_to_device'(): ( parameters: UserIdentitiesGrantAccessToDeviceParameters, @@ -3894,7 +3894,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a list of all [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get '/user_identities/list'(): ( parameters?: UserIdentitiesListParameters, @@ -3910,7 +3910,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity. + * Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity. */ get '/user_identities/list_accessible_devices'(): ( parameters: UserIdentitiesListAccessibleDevicesParameters, @@ -3926,7 +3926,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [ACS entrances](https://docs.seam.co/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity. + * Returns a list of all [ACS entrances](https://www.seam.co/docs/api/acs/entrances/object) accessible to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity. */ get '/user_identities/list_accessible_entrances'(): ( parameters: UserIdentitiesListAccessibleEntrancesParameters, @@ -3942,7 +3942,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get '/user_identities/list_acs_systems'(): ( parameters: UserIdentitiesListAcsSystemsParameters, @@ -3958,7 +3958,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get '/user_identities/list_acs_users'(): ( parameters: UserIdentitiesListAcsUsersParameters, @@ -3974,7 +3974,7 @@ export class SeamHttpEndpoints { } /** - * Merges one or more [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity. + * Merges one or more [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity. * * The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`. * @@ -3996,7 +3996,7 @@ export class SeamHttpEndpoints { } /** - * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get '/user_identities/remove_acs_user'(): ( parameters: UserIdentitiesRemoveAcsUserParameters, @@ -4012,7 +4012,7 @@ export class SeamHttpEndpoints { } /** - * Revokes access to a specified [device](https://docs.seam.co/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Revokes access to a specified [device](https://www.seam.co/docs/core-concepts/devices) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get '/user_identities/revoke_access_to_device'(): ( parameters: UserIdentitiesRevokeAccessToDeviceParameters, @@ -4028,7 +4028,7 @@ export class SeamHttpEndpoints { } /** - * Updates a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Updates a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get '/user_identities/update'(): ( parameters: UserIdentitiesUpdateParameters, @@ -4044,7 +4044,7 @@ export class SeamHttpEndpoints { } /** - * Returns a specified unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). + * Returns a specified unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). */ get '/user_identities/unmanaged/get'(): ( parameters: UserIdentitiesUnmanagedGetParameters, @@ -4060,7 +4060,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all unmanaged [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). + * Returns a list of all unmanaged [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). */ get '/user_identities/unmanaged/list'(): ( parameters?: UserIdentitiesUnmanagedListParameters, @@ -4076,7 +4076,7 @@ export class SeamHttpEndpoints { } /** - * Updates an unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed. + * Updates an unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed. * * This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged. */ @@ -4094,7 +4094,7 @@ export class SeamHttpEndpoints { } /** - * Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks). + * Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ get '/webhooks/create'(): ( parameters: WebhooksCreateParameters, @@ -4110,7 +4110,7 @@ export class SeamHttpEndpoints { } /** - * Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + * Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ get '/webhooks/delete'(): ( parameters: WebhooksDeleteParameters, @@ -4126,7 +4126,7 @@ export class SeamHttpEndpoints { } /** - * Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + * Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ get '/webhooks/get'(): ( parameters: WebhooksGetParameters, @@ -4142,7 +4142,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of all [webhooks](https://docs.seam.co/developer-tools/webhooks). + * Returns a list of all [webhooks](https://www.seam.co/docs/developer-tools/webhooks). */ get '/webhooks/list'(): ( parameters?: WebhooksListParameters, @@ -4158,7 +4158,7 @@ export class SeamHttpEndpoints { } /** - * Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + * Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ get '/webhooks/update'(): ( parameters: WebhooksUpdateParameters, @@ -4174,7 +4174,7 @@ export class SeamHttpEndpoints { } /** - * Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces). + * Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces). */ get '/workspaces/create'(): ( parameters: WorkspacesCreateParameters, @@ -4190,7 +4190,7 @@ export class SeamHttpEndpoints { } /** - * Returns the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Returns the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. */ get '/workspaces/get'(): ( parameters?: WorkspacesGetParameters, @@ -4206,7 +4206,7 @@ export class SeamHttpEndpoints { } /** - * Returns a list of [workspaces](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. */ get '/workspaces/list'(): ( parameters?: WorkspacesListParameters, @@ -4222,7 +4222,7 @@ export class SeamHttpEndpoints { } /** - * Resets the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces. + * Resets the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces. */ get '/workspaces/reset_sandbox'(): ( parameters?: WorkspacesResetSandboxParameters, @@ -4238,7 +4238,7 @@ export class SeamHttpEndpoints { } /** - * Updates the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Updates the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. */ get '/workspaces/update'(): ( parameters?: WorkspacesUpdateParameters, diff --git a/src/lib/routes/spaces/spaces.ts b/src/lib/routes/spaces/spaces.ts index ea27f416..d27bdfb7 100644 --- a/src/lib/routes/spaces/spaces.ts +++ b/src/lib/routes/spaces/spaces.ts @@ -164,7 +164,7 @@ export class SeamHttpSpaces { } /** - * Adds [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) to a specific space. + * Adds [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) to a specific space. */ addAcsEntrances( parameters: SpacesAddAcsEntrancesParameters, @@ -184,7 +184,7 @@ export class SeamHttpSpaces { } /** - * Adds a [connected account](https://docs.seam.co/core-concepts/connected-accounts) to a specific space. + * Adds a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to a specific space. */ addConnectedAccount( parameters: SpacesAddConnectedAccountParameters, @@ -330,7 +330,7 @@ export class SeamHttpSpaces { } /** - * Removes [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) from a specific space. + * Removes [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) from a specific space. */ removeAcsEntrances( parameters: SpacesRemoveAcsEntrancesParameters, @@ -350,7 +350,7 @@ export class SeamHttpSpaces { } /** - * Removes a [connected account](https://docs.seam.co/core-concepts/connected-accounts) from a specific space. + * Removes a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) from a specific space. */ removeConnectedAccount( parameters: SpacesRemoveConnectedAccountParameters, diff --git a/src/lib/routes/thermostats/daily-programs/daily-programs.ts b/src/lib/routes/thermostats/daily-programs/daily-programs.ts index bd12e731..fdc39cbd 100644 --- a/src/lib/routes/thermostats/daily-programs/daily-programs.ts +++ b/src/lib/routes/thermostats/daily-programs/daily-programs.ts @@ -252,7 +252,7 @@ export type ThermostatsDailyProgramsCreateParameters = { */ periods: Array<{ /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key?: string | undefined /** @@ -306,7 +306,7 @@ export type ThermostatsDailyProgramsUpdateParameters = { */ periods: Array<{ /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */ climate_preset_key?: string | undefined /** diff --git a/src/lib/routes/thermostats/schedules/schedules.ts b/src/lib/routes/thermostats/schedules/schedules.ts index e05fc4bd..55414024 100644 --- a/src/lib/routes/thermostats/schedules/schedules.ts +++ b/src/lib/routes/thermostats/schedules/schedules.ts @@ -162,7 +162,7 @@ export class SeamHttpThermostatsSchedules { } /** - * Creates a new [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Creates a new [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ create( parameters: ThermostatsSchedulesCreateParameters, @@ -187,7 +187,7 @@ export class SeamHttpThermostatsSchedules { } /** - * Deletes a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Deletes a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ delete( parameters: ThermostatsSchedulesDeleteParameters, @@ -207,7 +207,7 @@ export class SeamHttpThermostatsSchedules { } /** - * Returns a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Returns a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ get( parameters: ThermostatsSchedulesGetParameters, @@ -227,7 +227,7 @@ export class SeamHttpThermostatsSchedules { } /** - * Returns a list of all [thermostat schedules](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Returns a list of all [thermostat schedules](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ list( parameters: ThermostatsSchedulesListParameters, @@ -247,7 +247,7 @@ export class SeamHttpThermostatsSchedules { } /** - * Updates a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + * Updates a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules). */ update( parameters: ThermostatsSchedulesUpdateParameters, @@ -269,7 +269,7 @@ export class SeamHttpThermostatsSchedules { export type ThermostatsSchedulesCreateParameters = { /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule. + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule. */ climate_preset_key: string @@ -284,11 +284,11 @@ export type ThermostatsSchedulesCreateParameters = { ends_at: string /** - * Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ is_override_allowed?: boolean | undefined /** - * Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ max_override_period_minutes?: number | null | undefined /** @@ -380,7 +380,7 @@ export interface ThermostatsSchedulesListOptions {} export type ThermostatsSchedulesUpdateParameters = { /** - * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. + * Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */ climate_preset_key?: string | undefined /** @@ -388,11 +388,11 @@ export type ThermostatsSchedulesUpdateParameters = { */ ends_at?: string | undefined /** - * Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ is_override_allowed?: boolean | undefined /** - * Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */ max_override_period_minutes?: number | null | undefined /** diff --git a/src/lib/routes/thermostats/simulate/simulate.ts b/src/lib/routes/thermostats/simulate/simulate.ts index f98355bb..ac565eda 100644 --- a/src/lib/routes/thermostats/simulate/simulate.ts +++ b/src/lib/routes/thermostats/simulate/simulate.ts @@ -161,7 +161,7 @@ export class SeamHttpThermostatsSimulate { } /** - * Simulates having adjusted the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). + * Simulates having adjusted the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://www.seam.co/docs/capability-guides/thermostats). Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). */ hvacModeAdjusted( parameters: ThermostatsSimulateHvacModeAdjustedParameters, @@ -181,7 +181,7 @@ export class SeamHttpThermostatsSimulate { } /** - * Simulates a [thermostat](https://docs.seam.co/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). + * Simulates a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints). */ temperatureReached( parameters: ThermostatsSimulateTemperatureReachedParameters, @@ -203,11 +203,11 @@ export class SeamHttpThermostatsSimulate { export type ThermostatsSimulateHvacModeAdjustedParameters = { /** - * Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. + * Cooling [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */ cooling_set_point_celsius?: number | undefined /** - * Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. + * Cooling [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */ cooling_set_point_fahrenheit?: number | undefined /** @@ -216,11 +216,11 @@ export type ThermostatsSimulateHvacModeAdjustedParameters = { device_id: string /** - * Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. + * Heating [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */ heating_set_point_celsius?: number | undefined /** - * Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. + * Heating [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */ heating_set_point_fahrenheit?: number | undefined /** diff --git a/src/lib/routes/thermostats/thermostats.ts b/src/lib/routes/thermostats/thermostats.ts index 645d9a70..dd35b08c 100644 --- a/src/lib/routes/thermostats/thermostats.ts +++ b/src/lib/routes/thermostats/thermostats.ts @@ -183,7 +183,7 @@ export class SeamHttpThermostats { } /** - * Activates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Activates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ activateClimatePreset( parameters: ThermostatsActivateClimatePresetParameters, @@ -208,7 +208,7 @@ export class SeamHttpThermostats { } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [cool mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [cool mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). */ cool( parameters: ThermostatsCoolParameters, @@ -233,7 +233,7 @@ export class SeamHttpThermostats { } /** - * Creates a [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Creates a [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ createClimatePreset( parameters: ThermostatsCreateClimatePresetParameters, @@ -253,7 +253,7 @@ export class SeamHttpThermostats { } /** - * Deletes a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Deletes a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ deleteClimatePreset( parameters: ThermostatsDeleteClimatePresetParameters, @@ -273,7 +273,7 @@ export class SeamHttpThermostats { } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). */ heat( parameters: ThermostatsHeatParameters, @@ -298,7 +298,7 @@ export class SeamHttpThermostats { } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat-cool ("auto") mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). */ heatCool( parameters: ThermostatsHeatCoolParameters, @@ -323,7 +323,7 @@ export class SeamHttpThermostats { } /** - * Returns a list of all [thermostats](https://docs.seam.co/capability-guides/thermostats). + * Returns a list of all [thermostats](https://www.seam.co/docs/capability-guides/thermostats). */ list( parameters?: ThermostatsListParameters, @@ -343,7 +343,7 @@ export class SeamHttpThermostats { } /** - * Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings). + * Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to ["off" mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings). */ off( parameters: ThermostatsOffParameters, @@ -368,7 +368,7 @@ export class SeamHttpThermostats { } /** - * Sets a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Sets a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ setFallbackClimatePreset( parameters: ThermostatsSetFallbackClimatePresetParameters, @@ -388,7 +388,7 @@ export class SeamHttpThermostats { } /** - * Sets the [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Sets the [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ setFanMode( parameters: ThermostatsSetFanModeParameters, @@ -413,7 +413,7 @@ export class SeamHttpThermostats { } /** - * Sets the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Sets the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ setHvacMode( parameters: ThermostatsSetHvacModeParameters, @@ -438,7 +438,7 @@ export class SeamHttpThermostats { } /** - * Sets a [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. + * Sets a [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. */ setTemperatureThreshold( parameters: ThermostatsSetTemperatureThresholdParameters, @@ -458,7 +458,7 @@ export class SeamHttpThermostats { } /** - * Updates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats). + * Updates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats). */ updateClimatePreset( parameters: ThermostatsUpdateClimatePresetParameters, @@ -534,11 +534,11 @@ export type ThermostatsActivateClimatePresetOptions = Pick< export type ThermostatsCoolParameters = { /** - * [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */ cooling_set_point_celsius?: number | undefined /** - * [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */ cooling_set_point_fahrenheit?: number | undefined /** @@ -564,7 +564,7 @@ export type ThermostatsCoolOptions = Pick< export type ThermostatsCreateClimatePresetParameters = { /** - * Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ climate_preset_key: string @@ -574,11 +574,11 @@ export type ThermostatsCreateClimatePresetParameters = { climate_preset_mode?: 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied' | undefined /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_fahrenheit?: number | undefined /** @@ -606,19 +606,19 @@ export type ThermostatsCreateClimatePresetParameters = { } | undefined /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */ fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_fahrenheit?: number | undefined /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */ hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined /** @@ -627,7 +627,7 @@ export type ThermostatsCreateClimatePresetParameters = { */ manual_override_allowed?: boolean | undefined /** - * User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ name?: string | null | undefined } @@ -675,11 +675,11 @@ export type ThermostatsHeatParameters = { device_id: string /** - * [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */ heating_set_point_celsius?: number | undefined /** - * [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */ heating_set_point_fahrenheit?: number | undefined } @@ -701,11 +701,11 @@ export type ThermostatsHeatOptions = Pick< export type ThermostatsHeatCoolParameters = { /** - * [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */ cooling_set_point_celsius?: number | undefined /** - * [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */ cooling_set_point_fahrenheit?: number | undefined /** @@ -714,11 +714,11 @@ export type ThermostatsHeatCoolParameters = { device_id: string /** - * [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */ heating_set_point_celsius?: number | undefined /** - * [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */ heating_set_point_fahrenheit?: number | undefined } @@ -858,7 +858,7 @@ export type ThermostatsSetFanModeParameters = { */ fan_mode?: 'auto' | 'on' | 'circulate' | undefined /** - * [Fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat. + * [Fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat. */ fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined } @@ -880,11 +880,11 @@ export type ThermostatsSetFanModeOptions = Pick< export type ThermostatsSetHvacModeParameters = { /** - * [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */ cooling_set_point_celsius?: number | undefined /** - * [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. + * [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */ cooling_set_point_fahrenheit?: number | undefined /** @@ -893,11 +893,11 @@ export type ThermostatsSetHvacModeParameters = { device_id: string /** - * [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */ heating_set_point_celsius?: number | undefined /** - * [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. + * [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */ heating_set_point_fahrenheit?: number | undefined @@ -957,7 +957,7 @@ export interface ThermostatsSetTemperatureThresholdOptions {} export type ThermostatsUpdateClimatePresetParameters = { /** - * Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ climate_preset_key: string @@ -967,11 +967,11 @@ export type ThermostatsUpdateClimatePresetParameters = { climate_preset_mode?: 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied' | undefined /** - * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ cooling_set_point_fahrenheit?: number | undefined /** @@ -999,28 +999,28 @@ export type ThermostatsUpdateClimatePresetParameters = { } | undefined /** - * Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + * Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */ fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined /** - * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_celsius?: number | undefined /** - * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + * Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */ heating_set_point_fahrenheit?: number | undefined /** - * Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + * Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */ hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined /** - * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). + * Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). * @deprecated Use 'thermostat_schedule.is_override_allowed' */ manual_override_allowed?: boolean | undefined /** - * User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). + * User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */ name?: string | null | undefined } diff --git a/src/lib/routes/user-identities/unmanaged/unmanaged.ts b/src/lib/routes/user-identities/unmanaged/unmanaged.ts index 1f814840..b3377f0f 100644 --- a/src/lib/routes/user-identities/unmanaged/unmanaged.ts +++ b/src/lib/routes/user-identities/unmanaged/unmanaged.ts @@ -165,7 +165,7 @@ export class SeamHttpUserIdentitiesUnmanaged { } /** - * Returns a specified unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). + * Returns a specified unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). */ get( parameters: UserIdentitiesUnmanagedGetParameters, @@ -185,7 +185,7 @@ export class SeamHttpUserIdentitiesUnmanaged { } /** - * Returns a list of all unmanaged [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). + * Returns a list of all unmanaged [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false). */ list( parameters?: UserIdentitiesUnmanagedListParameters, @@ -206,7 +206,7 @@ export class SeamHttpUserIdentitiesUnmanaged { } /** - * Updates an unmanaged [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed. + * Updates an unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed. * * This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged. */ diff --git a/src/lib/routes/user-identities/user-identities.ts b/src/lib/routes/user-identities/user-identities.ts index a3afc47b..4185d960 100644 --- a/src/lib/routes/user-identities/user-identities.ts +++ b/src/lib/routes/user-identities/user-identities.ts @@ -177,7 +177,7 @@ export class SeamHttpUserIdentities { } /** - * Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). * * You must specify either `user_identity_id` or `user_identity_key` to identify the user identity. * @@ -201,7 +201,7 @@ export class SeamHttpUserIdentities { } /** - * Creates a new [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Creates a new [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ create( parameters?: UserIdentitiesCreateParameters, @@ -221,7 +221,7 @@ export class SeamHttpUserIdentities { } /** - * Deletes a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/api/acs/credentials), [acs users](https://docs.seam.co/api/acs/users) and [client sessions](https://docs.seam.co/api/client_sessions). + * Deletes a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://www.seam.co/docs/api/acs/credentials/object), [acs users](https://www.seam.co/docs/api/acs/users/object) and [client sessions](https://www.seam.co/docs/api/client_sessions/object). */ delete( parameters: UserIdentitiesDeleteParameters, @@ -241,7 +241,7 @@ export class SeamHttpUserIdentities { } /** - * Generates a new [instant key](https://docs.seam.co/capability-guides/instant-keys) for a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Generates a new [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys) for a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ generateInstantKey( parameters: UserIdentitiesGenerateInstantKeyParameters, @@ -261,7 +261,7 @@ export class SeamHttpUserIdentities { } /** - * Returns a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ get( parameters: UserIdentitiesGetParameters, @@ -281,7 +281,7 @@ export class SeamHttpUserIdentities { } /** - * Grants a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/core-concepts/devices/). + * Grants a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://www.seam.co/docs/core-concepts/devices). */ grantAccessToDevice( parameters: UserIdentitiesGrantAccessToDeviceParameters, @@ -301,7 +301,7 @@ export class SeamHttpUserIdentities { } /** - * Returns a list of all [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a list of all [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ list( parameters?: UserIdentitiesListParameters, @@ -322,7 +322,7 @@ export class SeamHttpUserIdentities { } /** - * Returns a list of all [devices](https://docs.seam.co/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity. + * Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity. */ listAccessibleDevices( parameters: UserIdentitiesListAccessibleDevicesParameters, @@ -342,7 +342,7 @@ export class SeamHttpUserIdentities { } /** - * Returns a list of all [ACS entrances](https://docs.seam.co/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity. + * Returns a list of all [ACS entrances](https://www.seam.co/docs/api/acs/entrances/object) accessible to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity. */ listAccessibleEntrances( parameters: UserIdentitiesListAccessibleEntrancesParameters, @@ -362,7 +362,7 @@ export class SeamHttpUserIdentities { } /** - * Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ listAcsSystems( parameters: UserIdentitiesListAcsSystemsParameters, @@ -382,7 +382,7 @@ export class SeamHttpUserIdentities { } /** - * Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ listAcsUsers( parameters: UserIdentitiesListAcsUsersParameters, @@ -402,7 +402,7 @@ export class SeamHttpUserIdentities { } /** - * Merges one or more [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity. + * Merges one or more [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity. * * The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`. * @@ -433,7 +433,7 @@ export class SeamHttpUserIdentities { } /** - * Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ removeAcsUser( parameters: UserIdentitiesRemoveAcsUserParameters, @@ -453,7 +453,7 @@ export class SeamHttpUserIdentities { } /** - * Revokes access to a specified [device](https://docs.seam.co/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Revokes access to a specified [device](https://www.seam.co/docs/core-concepts/devices) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ revokeAccessToDevice( parameters: UserIdentitiesRevokeAccessToDeviceParameters, @@ -473,7 +473,7 @@ export class SeamHttpUserIdentities { } /** - * Updates a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + * Updates a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */ update( parameters: UserIdentitiesUpdateParameters, diff --git a/src/lib/routes/webhooks/webhooks.ts b/src/lib/routes/webhooks/webhooks.ts index c19f3bf4..5841a653 100644 --- a/src/lib/routes/webhooks/webhooks.ts +++ b/src/lib/routes/webhooks/webhooks.ts @@ -162,7 +162,7 @@ export class SeamHttpWebhooks { } /** - * Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks). + * Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ create( parameters: WebhooksCreateParameters, @@ -182,7 +182,7 @@ export class SeamHttpWebhooks { } /** - * Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + * Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ delete( parameters: WebhooksDeleteParameters, @@ -202,7 +202,7 @@ export class SeamHttpWebhooks { } /** - * Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + * Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ get( parameters: WebhooksGetParameters, @@ -222,7 +222,7 @@ export class SeamHttpWebhooks { } /** - * Returns a list of all [webhooks](https://docs.seam.co/developer-tools/webhooks). + * Returns a list of all [webhooks](https://www.seam.co/docs/developer-tools/webhooks). */ list( parameters?: WebhooksListParameters, @@ -242,7 +242,7 @@ export class SeamHttpWebhooks { } /** - * Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks). + * Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks). */ update( parameters: WebhooksUpdateParameters, diff --git a/src/lib/routes/workspaces/workspaces.ts b/src/lib/routes/workspaces/workspaces.ts index 910d3b33..3ccfc250 100644 --- a/src/lib/routes/workspaces/workspaces.ts +++ b/src/lib/routes/workspaces/workspaces.ts @@ -164,7 +164,7 @@ export class SeamHttpWorkspaces { } /** - * Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces). + * Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces). */ create( parameters: WorkspacesCreateParameters, @@ -184,7 +184,7 @@ export class SeamHttpWorkspaces { } /** - * Returns the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Returns the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. */ get( parameters?: WorkspacesGetParameters, @@ -204,7 +204,7 @@ export class SeamHttpWorkspaces { } /** - * Returns a list of [workspaces](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. */ list( parameters?: WorkspacesListParameters, @@ -224,7 +224,7 @@ export class SeamHttpWorkspaces { } /** - * Resets the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces. + * Resets the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces. */ resetSandbox( parameters?: WorkspacesResetSandboxParameters, @@ -249,7 +249,7 @@ export class SeamHttpWorkspaces { } /** - * Updates the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value. + * Updates the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value. */ update( parameters?: WorkspacesUpdateParameters, @@ -280,30 +280,30 @@ export type WorkspacesCreateParameters = { */ connect_partner_name?: string | null | undefined /** - * [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ connect_webview_customization?: | { /** - * Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Logo shape for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ logo_shape?: 'circle' | 'square' | null | undefined /** - * Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Primary button color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_color?: string | null | undefined /** - * Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Primary button text color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_text_color?: string | null | undefined /** - * Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Success message for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ success_message?: string | null | undefined } | undefined /** - * Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). + * Indicates whether the new workspace is a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). */ is_sandbox?: boolean | undefined /** @@ -396,24 +396,24 @@ export type WorkspacesUpdateParameters = { */ connect_partner_name?: string | undefined /** - * [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ connect_webview_customization?: | { /** - * Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Logo shape for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ logo_shape?: 'circle' | 'square' | null | undefined /** - * Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Primary button color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_color?: string | null | undefined /** - * Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Primary button text color for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ primary_button_text_color?: string | null | undefined /** - * Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + * Success message for [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */ success_message?: string | null | undefined }