From a58f3d90cdc6c8094ef46baa93a27ae428db7a47 Mon Sep 17 00:00:00 2001 From: Mike Wu Date: Fri, 23 May 2025 18:31:15 +0900 Subject: [PATCH 1/2] fix: separate properties with --- --- src/layouts/api-route.hbs | 2 +- src/layouts/partials/property-collapsible.hbs | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 443c8b4b6..d870b50a4 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -49,7 +49,7 @@ Properties {{#each properties}} -- {{> property-nested this}} +{{> property-nested this isLast=@last}} {{/each}} diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs index 174e0f618..9bf5f9834 100644 --- a/src/layouts/partials/property-collapsible.hbs +++ b/src/layouts/partials/property-collapsible.hbs @@ -3,3 +3,8 @@ {{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{> property-content}} +{{#unless isLast}} + +--- +{{/unless}} + From 451070a273e3e29c1fddda421246319167e53d01 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 23 May 2025 09:32:15 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/api/_blueprint.json | 32 +- docs/api/access_codes/README.md | 324 ++++++------------ docs/api/access_codes/unmanaged/README.md | 96 ++---- docs/api/acs/access_groups/README.md | 24 +- docs/api/acs/credentials/README.md | 96 ++---- docs/api/acs/encoders/README.md | 48 +-- docs/api/acs/entrances/README.md | 48 +-- docs/api/acs/systems/README.md | 63 ++-- docs/api/acs/users/README.md | 48 +-- docs/api/phones/README.md | 18 +- docs/api/thermostats/README.md | 210 ++++-------- .../enrollment_automations/README.md | 18 +- 12 files changed, 347 insertions(+), 678 deletions(-) diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index c55edd3c6..1006fef2f 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -9423,7 +9423,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) for which you want to create a client session.", + "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9640,7 +9640,7 @@ "parameters": [ { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session (or that are already associated with the existing client session).", + "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9726,7 +9726,7 @@ "title": "Grant Access to a Client Session", "name": "grant_access", "path": "/client_sessions/grant_access", - "description": "Grants a [client session](../core-concepts/authentication/client-session-tokens/README.md) access to one or more resources, such as [Connect Webviews](../core-concepts/connect-webviews/README.md), [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.", + "description": "Grants a [client session](../core-concepts/authentication/client-session-tokens/README.md) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](../capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities.md#what-is-a-user-identity), and so on.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -9761,7 +9761,7 @@ }, { "name": "connect_webview_ids", - "description": "IDs of the [Connect Webviews](../core-concepts/connect-webviews/README.md) that you want to associate with the client session.", + "description": "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9868,7 +9868,7 @@ }, { "name": "connect_webview_id", - "description": "ID of the [Connect Webview](../core-concepts/connect-webviews/README.md) for which you want to retrieve client sessions.", + "description": "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -9993,7 +9993,7 @@ "title": "Create a Connect Webview", "name": "create", "path": "/connect_webviews/create", - "description": "Creates a new [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](../core-concepts/connect-webviews/connect-webview-process.md).", + "description": "Creates a new [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](https://docs.seam.co/latest/core-concepts/connect-webviews/connect-webview-process).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10015,7 +10015,7 @@ "parameters": [ { "name": "accepted_providers", - "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.", + "description": "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10532,7 +10532,7 @@ }, { "name": "automatically_manage_new_devices", - "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md). See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", + "description": "Indicates whether newly-added devices should appear as [managed devices](../core-concepts/devices/managed-and-unmanaged-devices.md). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10547,7 +10547,7 @@ }, { "name": "custom_metadata", - "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](../core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview.md) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](../core-concepts/connected-accounts/README.md) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](../core-concepts/workspaces/README.md). You can also [filter Connect Webviews by custom metadata](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md).", + "description": "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](../core-concepts/connected-accounts/README.md) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](../core-concepts/workspaces/README.md). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10711,7 +10711,7 @@ }, { "name": "wait_for_device_creation", - "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-behavior-settings-of-your-connect-webviews).", + "description": "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -10739,7 +10739,7 @@ "title": "Delete a Connect Webview", "name": "delete", "path": "/connect_webviews/delete", - "description": "Deletes a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", + "description": "Deletes a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10785,7 +10785,7 @@ "title": "Get a Connect Webview", "name": "get", "path": "/connect_webviews/get", - "description": "Returns a specified [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", + "description": "Returns a specified [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10834,7 +10834,7 @@ "title": "List Connect Webviews", "name": "list", "path": "/connect_webviews/list", - "description": "Returns a list of all [Connect Webviews](../core-concepts/connect-webviews/README.md).", + "description": "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -10856,7 +10856,7 @@ "parameters": [ { "name": "custom_metadata_has", - "description": "Custom metadata pairs by which you want to [filter Connect Webviews](../core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", + "description": "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -12963,7 +12963,7 @@ "title": "List Device Providers", "name": "list_device_providers", "path": "/devices/list_device_providers", - "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](../capability-guides/device-and-system-capabilities.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](../core-concepts/connect-webviews/README.md), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](../core-concepts/connect-webviews/customizing-connect-webviews.md#customize-the-brands-to-display-in-your-connect-webviews).", + "description": "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](../capability-guides/device-and-system-capabilities/README.md#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -40223,7 +40223,7 @@ "jsonType": "string" } ], - "description": "Represents a [Connect Webview](../core-concepts/connect-webviews/README.md).\n\nConnect 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.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", + "description": "Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect 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.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.", "isDeprecated": false, "routePath": "/connect_webviews", "deprecationMessage": "", diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 6b8a02a8e..897cb0f3c 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -2573,45 +2573,37 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.created` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -2624,45 +2616,37 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.changed` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -2675,50 +2659,41 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- code String +code String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.scheduled_on_device` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -2731,50 +2706,41 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- code String +code String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.set_on_device` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -2787,45 +2753,37 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.removed_from_device` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -2838,45 +2796,37 @@ There was an unusually long delay in setting an [access code](https://docs.seam. Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.delay_in_setting_on_device` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -2889,45 +2839,37 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.failed_to_set_on_device` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -2940,50 +2882,41 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- code String +code String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.deleted` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -2996,45 +2929,37 @@ There was an unusually long delay in removing an [access code](https://docs.seam Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.delay_in_removing_from_device` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -3047,45 +2972,37 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.failed_to_remove_from_device` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -3098,45 +3015,37 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.modified_external_to_seam` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -3149,45 +3058,37 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.deleted_external_to_seam` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -3200,48 +3101,39 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). +backup_access_code_id String -- backup_access_code_id String - - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.backup_access_code_pulled` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index c59c504ef..968b402bd 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -2483,45 +2483,37 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.unmanaged.converted_to_managed` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -2534,45 +2526,37 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.unmanaged.failed_to_convert_to_managed` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -2585,45 +2569,37 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.unmanaged.created` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -2636,45 +2612,37 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l Properties -- access_code_id UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `access_code.unmanaged.removed` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index c0a3cfe1b..4407518a0 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -197,43 +197,35 @@ An ACS access group was deleted. Properties -- acs_access_group_id UUID +acs_access_group_id UUID - -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_access_group.deleted` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 4be7db332..9b3415dfe 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -603,43 +603,35 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia Properties -- acs_credential_id UUID +acs_credential_id UUID - -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_credential.deleted` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -652,43 +644,35 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia Properties -- acs_credential_id UUID +acs_credential_id UUID - -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_credential.issued` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -701,43 +685,35 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia Properties -- acs_credential_id UUID +acs_credential_id UUID - -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_credential.reissued` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -750,43 +726,35 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia Properties -- acs_credential_id UUID +acs_credential_id UUID - -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_credential.invalidated` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 2de3bb472..22c3d942f 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -124,45 +124,37 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc Properties -- acs_encoder_id UUID +acs_encoder_id UUID ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_encoder.added` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -175,45 +167,37 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc Properties -- acs_encoder_id UUID +acs_encoder_id UUID ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_encoder.removed` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 6010a7867..6c255f3c0 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -257,43 +257,35 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra Properties -- acs_entrance_id UUID +acs_entrance_id UUID - -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_entrance.added` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -306,43 +298,35 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra Properties -- acs_entrance_id UUID +acs_entrance_id UUID - -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_entrance.removed` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index b22d6ddc0..7943174e6 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -805,40 +805,33 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa Properties -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_system.connected` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -851,40 +844,33 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa Properties -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_system.added` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -897,40 +883,33 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa Properties -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_system.disconnected` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index c5528a6a8..fa8105570 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -905,43 +905,35 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user- Properties -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). +acs_user_id UUID -- acs_user_id UUID - - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_user.created` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- @@ -954,43 +946,35 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user- Properties -- acs_system_id UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). +acs_user_id UUID -- acs_user_id UUID - - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `acs_user.deleted` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index e39a8bcff..4ffddc72c 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -184,35 +184,29 @@ A phone device was deactivated. Properties -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `phone.deactivated` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index cbaaf314f..70eb19995 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -11,55 +11,45 @@ A thermostat [climate preset](../../capability-guides/thermostats/creating-and-m Properties -- climate_preset_key String +climate_preset_key String Key of the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated. - -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the device. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `thermostat.climate_preset_activated` - -- is_fallback_climate_preset Boolean +is_fallback_climate_preset Boolean Indicates whether the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) that was activated is the [fallback climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) for the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- thermostat_schedule_id UUID +thermostat_schedule_id UUID ID of the [thermostat schedule](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that prompted the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to be activated. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -72,42 +62,35 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad Properties -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- cooling_set_point_celsius Number +cooling_set_point_celsius Number Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). - -- cooling_set_point_fahrenheit Number +cooling_set_point_fahrenheit Number Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the device. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `thermostat.manually_adjusted` - -- fan_mode_setting Enum +fan_mode_setting Enum 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`.
@@ -118,18 +101,15 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad - circulate`
- -- heating_set_point_celsius Number +heating_set_point_celsius Number Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). - -- heating_set_point_fahrenheit Number +heating_set_point_fahrenheit Number Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). - -- hvac_mode_setting Enum +hvac_mode_setting Enum Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
@@ -141,8 +121,7 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad - heat_cool`
- -- method Enum +method Enum Method used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
@@ -152,16 +131,13 @@ A [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) was ad - external`
- -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -174,70 +150,57 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp Properties -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the device. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `thermostat.temperature_threshold_exceeded` - -- lower_limit_celsius Number +lower_limit_celsius Number Lower temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). - -- lower_limit_fahrenheit Number +lower_limit_fahrenheit Number Lower temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- temperature_celsius Number +temperature_celsius Number Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -- temperature_fahrenheit Number +temperature_fahrenheit Number Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -- upper_limit_celsius Number +upper_limit_celsius Number Upper temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). - -- upper_limit_fahrenheit Number +upper_limit_fahrenheit Number Upper temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -250,70 +213,57 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp Properties -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the device. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `thermostat.temperature_threshold_no_longer_exceeded` - -- lower_limit_celsius Number +lower_limit_celsius Number Lower temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). - -- lower_limit_fahrenheit Number +lower_limit_fahrenheit Number Lower temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- temperature_celsius Number +temperature_celsius Number Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -- temperature_fahrenheit Number +temperature_fahrenheit Number Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -- upper_limit_celsius Number +upper_limit_celsius Number Upper temperature limit, in °C, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). - -- upper_limit_fahrenheit Number +upper_limit_fahrenheit Number Upper temperature limit, in °F, defined by the set [threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md). - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -326,60 +276,49 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) temp Properties -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- desired_temperature_celsius Number +desired_temperature_celsius Number Desired temperature, in °C, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). - -- desired_temperature_fahrenheit Number +desired_temperature_fahrenheit Number Desired temperature, in °F, defined by the [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) cooling or heating [set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). - -- device_id UUID +device_id UUID ID of the device. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `thermostat.temperature_reached_set_point` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- temperature_celsius Number +temperature_celsius Number Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -- temperature_fahrenheit Number +temperature_fahrenheit Number Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- @@ -392,50 +331,41 @@ A [thermostat's](https://docs.seam.co/latest/capability-guides/thermostats) repo Properties -- connected_account_id UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md). - -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- device_id UUID +device_id UUID ID of the device. - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `thermostat.temperature_changed` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- temperature_celsius Number +temperature_celsius Number Temperature, in °C, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -- temperature_fahrenheit Number +temperature_fahrenheit Number Temperature, in °F, reported by the [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md). - --- diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index b4ddb81b1..252a94299 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -84,35 +84,29 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi Properties -- created_at Datetime +created_at Datetime Date and time at which the event was created. - -- enrollment_automation_id UUID +enrollment_automation_id UUID ID of the [enrollment automation](../../../capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system.md#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut). - -- event_id UUID +event_id UUID ID of the event. - -- event_type Enum +event_type Enum Value: `enrollment_automation.deleted` - -- occurred_at Datetime +occurred_at Datetime Date and time at which the event occurred. - -- workspace_id UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md). - ---