From 8f38a564b9a1ac08e4893bcca50b75407b86745e Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Wed, 14 May 2025 15:16:26 +0200 Subject: [PATCH 1/2] Enable connected accounts gen --- src/data/paths.yaml | 5 +++++ src/lib/reference.ts | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 4b9238aaa..3c9886fac 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -80,3 +80,8 @@ title: Enrollment Automations resources: - enrollment_automation + +/connected_accounts: + title: Connected Accounts + resources: + - connected_account diff --git a/src/lib/reference.ts b/src/lib/reference.ts index adae39a57..3aac50405 100644 --- a/src/lib/reference.ts +++ b/src/lib/reference.ts @@ -57,7 +57,8 @@ export const reference = ( !route.path.startsWith('/acs') && !route.path.startsWith('/thermostats') && !route.path.startsWith('/phones') && - !route.path.startsWith('/user_identities') + !route.path.startsWith('/user_identities') && + !route.path.startsWith('/connected_accounts') ) { continue } From 1cf7913fb6136287b7177f65a09ff1a674ac6c26 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 14 May 2025 13:17:46 +0000 Subject: [PATCH 2/2] ci: Generate docs --- docs/api/_report.md | 1 - docs/api/connected_accounts/README.md | 725 ++++++++++++++++++++++++++ 2 files changed, 725 insertions(+), 1 deletion(-) create mode 100644 docs/api/connected_accounts/README.md diff --git a/docs/api/_report.md b/docs/api/_report.md index 327adc94d..90cc2cd7a 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -11,7 +11,6 @@ - `/bridges` - `/client_sessions` - `/connect_webviews` -- `/connected_accounts` - `/devices` - `/devices/simulate` - `/devices/unmanaged` diff --git a/docs/api/connected_accounts/README.md b/docs/api/connected_accounts/README.md new file mode 100644 index 000000000..a7f4c7d5e --- /dev/null +++ b/docs/api/connected_accounts/README.md @@ -0,0 +1,725 @@ +# Connected Accounts + +## `connected_account` + +### `account_type` + +Format: `String` + +--- + +### `account_type_display_name` + +Format: `String` + +--- + +### `automatically_manage_new_devices` + +Format: `Boolean` + +--- + +### `connected_account_id` + +Format: `UUID` + +--- + +### `created_at` + +Format: `Datetime` + +--- + +### `custom_metadata` + +Format: `Record` + +--- + +### [`errors`](./#errors-1) + +Format: `List` + +Item format: `Object` + +The specific structure of each object in this list depends on the value of its `error_code` field. + +Variants: +
+account_disconnected + +Account is disconnected. + +**`created_at`** +Format: `Datetime` + + +Date and time at which Seam created the error. + +--- + +**`error_code`** +Format: `Enum` + + +Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + +Possible enum values: +- `account_disconnected` + +--- + +**`is_bridge_error`** +Format: `Boolean` + + +--- + +**`is_connected_account_error`** +Format: `Boolean` + + +--- + +**`message`** +Format: `String` + + +
+
+invalid_credentials + +Credentials provided were invalid. + +**`created_at`** +Format: `Datetime` + + +Date and time at which Seam created the error. + +--- + +**`error_code`** +Format: `Enum` + + +Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + +Possible enum values: +- `invalid_credentials` + +--- + +**`is_bridge_error`** +Format: `Boolean` + + +--- + +**`is_connected_account_error`** +Format: `Boolean` + + +--- + +**`message`** +Format: `String` + + +
+
+bridge_disconnected + +Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). + +**`created_at`** +Format: `Datetime` + + +Date and time at which Seam created the error. + +--- + +**`error_code`** +Format: `Enum` + + +Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + +Possible enum values: +- `bridge_disconnected` + +--- + +**`is_bridge_error`** +Format: `Boolean` + + +--- + +**`is_connected_account_error`** +Format: `Boolean` + + +--- + +**`message`** +Format: `String` + + +
+
+salto_ks_subscription_limit_exceeded + +Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. + +**`created_at`** +Format: `Datetime` + + +Date and time at which Seam created the error. + +--- + +**`error_code`** +Format: `Enum` + + +Unique identifier of the type of error. Enables quick recognition and categorization of the issue. + +Possible enum values: +- `salto_ks_subscription_limit_exceeded` + +--- + +**`is_bridge_error`** +Format: `Boolean` + + +--- + +**`is_connected_account_error`** +Format: `Boolean` + + +--- + +**`message`** +Format: `String` + + +--- + +**`salto_ks_metadata`** +Format: `Object` + + +
+ +--- + +### `user_identifier` + +Format: `Object` + +
+ +api_url Format: String +
+ +
+ +email Format: String +
+ +
+ +exclusive Format: Boolean +
+ +
+ +phone Format: String +
+ +
+ +username Format: String +
+ +--- + +### [`warnings`](./#warnings-1) + +Format: `List` + +Item format: `Object` + +The specific structure of each object in this list depends on the value of its `warning_code` field. + +Variants: +
+scheduled_maintenance_window + +Scheduled downtime for account planned. + +**`created_at`** +Format: `Datetime` + + +Date and time at which Seam created the warning. + +--- + +**`message`** +Format: `String` + + +--- + +**`warning_code`** +Format: `Enum` + + +Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + +Possible enum values: +- `scheduled_maintenance_window` + +
+
+unknown_issue_with_connected_account + +An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account. + +**`created_at`** +Format: `Datetime` + + +Date and time at which Seam created the warning. + +--- + +**`message`** +Format: `String` + + +--- + +**`warning_code`** +Format: `Enum` + + +Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + +Possible enum values: +- `unknown_issue_with_connected_account` + +
+
+salto_ks_subscription_limit_almost_reached + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. + +**`created_at`** +Format: `Datetime` + + +Date and time at which Seam created the warning. + +--- + +**`message`** +Format: `String` + + +--- + +**`salto_ks_metadata`** +Format: `Object` + + +--- + +**`warning_code`** +Format: `Enum` + + +Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + +Possible enum values: +- `salto_ks_subscription_limit_almost_reached` + +
+ +--- + +## Errors + +### `account_disconnected` + +Account is disconnected. + +--- + +### `invalid_credentials` + +Credentials provided were invalid. + +--- + +### `bridge_disconnected` + +Indicates that the Seam API cannot communicate with [Seam Bridge](../../capability-guides/seam-bridge.md), for example, if Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. + See also [Troubleshooting Your Access Control System](../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). + +--- + +### `salto_ks_subscription_limit_exceeded` + +Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. + +--- + +## Warnings + +### `scheduled_maintenance_window` + +Scheduled downtime for account planned. + +--- + +### `unknown_issue_with_connected_account` + +An unknown issue occurred while syncing the state of this connected account with the provider. This issue may affect the proper functioning of one or more resources in this account. + +--- + +### `salto_ks_subscription_limit_almost_reached` + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. + +--- + +## Endpoints + + +--- + +## Events + +### `connected_account.connected` + +A [connected account](../../core-concepts/connected-accounts/README.md) was connected for the first time or was reconnected after being disconnected. + +
+ +connect_webview_id Format: UUID + +ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). +
+
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). +
+
+ +created_at Format: Datetime + +Date and time at which the event was created. +
+
+ +event_id Format: UUID + +ID of the event. +
+
+ +event_type Format: Enum + +Value: `connected_account.connected` +
+
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. +
+
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). +
+--- + +### `connected_account.created` + +A [connected account](../../core-concepts/connected-accounts/README.md) was created. + +
+ +connect_webview_id Format: UUID + +ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). +
+
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). +
+
+ +created_at Format: Datetime + +Date and time at which the event was created. +
+
+ +event_id Format: UUID + +ID of the event. +
+
+ +event_type Format: Enum + +Value: `connected_account.created` +
+
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. +
+
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). +
+--- + +### `connected_account.successful_login` + +A [connected account](../../core-concepts/connected-accounts/README.md) had a successful login using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). + +
+ +connect_webview_id Format: UUID + +ID of the [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). +
+
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). +
+
+ +created_at Format: Datetime + +Date and time at which the event was created. +
+
+ +event_id Format: UUID + +ID of the event. +
+
+ +event_type Format: Enum + +Value: `connected_account.successful_login` +
+
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. +
+
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). +
+--- + +### `connected_account.disconnected` + +A [connected account](../../core-concepts/connected-accounts/README.md) was disconnected. + +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). +
+
+ +created_at Format: Datetime + +Date and time at which the event was created. +
+
+ +event_id Format: UUID + +ID of the event. +
+
+ +event_type Format: Enum + +Value: `connected_account.disconnected` +
+
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. +
+
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). +
+--- + +### `connected_account.completed_first_sync` + +A [connected account](../../core-concepts/connected-accounts/README.md) completed the first sync with Seam, and the corresponding devices or systems are now available. + +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). +
+
+ +created_at Format: Datetime + +Date and time at which the event was created. +
+
+ +event_id Format: UUID + +ID of the event. +
+
+ +event_type Format: Enum + +Value: `connected_account.completed_first_sync` +
+
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. +
+
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). +
+--- + +### `connected_account.deleted` + +A [connected account](../../core-concepts/connected-accounts/README.md) was deleted. + +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). +
+
+ +created_at Format: Datetime + +Date and time at which the event was created. +
+
+ +event_id Format: UUID + +ID of the event. +
+
+ +event_type Format: Enum + +Value: `connected_account.deleted` +
+
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. +
+
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). +
+--- + +### `connected_account.completed_first_sync_after_reconnection` + +A [connected account](../../core-concepts/connected-accounts/README.md) completed the first sync after reconnection with Seam, and the corresponding devices or systems are now available. + +
+ +connected_account_id Format: UUID + +ID of the [connected account](../../core-concepts/connected-accounts/README.md). +
+
+ +created_at Format: Datetime + +Date and time at which the event was created. +
+
+ +event_id Format: UUID + +ID of the event. +
+
+ +event_type Format: Enum + +Value: `connected_account.completed_first_sync_after_reconnection` +
+
+ +occurred_at Format: Datetime + +Date and time at which the event occurred. +
+
+ +workspace_id Format: UUID + +ID of the [workspace](../../core-concepts/workspaces/README.md). +
+--- +