diff --git a/mintlify-codegen/generate.ts b/mintlify-codegen/generate.ts index b95d22da6..b97123e74 100644 --- a/mintlify-codegen/generate.ts +++ b/mintlify-codegen/generate.ts @@ -1,5 +1,5 @@ /* eslint-disable no-console */ -import { readFile, writeFile } from 'node:fs/promises' +import { readdir, readFile, writeFile } from 'node:fs/promises' import { join } from 'node:path' import { env } from 'node:process' @@ -67,6 +67,14 @@ if (updatedObjects.length > 0) { ) } +// Phase G: strip any legacy `/latest` from generated docs links. Guards against +// upstream @seamapi/types regressions reintroducing `docs.seam.co/latest` into +// generated descriptions. The docs site serves at the root (no `/latest`); a +// `/latest/:path*` redirect handles old inbound URLs. See DOC-206 / DOC-199. +console.log('Sanitizing legacy /latest links in generated output...') +const sanitizedCount = await stripLatestLinks(outputDir) +console.log(` Sanitized ${sanitizedCount} generated file(s)`) + console.log(`\nDone!`) console.log(` Removed undocumented paths: ${stats.removedPaths}`) console.log(` Total documented endpoints: ${stats.totalEndpoints}`) @@ -81,6 +89,37 @@ if (stats.withoutCodeSamples.length > 0) { ) } +/** + * Strip the legacy `/latest` path segment from `docs.seam.co` links in the + * generated output (openapi.json + the API `object.mdx` pages). These links + * originate in `@seamapi/types` descriptions; this guard keeps the docs + * `/latest`-free regardless of the upstream package version. + */ +async function stripLatestLinks(docsDir: string): Promise { + const files = [join(docsDir, 'openapi.json')] + const apiDir = join(docsDir, 'api') + const entries = await readdir(apiDir, { recursive: true }) + for (const entry of entries) { + if (entry.endsWith('.mdx')) files.push(join(apiDir, entry)) + } + + let count = 0 + for (const file of files) { + let content: string + try { + content = await readFile(file, 'utf8') + } catch { + continue + } + const replaced = content.split('docs.seam.co/latest').join('docs.seam.co') + if (replaced !== content) { + await writeFile(file, replaced) + count++ + } + } + return count +} + function renderCodeGroup( samples: Array<{ title: string diff --git a/mintlify-docs/api/access_codes/object.mdx b/mintlify-docs/api/access_codes/object.mdx index 6e07db4c8..eae4bf935 100644 --- a/mintlify-docs/api/access_codes/object.mdx +++ b/mintlify-docs/api/access_codes/object.mdx @@ -5,13 +5,13 @@ description: 'Learn how the access_code object represents a smart lock PIN code ## The access_code Object -Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). +Represents a smart lock [access code](https://docs.seam.co/capability-guides/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/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/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://docs.seam.co/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/capability-guides/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/latest/capability-guides/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://docs.seam.co/capability-guides/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. @@ -188,7 +188,7 @@ In addition, for certain devices, Seam also supports [offline access codes](http - Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + Errors associated with the [access code](https://docs.seam.co/capability-guides/smart-locks/access-codes). @@ -240,7 +240,7 @@ In addition, for certain devices, Seam also supports [offline access codes](http - 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/latest/capability-guides/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://docs.seam.co/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). @@ -248,7 +248,7 @@ In addition, for certain devices, Seam also supports [offline access codes](http - Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + Warnings associated with the [access code](https://docs.seam.co/capability-guides/smart-locks/access-codes). diff --git a/mintlify-docs/api/access_codes/unmanaged/object.mdx b/mintlify-docs/api/access_codes/unmanaged/object.mdx index e0addaa3d..6586efadb 100644 --- a/mintlify-docs/api/access_codes/unmanaged/object.mdx +++ b/mintlify-docs/api/access_codes/unmanaged/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the unmanaged_access_code object represents an existing ## The unmanaged_access_code Object -Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). +Represents an [unmanaged smart lock access code](https://docs.seam.co/capability-guides/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. @@ -15,7 +15,7 @@ Prior to using Seam to manage your devices, you may have used another lock manag Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes: -- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) +- [Kwikset](https://docs.seam.co/device-and-system-integration-guides/kwikset-locks) @@ -102,7 +102,7 @@ Not all providers support unmanaged access codes. The following providers do not - Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + Errors associated with the [access code](https://docs.seam.co/capability-guides/smart-locks/access-codes). @@ -126,7 +126,7 @@ Not all providers support unmanaged access codes. The following providers do not - Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + Warnings associated with the [access code](https://docs.seam.co/capability-guides/smart-locks/access-codes). diff --git a/mintlify-docs/api/access_grants/object.mdx b/mintlify-docs/api/access_grants/object.mdx index e57fc0dd5..0fad029db 100644 --- a/mintlify-docs/api/access_grants/object.mdx +++ b/mintlify-docs/api/access_grants/object.mdx @@ -96,7 +96,7 @@ Represents an Access Grant. Access Grants enable you to grant a user identity ac - Errors associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). + Errors associated with the [access grant](https://docs.seam.co/capability-guides/access-grants). @@ -136,7 +136,7 @@ Represents an Access Grant. Access Grants enable you to grant a user identity ac - Warnings associated with the [access grant](https://docs.seam.co/latest/capability-guides/access-grants). + Warnings associated with the [access grant](https://docs.seam.co/capability-guides/access-grants). diff --git a/mintlify-docs/api/access_methods/object.mdx b/mintlify-docs/api/access_methods/object.mdx index 3125c7625..da87267a8 100644 --- a/mintlify-docs/api/access_methods/object.mdx +++ b/mintlify-docs/api/access_methods/object.mdx @@ -121,11 +121,11 @@ Represents an access method for an Access Grant. Access methods describe the mod - Pending mutations for the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress. + Pending mutations for the [access method](https://docs.seam.co/capability-guides/access-grants/delivering-access-methods). Indicates operations that are in progress. - Warnings associated with the [access method](https://docs.seam.co/latest/capability-guides/access-grants/delivering-access-methods). + Warnings associated with the [access method](https://docs.seam.co/capability-guides/access-grants/delivering-access-methods). diff --git a/mintlify-docs/api/acs/access_groups/object.mdx b/mintlify-docs/api/acs/access_groups/object.mdx index 53211a697..d8cafac4a 100644 --- a/mintlify-docs/api/acs/access_groups/object.mdx +++ b/mintlify-docs/api/acs/access_groups/object.mdx @@ -7,9 +7,9 @@ description: 'Learn how the acs_access_group object defines the entrances a set 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/latest/capability-guides/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://docs.seam.co/capability-guides/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/latest/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://docs.seam.co/device-and-system-integration-guides#access-control-systems). @@ -68,7 +68,7 @@ To learn whether your access control system supports access groups, see the corr - ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. + ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the access group. @@ -108,5 +108,5 @@ To learn whether your access control system supports access groups, see the corr - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the access group. diff --git a/mintlify-docs/api/acs/credentials/object.mdx b/mintlify-docs/api/acs/credentials/object.mdx index 5326b066c..9dc1f4bb6 100644 --- a/mintlify-docs/api/acs/credentials/object.mdx +++ b/mintlify-docs/api/acs/credentials/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the acs_credential object represents the means—such as ## The acs_credential Object -Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +Means by which an [access control system user](https://docs.seam.co/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/capability-guides/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. @@ -100,11 +100,11 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties - Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. + Access method for the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. - ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + ID of the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). @@ -112,15 +112,15 @@ For each `acs_credential`, you define the access method. You can also specify ad - ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + ID of the [access control system](https://docs.seam.co/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). - ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. + ID of the [ACS user](https://docs.seam.co/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) belongs. - Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + Vostio-specific metadata for the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. @@ -144,47 +144,47 @@ For each `acs_credential`, you define the access method. You can also specify ad - Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + Number of the card associated with the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). - Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + Access (PIN) code for the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). - ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. + ID of the [connected account](https://docs.seam.co/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) belongs. - Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. + Date and time at which the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) was created. - Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. + Display name that corresponds to the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) type. - Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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://docs.seam.co/capability-guides/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`. - Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + Errors associated with the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). - Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. + Brand-specific terminology for the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. - Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. + Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) type. - Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. + Indicates whether the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) has been encoded onto a card. - Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. + Indicates whether the latest state of the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. @@ -192,35 +192,35 @@ For each `acs_credential`, you define the access method. You can also specify ad - Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). + Indicates whether the [credential](https://docs.seam.co/capability-guides/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://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. + Indicates whether the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. - Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. + Date and time at which the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) was encoded onto a card. - Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. + Date and time at which the state of the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. - ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + ID of the parent [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). - Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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://docs.seam.co/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. + ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) belongs. - Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + Visionline-specific metadata for the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. @@ -250,9 +250,9 @@ For each `acs_credential`, you define the access method. You can also specify ad - Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + Warnings associated with the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials). diff --git a/mintlify-docs/api/acs/encoders/object.mdx b/mintlify-docs/api/acs/encoders/object.mdx index a58af1115..8e76d4470 100644 --- a/mintlify-docs/api/acs/encoders/object.mdx +++ b/mintlify-docs/api/acs/encoders/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the acs_encoder object represents a hardware device that ## The acs_encoder Object -Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +Represents a hardware device that encodes [credential](https://docs.seam.co/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/capability-guides/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: @@ -16,9 +16,9 @@ Some access control systems require credentials to be encoded onto plastic key c 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/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). +See [Working with Card Encoders and Scanners](https://docs.seam.co/capability-guides/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/latest/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://docs.seam.co/device-and-system-integration-guides#access-control-systems). @@ -41,29 +41,29 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties - ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. + ID of the [encoder](https://docs.seam.co/capability-guides/access-systems/working-with-card-encoders-and-scanners. - ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). + ID of the [access control system](https://docs.seam.co/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/capability-guides/access-systems/working-with-card-encoders-and-scanners). - ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). + ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/capability-guides/access-systems/working-with-card-encoders-and-scanners). - Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created. + Date and time at which the [encoder](https://docs.seam.co/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created. - Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). + Display name for the [encoder](https://docs.seam.co/capability-guides/access-systems/working-with-card-encoders-and-scanners). - Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). + Errors associated with the [encoder](https://docs.seam.co/capability-guides/access-systems/working-with-card-encoders-and-scanners). - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/capability-guides/access-systems/working-with-card-encoders-and-scanners). diff --git a/mintlify-docs/api/acs/entrances/object.mdx b/mintlify-docs/api/acs/entrances/object.mdx index 37c96ea76..52884d461 100644 --- a/mintlify-docs/api/acs/entrances/object.mdx +++ b/mintlify-docs/api/acs/entrances/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the acs_entrance object represents a secured door, gate, ## The acs_entrance Object -Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +Represents an [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/capability-guides/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. @@ -41,15 +41,15 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties - ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + ID of the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). - ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + ID of the [access control system](https://docs.seam.co/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). - ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). Name of the door in the Vostio access system. @@ -70,7 +70,7 @@ In an access control system, an entrance is a secured door, gate, zone, or other - Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). Entry name for an Avigilon Alta system. @@ -97,7 +97,7 @@ In an access control system, an entrance is a secured door, gate, zone, or other - Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Brivo-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). ID of the access point in the Brivo access system. @@ -132,19 +132,19 @@ In an access control system, an entrance is a secured door, gate, zone, or other - ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + ID of the [connected account](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). - Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. + Date and time at which the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details) was created. - Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Display name for the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). - dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). Name of the access point in the dormakaba Ambiance access system. @@ -153,7 +153,7 @@ In an access control system, an entrance is a secured door, gate, zone, or other - dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). Type of access point profile in the dormakaba Community access system. @@ -162,11 +162,11 @@ In an access control system, an entrance is a secured door, gate, zone, or other - Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Errors associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). - Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Hotek-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). Display name of the entrance. @@ -181,11 +181,11 @@ In an access control system, an entrance is a secured door, gate, zone, or other - Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked. + Indicates whether the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details) is currently locked. - Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Latch-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). Accessibility type in the Latch access system. @@ -203,7 +203,7 @@ In an access control system, an entrance is a secured door, gate, zone, or other - Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). Battery level of the door access device. @@ -233,7 +233,7 @@ In an access control system, an entrance is a secured door, gate, zone, or other - Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. @@ -261,7 +261,7 @@ In an access control system, an entrance is a secured door, gate, zone, or other - Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Visionline-specific metadata associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). Category of the door in the Visionline access system. @@ -276,5 +276,5 @@ In an access control system, an entrance is a secured door, gate, zone, or other - Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). + Warnings associated with the [entrance](https://docs.seam.co/capability-guides/access-systems/retrieving-entrance-details). diff --git a/mintlify-docs/api/acs/systems/object.mdx b/mintlify-docs/api/acs/systems/object.mdx index d1aa3c724..4b6205db5 100644 --- a/mintlify-docs/api/acs/systems/object.mdx +++ b/mintlify-docs/api/acs/systems/object.mdx @@ -5,11 +5,11 @@ description: 'Learn how the acs_system object represents an access control syste ## The acs_system Object -Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +Represents an [access control system](https://docs.seam.co/capability-guides/access-systems). -Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/latest/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/latest/api/acs/credentials#acs_credential) to grant access to the `acs_user`s. +Within an `acs_system`, create [`acs_user`s](https://docs.seam.co/api/acs/users#acs_user) and [`acs_credential`s](https://docs.seam.co/api/acs/credentials#acs_credential) 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/latest/api/acs). +For details about the resources associated with an access control system, see the [access control systems namespace](https://docs.seam.co/api/acs). @@ -50,7 +50,7 @@ For details about the resources associated with an access control system, see th - ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + ID of the [access control system](https://docs.seam.co/capability-guides/access-systems). @@ -58,39 +58,39 @@ For details about the resources associated with an access control system, see th - ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/capability-guides/access-systems). - IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/capability-guides/access-systems). - Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. + Date and time at which the [access control system](https://docs.seam.co/capability-guides/access-systems) was created. - ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/capability-guides/access-systems). - Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + Errors associated with the [access control system](https://docs.seam.co/capability-guides/access-systems). - Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. + Brand-specific terminology for the [access control system](https://docs.seam.co/capability-guides/access-systems) type. - Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. + Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/capability-guides/access-systems) type. - Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. + Alternative text for the [access control system](https://docs.seam.co/capability-guides/access-systems) image. - URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + URL for the image that represents the [access control system](https://docs.seam.co/capability-guides/access-systems). @@ -101,13 +101,13 @@ For details about the resources associated with an access control system, see th The location. - Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. + Time zone in which the [access control system](https://docs.seam.co/capability-guides/access-systems) is located. - Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + Name of the [access control system](https://docs.seam.co/capability-guides/access-systems). @@ -122,7 +122,7 @@ For details about the resources associated with an access control system, see th The visionline metadata. - IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network. + 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. Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. @@ -134,9 +134,9 @@ For details about the resources associated with an access control system, see th - Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + Warnings associated with the [access control system](https://docs.seam.co/capability-guides/access-systems). - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/capability-guides/access-systems). diff --git a/mintlify-docs/api/acs/users/object.mdx b/mintlify-docs/api/acs/users/object.mdx index 5cb4b88fe..805e00051 100644 --- a/mintlify-docs/api/acs/users/object.mdx +++ b/mintlify-docs/api/acs/users/object.mdx @@ -5,11 +5,11 @@ description: 'Learn how the acs_user object represents an individual—such as a ## The acs_user Object -Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/latest/capability-guides/access-systems). +Represents a [user](https://docs.seam.co/capability-guides/access-systems/user-management) in an [access system](https://docs.seam.co/capability-guides/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/latest/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://docs.seam.co/device-and-system-integration-guides#access-control-systems). @@ -63,7 +63,7 @@ For details about how to configure users in your access system, see the correspo ## Properties - `starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. + `starts_at` and `ends_at` timestamps for the [access system user's](https://docs.seam.co/capability-guides/access-systems/user-management) access. Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. @@ -75,23 +75,23 @@ For details about how to configure users in your access system, see the correspo - ID of the [access system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + ID of the [access system](https://docs.seam.co/capability-guides/access-systems) that contains the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). - ID of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + ID of the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). - The ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + The ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) that is associated with the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). - Date and time at which the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. + Date and time at which the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management) was created. - Display name for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + Display name for the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). @@ -99,23 +99,23 @@ For details about how to configure users in your access system, see the correspo - Email address of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + Email address of the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). - Errors associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + Errors associated with the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). - Brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. + Brand-specific terminology for the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management) type. - Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. + Display name that corresponds to the brand-specific terminology for the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management) type. - Full name of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + Full name of the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). @@ -127,19 +127,19 @@ For details about how to configure users in your access system, see the correspo - Indicates whether the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). + Indicates whether the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management) is currently [suspended](https://docs.seam.co/capability-guides/access-systems/user-management/suspending-and-unsuspending-users). - Pending mutations associated with the [access system user](https://docs.seam.co/latest/capability-guides/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://docs.seam.co/capability-guides/access-systems/user-management). Seam is in the process of pushing these mutations to the integrated access system. - Phone number of the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). + Phone number of the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). - Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. @@ -151,25 +151,25 @@ For details about how to configure users in your access system, see the correspo - Email address of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + Email address of the user identity associated with the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). - Full name of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + Full name of the user identity associated with the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). - ID of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + ID of the user identity associated with the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). - Phone number of the user identity associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). + Phone number of the user identity associated with the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). - Warnings associated with the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + Warnings associated with the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the [access system user](https://docs.seam.co/capability-guides/access-systems/user-management). diff --git a/mintlify-docs/api/client_sessions/object.mdx b/mintlify-docs/api/client_sessions/object.mdx index e27ae76d7..d854a00fb 100644 --- a/mintlify-docs/api/client_sessions/object.mdx +++ b/mintlify-docs/api/client_sessions/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the client_session object restricts your users to their ## The client_session Object -Represents a [client session](https://docs.seam.co/latest/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://docs.seam.co/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. @@ -13,7 +13,7 @@ When calling the Seam API from your backend using an API key, you can pass the ` 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/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). +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). @@ -47,49 +47,49 @@ See also [Get Started with React](https://docs.seam.co/latest/ui-components/over ## Properties - ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). + ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). - IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). + 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 [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). + 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). - Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created. + Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created. - Customer key associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). + Customer key associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). - Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). + Number of devices associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). - Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires. + Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) expires. - Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). + Client session token 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://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). + Your user ID for the user associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). - ID of the [user identity](https://docs.seam.co/latest/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://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://docs.seam.co/latest/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://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 [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). diff --git a/mintlify-docs/api/connect_webviews/object.mdx b/mintlify-docs/api/connect_webviews/object.mdx index 9e27f5309..82fe08ca3 100644 --- a/mintlify-docs/api/connect_webviews/object.mdx +++ b/mintlify-docs/api/connect_webviews/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the connect_webview object embeds a client-side flow tha ## The connect_webview Object -Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). +Represents a [Connect Webview](https://docs.seam.co/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. @@ -65,7 +65,7 @@ To list all providers within a category, use `/devices/list_device_providers` wi - List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). + 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). @@ -77,7 +77,7 @@ To list all providers within a category, use `/devices/list_device_providers` wi - Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/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://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. @@ -85,7 +85,7 @@ To list all providers within a category, use `/devices/list_device_providers` wi - ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview. + ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) associated with the Connect Webview. @@ -93,7 +93,7 @@ To list all providers within a category, use `/devices/list_device_providers` wi - Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. + 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. @@ -117,7 +117,7 @@ To list all providers within a category, use `/devices/list_device_providers` wi - Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/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://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). @@ -129,9 +129,9 @@ To list all providers within a category, use `/devices/list_device_providers` wi - Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/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://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. - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Connect Webview. diff --git a/mintlify-docs/api/connected_accounts/object.mdx b/mintlify-docs/api/connected_accounts/object.mdx index 886d09192..c18920e8a 100644 --- a/mintlify-docs/api/connected_accounts/object.mdx +++ b/mintlify-docs/api/connected_accounts/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the connected_account object represents an external thir ## The connected_account Object -Represents a [connected account](https://docs.seam.co/latest/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://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. @@ -54,7 +54,7 @@ Represents a [connected account](https://docs.seam.co/latest/core-concepts/conne - Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/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://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. @@ -66,7 +66,7 @@ Represents a [connected account](https://docs.seam.co/latest/core-concepts/conne - Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. + 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. diff --git a/mintlify-docs/api/customers/object.mdx b/mintlify-docs/api/customers/object.mdx index 275a6423a..512f0c9d9 100644 --- a/mintlify-docs/api/customers/object.mdx +++ b/mintlify-docs/api/customers/object.mdx @@ -46,5 +46,5 @@ Seam hosts these flows, handling everything from account connection and device m - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the customer portal. diff --git a/mintlify-docs/api/devices/object.mdx b/mintlify-docs/api/devices/object.mdx index fa94404e5..081b02bde 100644 --- a/mintlify-docs/api/devices/object.mdx +++ b/mintlify-docs/api/devices/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the device object represents a smart lock, thermostat, s ## The device Object -Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. +Represents a [device](https://docs.seam.co/core-concepts/devices) that has been connected to Seam. @@ -470,7 +470,7 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - 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/latest/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://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags). @@ -482,7 +482,7 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. + 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. @@ -502,7 +502,7 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). + Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/core-concepts/devices/managed-and-unmanaged-devices). @@ -1437,54 +1437,54 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha Supported code lengths for access codes. - Indicates whether the device supports a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). + Indicates whether the device supports a [backup access code pool](https://docs.seam.co/capability-guides/smart-locks/access-codes/backup-access-codes). - Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + Active [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + 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). - Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. + Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. - ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. + ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device. - Date and time at which the [thermostat schedule](https://docs.seam.co/latest/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://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. - Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/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://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. - 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/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/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://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). - User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - Date and time at which the [thermostat schedule](https://docs.seam.co/latest/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://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. - ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. - ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + ID of the active [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied". - Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. + Available [climate presets](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. Fan mode settings that the thermostat supports. @@ -1496,28 +1496,28 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha Current climate setting. - Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + 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://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + 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://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + 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. - Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). The climate preset mode for the thermostat, based on the available climate preset modes reported by the device. - Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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 °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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). - Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). Metadata specific to the Ecobee climate, if applicable. @@ -1534,22 +1534,22 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. - Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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 °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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). - Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/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://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). @@ -1557,28 +1557,28 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha The default climate setting. - Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + 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://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + 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://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + 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. - Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). The climate preset mode for the thermostat, based on the available climate preset modes reported by the device. - Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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 °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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). - Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). Metadata specific to the Ecobee climate, if applicable. @@ -1595,27 +1595,27 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. - Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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 °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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). - Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/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://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). - Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. + 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. The fan mode setting. @@ -1633,16 +1633,16 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`. - Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. + 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://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. + Maximum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. - Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. + 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://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. + Maximum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. @@ -1651,22 +1651,22 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha Maximum number of climate presets that the thermostat can support for weekly programming. - Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. + 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://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. + Minimum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. - Minimum [temperature difference](https://docs.seam.co/latest/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://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://docs.seam.co/latest/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://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 [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. + 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://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. + Minimum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. Reported relative humidity, as a value between 0 and 1, inclusive. @@ -1678,19 +1678,19 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha Reported temperature in °F. - Current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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 °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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. - Upper limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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 °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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. @@ -1698,10 +1698,10 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. - Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + Configured [daily programs](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. - Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + Current [weekly program](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. Date and time at which the thermostat weekly program was created. @@ -1836,7 +1836,7 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Indicates whether the device supports a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). + Indicates whether the device supports a [backup access code pool](https://docs.seam.co/capability-guides/smart-locks/access-codes/backup-access-codes). ## Hardware @@ -1934,46 +1934,46 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha ## Thermostats - Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + Active [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + 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). - Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. + Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. - ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. + ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device. - Date and time at which the [thermostat schedule](https://docs.seam.co/latest/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://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. - Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/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://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. - 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/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/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://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). - User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - Date and time at which the [thermostat schedule](https://docs.seam.co/latest/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://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. - ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. - ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + ID of the active [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). @@ -1981,7 +1981,7 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. + Available [climate presets](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat. @@ -1996,28 +1996,28 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha Current climate setting. - Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + 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://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + 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://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + 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. - Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). The climate preset mode for the thermostat, based on the available climate preset modes reported by the device. - Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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 °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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). - Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). Metadata specific to the Ecobee climate, if applicable. @@ -2034,22 +2034,22 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. - Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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 °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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). - Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/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://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). @@ -2058,28 +2058,28 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha The default climate setting. - Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted. + 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://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited. + 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://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program. + 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. - Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). The climate preset mode for the thermostat, based on the available climate preset modes reported by the device. - Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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 °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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). - Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + Display name for the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). Metadata specific to the Ecobee climate, if applicable. @@ -2096,28 +2096,28 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. + Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. - Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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 °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). + 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). - Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. + Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/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://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). - User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets). + User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets). - Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat. + 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. @@ -2141,19 +2141,19 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. + 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://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. + Maximum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. - Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. + 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://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. + Maximum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. @@ -2165,27 +2165,27 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C. + 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://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. + Minimum [cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F. - Minimum [temperature difference](https://docs.seam.co/latest/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://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://docs.seam.co/latest/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://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 [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C. + 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://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. + Minimum [heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F. @@ -2201,19 +2201,19 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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 °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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. - Upper limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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 °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat. + 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. @@ -2223,11 +2223,11 @@ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that ha - Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + Configured [daily programs](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. - Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. + Current [weekly program](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat. Date and time at which the thermostat weekly program was created. diff --git a/mintlify-docs/api/devices/unmanaged/object.mdx b/mintlify-docs/api/devices/unmanaged/object.mdx index e81ef2aff..2d9b11a09 100644 --- a/mintlify-docs/api/devices/unmanaged/object.mdx +++ b/mintlify-docs/api/devices/unmanaged/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the unmanaged_device object exposes a limited set of pro ## The unmanaged_device Object -Represents an [unmanaged device](https://docs.seam.co/latest/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/latest/capability-guides/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/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). +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/capability-guides/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). @@ -156,7 +156,7 @@ Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devic - 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/latest/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://docs.seam.co/capability-guides/device-and-system-capabilities#capability-flags). @@ -168,7 +168,7 @@ Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devic - Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. + 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. diff --git a/mintlify-docs/api/events/object.mdx b/mintlify-docs/api/events/object.mdx index 3d0c0d21c..40d8e7a44 100644 --- a/mintlify-docs/api/events/object.mdx +++ b/mintlify-docs/api/events/object.mdx @@ -45,5 +45,5 @@ description: 'Learn how the event object represents an occurrence in your worksp - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the event. diff --git a/mintlify-docs/api/instant_keys/object.mdx b/mintlify-docs/api/instant_keys/object.mdx index 9cc74cd9a..508fdcbc7 100644 --- a/mintlify-docs/api/instant_keys/object.mdx +++ b/mintlify-docs/api/instant_keys/object.mdx @@ -30,7 +30,7 @@ There’s no app to install, nor account to create. Your user just taps a link a ## Properties - ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. + ID of the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) associated with the Instant Key. @@ -73,5 +73,5 @@ There’s no app to install, nor account to create. Your user just taps a link a - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the Instant Key. diff --git a/mintlify-docs/api/noise_sensors/noise_thresholds/object.mdx b/mintlify-docs/api/noise_sensors/noise_thresholds/object.mdx index 139fba72c..3dbf645ea 100644 --- a/mintlify-docs/api/noise_sensors/noise_thresholds/object.mdx +++ b/mintlify-docs/api/noise_sensors/noise_thresholds/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the noise_threshold object sets the limits of noise tole ## The noise_threshold Object -Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/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://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. @@ -48,7 +48,7 @@ Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noi - Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/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://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors). diff --git a/mintlify-docs/api/phones/object.mdx b/mintlify-docs/api/phones/object.mdx index 399d4a5be..4c559e0b0 100644 --- a/mintlify-docs/api/phones/object.mdx +++ b/mintlify-docs/api/phones/object.mdx @@ -47,7 +47,7 @@ Represents an app user's mobile phone. - Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. + Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. @@ -100,7 +100,7 @@ Represents an app user's mobile phone. - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the phone. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the phone. ## phone.properties diff --git a/mintlify-docs/api/spaces/object.mdx b/mintlify-docs/api/spaces/object.mdx index bfd7ecd95..042f1eb5e 100644 --- a/mintlify-docs/api/spaces/object.mdx +++ b/mintlify-docs/api/spaces/object.mdx @@ -73,5 +73,5 @@ Represents a space that is a logical grouping of devices and entrances. You can - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the space. diff --git a/mintlify-docs/api/thermostats/daily_programs/object.mdx b/mintlify-docs/api/thermostats/daily_programs/object.mdx index 0427a7929..0d2360ad0 100644 --- a/mintlify-docs/api/thermostats/daily_programs/object.mdx +++ b/mintlify-docs/api/thermostats/daily_programs/object.mdx @@ -64,5 +64,5 @@ Represents a thermostat daily program, consisting of a set of periods, each of w - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat daily program. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat daily program. diff --git a/mintlify-docs/api/thermostats/schedules/object.mdx b/mintlify-docs/api/thermostats/schedules/object.mdx index 73899c99e..d1ccb5c85 100644 --- a/mintlify-docs/api/thermostats/schedules/object.mdx +++ b/mintlify-docs/api/thermostats/schedules/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the thermostat_schedule object activates a climate prese ## The thermostat_schedule Object -Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. +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. @@ -32,45 +32,45 @@ Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides ## Properties - Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + 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). - Date and time at which the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. + Date and time at which the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created. - ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. + ID of the desired [thermostat](https://docs.seam.co/capability-guides/thermostats) device. - Date and time at which the [thermostat schedule](https://docs.seam.co/latest/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://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. - Errors associated with the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + Errors associated with the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://docs.seam.co/latest/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://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts. - 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/latest/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/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://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). - User-friendly name to identify the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + User-friendly name to identify the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - Date and time at which the [thermostat schedule](https://docs.seam.co/latest/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://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. - ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules). + ID of the [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules). - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the thermostat schedule. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the thermostat schedule. diff --git a/mintlify-docs/api/user_identities/object.mdx b/mintlify-docs/api/user_identities/object.mdx index 8c1998197..853587b77 100644 --- a/mintlify-docs/api/user_identities/object.mdx +++ b/mintlify-docs/api/user_identities/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the user_identity object links a person to their applica ## The user_identity Object -Represents a [user identity](https://docs.seam.co/latest/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://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. @@ -74,5 +74,5 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces) that contains the user identity. diff --git a/mintlify-docs/api/webhooks/object.mdx b/mintlify-docs/api/webhooks/object.mdx index 201fa6385..237179aee 100644 --- a/mintlify-docs/api/webhooks/object.mdx +++ b/mintlify-docs/api/webhooks/object.mdx @@ -5,7 +5,7 @@ description: 'Learn how the webhook object lets you receive event notifications ## The webhook Object -Represents a [webhook](https://docs.seam.co/latest/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://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. @@ -28,17 +28,17 @@ Represents a [webhook](https://docs.seam.co/latest/developer-tools/webhooks) tha ## Properties - Types of events that the [webhook](https://docs.seam.co/latest/developer-tools/webhooks) should receive. + Types of events that the [webhook](https://docs.seam.co/developer-tools/webhooks) should receive. - Secret associated with the [webhook](https://docs.seam.co/latest/developer-tools/webhooks). + Secret associated with the [webhook](https://docs.seam.co/developer-tools/webhooks). - URL for the [webhook](https://docs.seam.co/latest/developer-tools/webhooks). + URL for the [webhook](https://docs.seam.co/developer-tools/webhooks). - ID of the [webhook](https://docs.seam.co/latest/developer-tools/webhooks). + ID of the [webhook](https://docs.seam.co/developer-tools/webhooks). diff --git a/mintlify-docs/api/workspaces/object.mdx b/mintlify-docs/api/workspaces/object.mdx index 3000e64ce..4e364645b 100644 --- a/mintlify-docs/api/workspaces/object.mdx +++ b/mintlify-docs/api/workspaces/object.mdx @@ -6,7 +6,7 @@ description: 'Learn how the workspace object represents an isolated Seam environ ## The workspace Object -Represents a Seam [workspace](https://docs.seam.co/latest/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/latest/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/latest/core-concepts/workspaces#production-workspaces). +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). @@ -77,7 +77,7 @@ Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspac ## Properties - Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). + Company name associated with the [workspace](https://docs.seam.co/core-concepts/workspaces). @@ -88,19 +88,19 @@ Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspac The connect webview customization. - URL of the inviter logo for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/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://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://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + 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). - Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + 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 text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + 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). - Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). + 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). @@ -110,21 +110,21 @@ Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspac - Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). + Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). - Indicates whether the [sandbox workspace](https://docs.seam.co/latest/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://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. - Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). + Name of the [workspace](https://docs.seam.co/core-concepts/workspaces). - Publishable key for the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). This key is used to identify the workspace in client-side applications. + Publishable key for the [workspace](https://docs.seam.co/core-concepts/workspaces). This key is used to identify the workspace in client-side applications. - ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). + ID of the [workspace](https://docs.seam.co/core-concepts/workspaces).