From 71d85bf07909c97bee1a24685bc5e95eed2b51d4 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 13:57:43 -0400 Subject: [PATCH 001/233] Change namespace layout slightly --- src/layouts/api-namespace.hbs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/layouts/api-namespace.hbs b/src/layouts/api-namespace.hbs index 49d72cada..6a180bf4f 100644 --- a/src/layouts/api-namespace.hbs +++ b/src/layouts/api-namespace.hbs @@ -2,12 +2,14 @@ description: {{description}} --- -# {{title}} +# The {{title}} Namespace {{overview}} ## Resources +The {{title}} namespace contains the following resources: + {{#each resources}} ### [`{{name}}`]({{link}}) {{description}} From 0b2e0afa9ead1881637ff351971138587689a8e9 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 17:58:42 +0000 Subject: [PATCH 002/233] ci: Generate docs --- docs/api/acs/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index 4767e017d..3b0a758e2 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# Access Control Systems +# The Access Control Systems Namespace Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: @@ -21,6 +21,8 @@ To grant access using the Seam access control system API, use the following basi ## Resources +The Access Control Systems namespace contains the following resources: + ### [`acs_system`](./systems/README.md#acs_system) Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). From 5e61d46d12ae6c7ba80562ffae196686443759fc Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:01:49 -0400 Subject: [PATCH 003/233] Update api-namespace.hbs --- src/layouts/api-namespace.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/api-namespace.hbs b/src/layouts/api-namespace.hbs index 6a180bf4f..16e7e1147 100644 --- a/src/layouts/api-namespace.hbs +++ b/src/layouts/api-namespace.hbs @@ -2,7 +2,7 @@ description: {{description}} --- -# The {{title}} Namespace +# {{title}} {{overview}} From 03d7d3353c09662894b618d765292fdfa08b2162 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:03:13 +0000 Subject: [PATCH 004/233] ci: Generate docs --- docs/api/acs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index 3b0a758e2..8aaecca62 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# The Access Control Systems Namespace +# Access Control Systems Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: From 064022d0a5bfdc77224e58b68ac7b9303902f635 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:05:57 -0400 Subject: [PATCH 005/233] Update api-route.hbs --- src/layouts/api-route.hbs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 5274b67df..7a9c877c9 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -1,5 +1,7 @@ # {{title}} +The {{title}} route contains the following resources: + {{#each resources}} {{> api-resource this}} {{#if errors.length}} From 888505a8faeff9ea499f319221d666a6e703090b Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:06:59 +0000 Subject: [PATCH 006/233] ci: Generate docs --- docs/api/acs/access_groups/README.md | 2 ++ docs/api/acs/credentials/README.md | 2 ++ docs/api/acs/encoders/README.md | 2 ++ docs/api/acs/encoders/simulate/README.md | 2 ++ docs/api/acs/entrances/README.md | 2 ++ docs/api/acs/systems/README.md | 2 ++ docs/api/acs/users/README.md | 2 ++ docs/api/phones/README.md | 2 ++ docs/api/phones/simulate/README.md | 2 ++ docs/api/thermostats/README.md | 2 ++ docs/api/thermostats/schedules/README.md | 2 ++ docs/api/thermostats/simulate/README.md | 2 ++ docs/api/user_identities/README.md | 2 ++ docs/api/user_identities/enrollment_automations/README.md | 2 ++ 14 files changed, 28 insertions(+) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index afbc61aa0..09867517e 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -1,5 +1,7 @@ # Access Groups +The Access Groups route contains the following resources: + ## `acs_access_group` 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. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 564bcd036..236193c90 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -1,5 +1,7 @@ # Credentials +The Credentials route contains the following resources: + ## `acs_credential` Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index c1e2997f2..7f49da5a8 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -1,5 +1,7 @@ # Encoders +The Encoders route contains the following resources: + ## `acs_encoder` Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index adf033739..903e4e935 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -1,5 +1,7 @@ # Encoder Simulations +The Encoder Simulations route contains the following resources: + ## Endpoints ### [`/acs/encoders/simulate/next_credential_encode_will_fail`](./next_credential_encode_will_fail.md) diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 026a4352c..ce0feedd4 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -1,5 +1,7 @@ # Entrances +The Entrances route contains the following resources: + ## `acs_entrance` Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 240f75036..b5359816b 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -1,5 +1,7 @@ # Systems +The Systems route contains the following resources: + ## `acs_system` Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 248661f43..4a04b38cb 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -1,5 +1,7 @@ # ACS Users +The ACS Users route contains the following resources: + ## `acs_user` Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 3028245cb..350b97e41 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -1,5 +1,7 @@ # Phones +The Phones route contains the following resources: + ## `phone` Represents an app user's mobile phone. diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index e361df769..0e26ab5a1 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -1,5 +1,7 @@ # Phone Simulations +The Phone Simulations route contains the following resources: + ## Endpoints ### [`/phones/simulate/create_sandbox_phone`](./create_sandbox_phone.md) diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index 66d5e32cc..fca49b1bc 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -1,5 +1,7 @@ # Thermostats +The Thermostats route contains the following resources: + ## Endpoints ### [`/thermostats/activate_climate_preset`](./activate_climate_preset.md) diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 48b777e4f..794091e4b 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -1,5 +1,7 @@ # Thermostat Schedules +The Thermostat Schedules route contains the following resources: + ## `thermostat_schedule` Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index 55ddf5a83..51f7e82e7 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -1,5 +1,7 @@ # Thermostat Simulations +The Thermostat Simulations route contains the following resources: + ## Endpoints ### [`/thermostats/simulate/hvac_mode_adjusted`](./hvac_mode_adjusted.md) diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 1ef7a3ddf..602814b4b 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -1,5 +1,7 @@ # User Identities +The User Identities route contains the following resources: + ## `user_identity` Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index f27a87236..890683324 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -1,5 +1,7 @@ # Enrollment Automations +The Enrollment Automations route contains the following resources: + ## `enrollment_automation` Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). From e2b0275e439e5ec3da0df497dbf7acaaa4a9e807 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:08:34 -0400 Subject: [PATCH 007/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 86205b416..8897755d3 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -1,13 +1,19 @@ {{#if headingOffset}} -### `{{name}}` +### The `{{name}}` Resource {{else}} -## `{{name}}` +## The `{{name}}` Resource {{/if}} {{#if description}} {{description}} {{/if}} +{{#if headingOffset}} +#### Properties +{{else}} +## Properties +{{/if}} + {{#each properties}} {{#if ../headingOffset}} #### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} From b40e4ed938b488e715071098aa1d5cb7c1c021ae Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:09:33 +0000 Subject: [PATCH 008/233] ci: Generate docs --- docs/api/acs/access_groups/README.md | 4 +++- docs/api/acs/credentials/README.md | 4 +++- docs/api/acs/encoders/README.md | 4 +++- docs/api/acs/encoders/encode_credential.md | 4 +++- docs/api/acs/encoders/scan_credential.md | 4 +++- docs/api/acs/entrances/README.md | 4 +++- docs/api/acs/systems/README.md | 4 +++- docs/api/acs/users/README.md | 4 +++- docs/api/phones/README.md | 4 +++- docs/api/thermostats/activate_climate_preset.md | 4 +++- docs/api/thermostats/cool.md | 4 +++- docs/api/thermostats/heat.md | 4 +++- docs/api/thermostats/heat_cool.md | 4 +++- docs/api/thermostats/off.md | 4 +++- docs/api/thermostats/schedules/README.md | 4 +++- docs/api/thermostats/set_fan_mode.md | 4 +++- docs/api/thermostats/set_hvac_mode.md | 4 +++- docs/api/user_identities/README.md | 4 +++- docs/api/user_identities/enrollment_automations/README.md | 4 +++- 19 files changed, 57 insertions(+), 19 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 09867517e..b03ebddae 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -2,11 +2,13 @@ The Access Groups route contains the following resources: -## `acs_access_group` +## The `acs_access_group` Resource 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. The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +## Properties + ### `access_group_type` {% hint style="warning" %} diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 236193c90..18756514c 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -2,10 +2,12 @@ The Credentials route contains the following resources: -## `acs_credential` +## The `acs_credential` Resource Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. +## Properties + ### `access_method` Format: `Enum` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 7f49da5a8..90948c79d 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -2,10 +2,12 @@ The Encoders route contains the following resources: -## `acs_encoder` +## The `acs_encoder` Resource Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). +## Properties + ### `acs_encoder_id` Format: `UUID` diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 4ff61ba93..36a2096f1 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -36,10 +36,12 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. [action\_attempt](./) -### `ENCODE_CREDENTIAL` +### The `ENCODE_CREDENTIAL` Resource Encoding credential data from physical encoder. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index cbe3e050d..91078e1d8 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -27,10 +27,12 @@ ID of the `acs_encoder` to use for the scan. [action\_attempt](./) -### `SCAN_CREDENTIAL` +### The `SCAN_CREDENTIAL` Resource Reading credential data from physical encoder. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index ce0feedd4..447d43527 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -2,10 +2,12 @@ The Entrances route contains the following resources: -## `acs_entrance` +## The `acs_entrance` Resource Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +## Properties + ### `acs_entrance_id` Format: `UUID` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index b5359816b..55c80b1b1 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -2,10 +2,12 @@ The Systems route contains the following resources: -## `acs_system` +## The `acs_system` Resource Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +## Properties + ### `acs_system_id` Format: `UUID` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 4a04b38cb..3685eb873 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -2,10 +2,12 @@ The ACS Users route contains the following resources: -## `acs_user` +## The `acs_user` Resource Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +## Properties + ### `access_schedule` Format: `Object` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 350b97e41..fc7b8b5b0 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -2,10 +2,12 @@ The Phones route contains the following resources: -## `phone` +## The `phone` Resource Represents an app user's mobile phone. +## Properties + ### `created_at` Format: `Datetime` diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 5b931e56a..3581cf675 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -168,10 +168,12 @@ ID of the desired thermostat device. [action\_attempt](./) -### `ACTIVATE_CLIMATE_PRESET` +### The `ACTIVATE_CLIMATE_PRESET` Resource Activating climate preset. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 182fc93ca..e5eeb887a 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -178,10 +178,12 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 44c9ad73f..e94c92dfe 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -178,10 +178,12 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 6003f60cc..e45bed8d1 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -202,10 +202,12 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index b5b824710..b5d29835a 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -150,10 +150,12 @@ ID of the desired thermostat device. [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 794091e4b..d368f6887 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -2,10 +2,12 @@ The Thermostat Schedules route contains the following resources: -## `thermostat_schedule` +## The `thermostat_schedule` Resource Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. +## Properties + ### `climate_preset_key` Format: `String` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index bdf5e7d33..cbc03d518 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -178,10 +178,12 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos [action\_attempt](./) -### `SET_FAN_MODE` +### The `SET_FAN_MODE` Resource Setting fan mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 64185341f..0619e31be 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -216,10 +216,12 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### `SET_HVAC_MODE` +### The `SET_HVAC_MODE` Resource Setting HVAC mode. +#### Properties + #### `action_attempt_id` Format: `UUID` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 602814b4b..0655fc022 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -2,10 +2,12 @@ The User Identities route contains the following resources: -## `user_identity` +## The `user_identity` Resource Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. +## Properties + ### `created_at` Format: `Datetime` diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 890683324..0b1a2b65e 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -2,10 +2,12 @@ The Enrollment Automations route contains the following resources: -## `enrollment_automation` +## The `enrollment_automation` Resource Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). +## Properties + ### `created_at` Format: `Datetime` From 1373b454bfabb1a4b497817967b5a3dcb9631691 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:25:11 -0400 Subject: [PATCH 009/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 8897755d3..eebb7080d 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -8,7 +8,7 @@ {{description}} {{/if}} -{{#if headingOffset}} +{{#if ../headingOffset}} #### Properties {{else}} ## Properties @@ -16,9 +16,9 @@ {{#each properties}} {{#if ../headingOffset}} -#### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} +##### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} {{else}} -### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} +#### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} {{/if}} {{#if isDeprecated}} From e05c000960315dcd1afb996d00d3def8ba45e3c7 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:26:11 +0000 Subject: [PATCH 010/233] ci: Generate docs --- docs/api/acs/access_groups/README.md | 24 ++++----- docs/api/acs/credentials/README.md | 52 +++++++++---------- docs/api/acs/encoders/README.md | 12 ++--- docs/api/acs/encoders/encode_credential.md | 12 ++--- docs/api/acs/encoders/scan_credential.md | 12 ++--- docs/api/acs/entrances/README.md | 22 ++++---- docs/api/acs/systems/README.md | 44 ++++++++-------- docs/api/acs/users/README.md | 42 +++++++-------- docs/api/phones/README.md | 20 +++---- .../thermostats/activate_climate_preset.md | 12 ++--- docs/api/thermostats/cool.md | 12 ++--- docs/api/thermostats/heat.md | 12 ++--- docs/api/thermostats/heat_cool.md | 12 ++--- docs/api/thermostats/off.md | 12 ++--- docs/api/thermostats/schedules/README.md | 18 +++---- docs/api/thermostats/set_fan_mode.md | 12 ++--- docs/api/thermostats/set_hvac_mode.md | 12 ++--- docs/api/user_identities/README.md | 16 +++--- .../enrollment_automations/README.md | 10 ++-- 19 files changed, 184 insertions(+), 184 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index b03ebddae..175433c8f 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -9,7 +9,7 @@ The `acs_access_group` object represents an [access group](https://docs.seam.co/ ## Properties -### `access_group_type` +#### `access_group_type` {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -27,7 +27,7 @@ Possible enum values: --- -### `access_group_type_display_name` +#### `access_group_type_display_name` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -37,7 +37,7 @@ Format: `String` --- -### `acs_access_group_id` +#### `acs_access_group_id` Format: `UUID` @@ -45,7 +45,7 @@ ID of the access group. --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -53,7 +53,7 @@ ID of the access control system that contains the access group. --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -61,13 +61,13 @@ Date and time at which the access group was created. --- -### `display_name` +#### `display_name` Format: `String` --- -### `external_type` +#### `external_type` Format: `Enum` @@ -83,7 +83,7 @@ Possible enum values: --- -### `external_type_display_name` +#### `external_type_display_name` Format: `String` @@ -91,13 +91,13 @@ Display name that corresponds to the brand-specific terminology for the access g --- -### `is_managed` +#### `is_managed` Format: `Boolean` --- -### `name` +#### `name` Format: `String` @@ -105,7 +105,7 @@ Name of the access group. --- -### `warnings` +#### `warnings` Format: `List` @@ -139,7 +139,7 @@ Unique identifier of the type of warning. Enables quick recognition and categori --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 18756514c..e762fdbae 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -8,7 +8,7 @@ Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/acces ## Properties -### `access_method` +#### `access_method` Format: `Enum` @@ -21,7 +21,7 @@ Possible enum values: --- -### `acs_credential_id` +#### `acs_credential_id` Format: `UUID` @@ -29,13 +29,13 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden --- -### `acs_credential_pool_id` +#### `acs_credential_pool_id` Format: `UUID` --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -43,7 +43,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `acs_user_id` +#### `acs_user_id` Format: `UUID` @@ -51,7 +51,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system --- -### `assa_abloy_vostio_metadata` +#### `assa_abloy_vostio_metadata` Format: `Object` @@ -89,7 +89,7 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- --- -### `card_number` +#### `card_number` Format: `String` @@ -97,7 +97,7 @@ Number of the card associated with the [credential](../../../capability-guides/a --- -### `code` +#### `code` Format: `String` @@ -105,7 +105,7 @@ Access (PIN) code for the [credential](../../../capability-guides/access-systems --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -113,7 +113,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -### `display_name` +#### `display_name` Format: `String` @@ -121,7 +121,7 @@ Display name that corresponds to the [credential](../../../capability-guides/acc --- -### `ends_at` +#### `ends_at` Format: `String` @@ -129,7 +129,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -### `errors` +#### `errors` Format: `List` @@ -151,7 +151,7 @@ Errors associated with the [credential](../../../capability-guides/access-system --- -### `external_type` +#### `external_type` Format: `Enum` @@ -168,7 +168,7 @@ Possible enum values: --- -### `external_type_display_name` +#### `external_type_display_name` Format: `String` @@ -176,7 +176,7 @@ Display name that corresponds to the brand-specific terminology for the [credent --- -### `is_issued` +#### `is_issued` Format: `Boolean` @@ -184,7 +184,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -### `is_latest_desired_state_synced_with_provider` +#### `is_latest_desired_state_synced_with_provider` Format: `Boolean` @@ -192,13 +192,13 @@ Indicates whether the latest state of the [credential](../../../capability-guide --- -### `is_managed` +#### `is_managed` Format: `Boolean` --- -### `is_multi_phone_sync_credential` +#### `is_multi_phone_sync_credential` Format: `Boolean` @@ -206,7 +206,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -### `is_one_time_use` +#### `is_one_time_use` Format: `Boolean` @@ -214,7 +214,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -### `issued_at` +#### `issued_at` Format: `Datetime` @@ -222,7 +222,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -### `latest_desired_state_synced_with_provider_at` +#### `latest_desired_state_synced_with_provider_at` Format: `Datetime` @@ -230,7 +230,7 @@ Date and time at which the state of the [credential](../../../capability-guides/ --- -### `parent_acs_credential_id` +#### `parent_acs_credential_id` Format: `UUID` @@ -238,7 +238,7 @@ ID of the parent [credential](../../../capability-guides/access-systems/managing --- -### `starts_at` +#### `starts_at` Format: `String` @@ -246,7 +246,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -### `visionline_metadata` +#### `visionline_metadata` Format: `Object` @@ -306,7 +306,7 @@ Possible enum values: --- -### [`warnings`](./#warnings-1) +#### [`warnings`](./#warnings-1) Format: `List` @@ -316,7 +316,7 @@ Warnings associated with the [credential](../../../capability-guides/access-syst --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 90948c79d..ea4a0607f 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -8,7 +8,7 @@ Represents a hardware device that encodes [credential](../../../capability-guide ## Properties -### `acs_encoder_id` +#### `acs_encoder_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -32,7 +32,7 @@ Date and time at which the [encoder](../../../capability-guides/access-systems/w --- -### `display_name` +#### `display_name` Format: `String` @@ -40,7 +40,7 @@ Display name for the [encoder](../../../capability-guides/access-systems/working --- -### `errors` +#### `errors` Format: `List` @@ -74,7 +74,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 36a2096f1..a08e6241d 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -40,9 +40,9 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. Encoding credential data from physical encoder. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -50,13 +50,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -81,7 +81,7 @@ Possible enum values: --- -#### `result` +##### `result` Format: `Object` @@ -433,7 +433,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 91078e1d8..2ea0ff24a 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -31,9 +31,9 @@ ID of the `acs_encoder` to use for the scan. Reading credential data from physical encoder. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -41,13 +41,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -70,7 +70,7 @@ Possible enum values: --- -#### `result` +##### `result` Format: `Object` @@ -604,7 +604,7 @@ Possible enum values: --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 447d43527..847fac9f5 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -8,7 +8,7 @@ Represents an [entrance](../../../capability-guides/access-systems/retrieving-en ## Properties -### `acs_entrance_id` +#### `acs_entrance_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [entrance](../../../capability-guides/access-systems/retrieving-entran --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `assa_abloy_vostio_metadata` +#### `assa_abloy_vostio_metadata` Format: `Object` @@ -68,7 +68,7 @@ Possible enum values: --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -76,7 +76,7 @@ Date and time at which the [entrance](../../../capability-guides/access-systems/ --- -### `display_name` +#### `display_name` Format: `String` @@ -84,7 +84,7 @@ Display name for the [entrance](../../../capability-guides/access-systems/retrie --- -### `dormakaba_community_metadata` +#### `dormakaba_community_metadata` Format: `Object` @@ -98,7 +98,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca --- -### `errors` +#### `errors` Format: `List` @@ -124,7 +124,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -### `latch_metadata` +#### `latch_metadata` Format: `Object` @@ -156,7 +156,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide --- -### `salto_ks_metadata` +#### `salto_ks_metadata` Format: `Object` @@ -212,7 +212,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu --- -### `salto_space_metadata` +#### `salto_space_metadata` Format: `Object` @@ -238,7 +238,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability --- -### `visionline_metadata` +#### `visionline_metadata` Format: `Object` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 55c80b1b1..e6c256b48 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -8,7 +8,7 @@ Represents an [access control system](https://docs.seam.co/latest/capability-gui ## Properties -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `can_add_acs_users_to_acs_access_groups` +#### `can_add_acs_users_to_acs_access_groups` Format: `Boolean` @@ -24,7 +24,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -### `can_automate_enrollment` +#### `can_automate_enrollment` Format: `Boolean` @@ -32,7 +32,7 @@ Indicates whether it is possible to [launch enrollment automations](../../../cap --- -### `can_create_acs_access_groups` +#### `can_create_acs_access_groups` Format: `Boolean` @@ -40,7 +40,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -### `can_remove_acs_users_from_acs_access_groups` +#### `can_remove_acs_users_from_acs_access_groups` Format: `Boolean` @@ -48,7 +48,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -### `connected_account_id` +#### `connected_account_id` Format: `UUID` @@ -56,7 +56,7 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m --- -### `connected_account_ids` +#### `connected_account_ids` {% hint style="warning" %} **Deprecated**. Use `connected_account_id`. @@ -70,7 +70,7 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -78,7 +78,7 @@ Date and time at which the [access control system](https://docs.seam.co/latest/c --- -### `default_credential_manager_acs_system_id` +#### `default_credential_manager_acs_system_id` Format: `UUID` @@ -86,7 +86,7 @@ ID of the default credential manager `acs_system` for this [access control syste --- -### [`errors`](./#errors-1) +#### [`errors`](./#errors-1) Format: `List` @@ -96,7 +96,7 @@ Errors associated with the [access control system](https://docs.seam.co/latest/c --- -### `external_type` +#### `external_type` Format: `Enum` @@ -119,7 +119,7 @@ Possible enum values: --- -### `external_type_display_name` +#### `external_type_display_name` Format: `String` @@ -127,7 +127,7 @@ Display name that corresponds to the brand-specific terminology for the [access --- -### `image_alt_text` +#### `image_alt_text` Format: `String` @@ -135,7 +135,7 @@ Alternative text for the [access control system](https://docs.seam.co/latest/cap --- -### `image_url` +#### `image_url` Format: `String` @@ -143,7 +143,7 @@ URL for the image that represents the [access control system](https://docs.seam. --- -### `is_credential_manager` +#### `is_credential_manager` Format: `Boolean` @@ -151,7 +151,7 @@ Indicates whether the `acs_system` is a credential manager. --- -### `location` +#### `location` Format: `Object` @@ -165,7 +165,7 @@ Time zone in which the [access control system](https://docs.seam.co/latest/capab --- -### `name` +#### `name` Format: `String` @@ -173,7 +173,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -### `system_type` +#### `system_type` {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -198,7 +198,7 @@ Possible enum values: --- -### `system_type_display_name` +#### `system_type_display_name` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -208,7 +208,7 @@ Format: `String` --- -### `visionline_metadata` +#### `visionline_metadata` Format: `Object` @@ -238,7 +238,7 @@ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel i --- -### [`warnings`](./#warnings-1) +#### [`warnings`](./#warnings-1) Format: `List` @@ -248,7 +248,7 @@ Warnings associated with the [access control system](https://docs.seam.co/latest --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 3685eb873..f42e0e4c7 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -8,7 +8,7 @@ Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems ## Properties -### `access_schedule` +#### `access_schedule` Format: `Object` @@ -32,7 +32,7 @@ Date and time at which the user's access starts, in [ISO 8601](https://www.iso.o --- -### `acs_system_id` +#### `acs_system_id` Format: `UUID` @@ -40,7 +40,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -### `acs_user_id` +#### `acs_user_id` Format: `UUID` @@ -48,7 +48,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -56,7 +56,7 @@ Date and time at which the [ACS user](https://docs.seam.co/latest/capability-gui --- -### `display_name` +#### `display_name` Format: `String` @@ -64,7 +64,7 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -### `email` +#### `email` {% hint style="warning" %} **Deprecated**. use email_address. @@ -74,7 +74,7 @@ Format: `String` --- -### `email_address` +#### `email_address` Format: `String` @@ -82,7 +82,7 @@ Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -### [`errors`](./#errors-1) +#### [`errors`](./#errors-1) Format: `List` @@ -92,7 +92,7 @@ Errors associated with the [ACS user](https://docs.seam.co/latest/capability-gui --- -### `external_type` +#### `external_type` Format: `Enum` @@ -109,7 +109,7 @@ Possible enum values: --- -### `external_type_display_name` +#### `external_type_display_name` Format: `String` @@ -117,7 +117,7 @@ Display name that corresponds to the brand-specific terminology for the [ACS use --- -### `full_name` +#### `full_name` Format: `String` @@ -125,19 +125,19 @@ Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access --- -### `hid_acs_system_id` +#### `hid_acs_system_id` Format: `UUID` --- -### `is_managed` +#### `is_managed` Format: `Boolean` --- -### `is_suspended` +#### `is_suspended` Format: `Boolean` @@ -145,7 +145,7 @@ Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/a --- -### `phone_number` +#### `phone_number` Format: `String` @@ -153,7 +153,7 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- -### `user_identity_email_address` +#### `user_identity_email_address` Format: `String` @@ -161,7 +161,7 @@ Email address of the user identity associated with the [ACS user](https://docs.s --- -### `user_identity_full_name` +#### `user_identity_full_name` Format: `String` @@ -169,7 +169,7 @@ Full name of the user identity associated with the [ACS user](https://docs.seam. --- -### `user_identity_id` +#### `user_identity_id` Format: `String` @@ -177,7 +177,7 @@ ID of the user identity associated with the [ACS user](https://docs.seam.co/late --- -### `user_identity_phone_number` +#### `user_identity_phone_number` Format: `String` @@ -185,7 +185,7 @@ Phone number of the user identity associated with the [ACS user](https://docs.se --- -### [`warnings`](./#warnings-1) +#### [`warnings`](./#warnings-1) Format: `List` @@ -195,7 +195,7 @@ Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-g --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index fc7b8b5b0..1980a4865 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -8,7 +8,7 @@ Represents an app user's mobile phone. ## Properties -### `created_at` +#### `created_at` Format: `Datetime` @@ -16,7 +16,7 @@ Date and time at which the `phone` was created. --- -### `custom_metadata` +#### `custom_metadata` Format: `Record` @@ -24,7 +24,7 @@ Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to --- -### `device_id` +#### `device_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the `phone`. --- -### `device_type` +#### `device_type` Format: `Enum` @@ -44,7 +44,7 @@ Possible enum values: --- -### `display_name` +#### `display_name` Format: `String` @@ -52,7 +52,7 @@ Display name of the phone. Defaults to `nickname` (if it is set) or `properties. --- -### `errors` +#### `errors` Format: `List` @@ -74,7 +74,7 @@ Errors associated with the `phone`. --- -### `nickname` +#### `nickname` Format: `String` @@ -82,7 +82,7 @@ Optional nickname to describe the phone, settable through Seam. --- -### `properties` +#### `properties` Format: `Object` @@ -146,7 +146,7 @@ Indicates whether the credential service has an active associated phone. --- -### `warnings` +#### `warnings` Format: `List` @@ -168,7 +168,7 @@ Warnings associated with the `phone`. --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 3581cf675..f389bd98d 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -172,9 +172,9 @@ ID of the desired thermostat device. Activating climate preset. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -182,13 +182,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -206,7 +206,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -214,7 +214,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index e5eeb887a..c11883961 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -182,9 +182,9 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index e94c92dfe..e572ed4aa 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -182,9 +182,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index e45bed8d1..6ccc97c7c 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -206,9 +206,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -216,13 +216,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -240,7 +240,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -248,7 +248,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index b5d29835a..8499e4124 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -154,9 +154,9 @@ ID of the desired thermostat device. Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -164,13 +164,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -188,7 +188,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -196,7 +196,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index d368f6887..f48dbb861 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -8,7 +8,7 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties -### `climate_preset_key` +#### `climate_preset_key` Format: `String` @@ -16,7 +16,7 @@ Key of the [climate preset](../../../capability-guides/thermostats/creating-and- --- -### `created_at` +#### `created_at` Format: `Datetime` @@ -24,7 +24,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -### `device_id` +#### `device_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/the --- -### `ends_at` +#### `ends_at` Format: `Datetime` @@ -40,7 +40,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -### `errors` +#### `errors` Format: `List` @@ -66,7 +66,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -### `max_override_period_minutes` +#### `max_override_period_minutes` Format: `Number` @@ -74,7 +74,7 @@ Number of minutes for which a person at the thermostat can change the thermostat --- -### `name` +#### `name` Format: `String` @@ -82,7 +82,7 @@ User-friendly name to identify the [thermostat schedule](../../../capability-gui --- -### `starts_at` +#### `starts_at` Format: `Datetime` @@ -90,7 +90,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -### `thermostat_schedule_id` +#### `thermostat_schedule_id` Format: `UUID` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index cbc03d518..9c801e3aa 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -182,9 +182,9 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos Setting fan mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 0619e31be..b60e9003a 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -220,9 +220,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +## Properties -#### `action_attempt_id` +##### `action_attempt_id` Format: `UUID` @@ -230,13 +230,13 @@ The ID of the action attempt. --- -#### `action_type` +##### `action_type` Format: `String` --- -#### `error` +##### `error` Format: `Object` @@ -254,7 +254,7 @@ Format: `Object` --- -#### `result` +##### `result` Format: `Object` @@ -262,7 +262,7 @@ This object has no properties. --- -#### `status` +##### `status` Format: `Enum` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 0655fc022..6453bfe0e 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -8,7 +8,7 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties -### `created_at` +#### `created_at` Format: `Datetime` @@ -16,13 +16,13 @@ Date and time at which the user identity was created. --- -### `display_name` +#### `display_name` Format: `String` --- -### `email_address` +#### `email_address` Format: `String` @@ -30,13 +30,13 @@ Unique email address for the user identity. --- -### `full_name` +#### `full_name` Format: `String` --- -### `phone_number` +#### `phone_number` Format: `String` @@ -44,7 +44,7 @@ Unique phone number for the user identity in [E.164 format](https://www.itu.int/ --- -### `user_identity_id` +#### `user_identity_id` Format: `UUID` @@ -52,7 +52,7 @@ ID of the user identity. --- -### `user_identity_key` +#### `user_identity_key` Format: `String` @@ -60,7 +60,7 @@ Unique key for the user identity. --- -### `workspace_id` +#### `workspace_id` Format: `UUID` diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 0b1a2b65e..a7ed61101 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -8,7 +8,7 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties -### `created_at` +#### `created_at` Format: `Datetime` @@ -16,7 +16,7 @@ Date and time at which the enrollment automation was created. --- -### `credential_manager_acs_system_id` +#### `credential_manager_acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/ --- -### `enrollment_automation_id` +#### `enrollment_automation_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the enrollment automation. --- -### `user_identity_id` +#### `user_identity_id` Format: `UUID` @@ -40,7 +40,7 @@ ID of the associated [user identity](https://docs.seam.co/latest/capability-guid --- -### `workspace_id` +#### `workspace_id` Format: `UUID` From 11f9f89f56f27720683b95955c732f2391e75047 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:31:10 -0400 Subject: [PATCH 011/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index eebb7080d..ee55e650b 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -8,17 +8,17 @@ {{description}} {{/if}} -{{#if ../headingOffset}} +{{#if headingOffset}} #### Properties {{else}} -## Properties +### Properties {{/if}} {{#each properties}} {{#if ../headingOffset}} -##### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} -{{else}} #### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} +{{else}} +### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} {{/if}} {{#if isDeprecated}} From a801425db2273d5b0a2dadd8e42e16b168dae03f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:32:17 +0000 Subject: [PATCH 012/233] ci: Generate docs --- docs/api/acs/access_groups/README.md | 26 ++++----- docs/api/acs/credentials/README.md | 54 +++++++++---------- docs/api/acs/encoders/README.md | 14 ++--- docs/api/acs/encoders/encode_credential.md | 12 ++--- docs/api/acs/encoders/scan_credential.md | 12 ++--- docs/api/acs/entrances/README.md | 24 ++++----- docs/api/acs/systems/README.md | 46 ++++++++-------- docs/api/acs/users/README.md | 44 +++++++-------- docs/api/phones/README.md | 22 ++++---- .../thermostats/activate_climate_preset.md | 12 ++--- docs/api/thermostats/cool.md | 12 ++--- docs/api/thermostats/heat.md | 12 ++--- docs/api/thermostats/heat_cool.md | 12 ++--- docs/api/thermostats/off.md | 12 ++--- docs/api/thermostats/schedules/README.md | 20 +++---- docs/api/thermostats/set_fan_mode.md | 12 ++--- docs/api/thermostats/set_hvac_mode.md | 12 ++--- docs/api/user_identities/README.md | 18 +++---- .../enrollment_automations/README.md | 12 ++--- 19 files changed, 194 insertions(+), 194 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 175433c8f..fd2400a91 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -7,9 +7,9 @@ The Access Groups route contains the following resources: 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. The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## Properties +### Properties -#### `access_group_type` +### `access_group_type` {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -27,7 +27,7 @@ Possible enum values: --- -#### `access_group_type_display_name` +### `access_group_type_display_name` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -37,7 +37,7 @@ Format: `String` --- -#### `acs_access_group_id` +### `acs_access_group_id` Format: `UUID` @@ -45,7 +45,7 @@ ID of the access group. --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -53,7 +53,7 @@ ID of the access control system that contains the access group. --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -61,13 +61,13 @@ Date and time at which the access group was created. --- -#### `display_name` +### `display_name` Format: `String` --- -#### `external_type` +### `external_type` Format: `Enum` @@ -83,7 +83,7 @@ Possible enum values: --- -#### `external_type_display_name` +### `external_type_display_name` Format: `String` @@ -91,13 +91,13 @@ Display name that corresponds to the brand-specific terminology for the access g --- -#### `is_managed` +### `is_managed` Format: `Boolean` --- -#### `name` +### `name` Format: `String` @@ -105,7 +105,7 @@ Name of the access group. --- -#### `warnings` +### `warnings` Format: `List` @@ -139,7 +139,7 @@ Unique identifier of the type of warning. Enables quick recognition and categori --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index e762fdbae..554994b65 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -6,9 +6,9 @@ The Credentials route contains the following resources: Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. -## Properties +### Properties -#### `access_method` +### `access_method` Format: `Enum` @@ -21,7 +21,7 @@ Possible enum values: --- -#### `acs_credential_id` +### `acs_credential_id` Format: `UUID` @@ -29,13 +29,13 @@ ID of the [credential](../../../capability-guides/access-systems/managing-creden --- -#### `acs_credential_pool_id` +### `acs_credential_pool_id` Format: `UUID` --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -43,7 +43,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `acs_user_id` +### `acs_user_id` Format: `UUID` @@ -51,7 +51,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system --- -#### `assa_abloy_vostio_metadata` +### `assa_abloy_vostio_metadata` Format: `Object` @@ -89,7 +89,7 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- --- -#### `card_number` +### `card_number` Format: `String` @@ -97,7 +97,7 @@ Number of the card associated with the [credential](../../../capability-guides/a --- -#### `code` +### `code` Format: `String` @@ -105,7 +105,7 @@ Access (PIN) code for the [credential](../../../capability-guides/access-systems --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -113,7 +113,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -#### `display_name` +### `display_name` Format: `String` @@ -121,7 +121,7 @@ Display name that corresponds to the [credential](../../../capability-guides/acc --- -#### `ends_at` +### `ends_at` Format: `String` @@ -129,7 +129,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -#### `errors` +### `errors` Format: `List` @@ -151,7 +151,7 @@ Errors associated with the [credential](../../../capability-guides/access-system --- -#### `external_type` +### `external_type` Format: `Enum` @@ -168,7 +168,7 @@ Possible enum values: --- -#### `external_type_display_name` +### `external_type_display_name` Format: `String` @@ -176,7 +176,7 @@ Display name that corresponds to the brand-specific terminology for the [credent --- -#### `is_issued` +### `is_issued` Format: `Boolean` @@ -184,7 +184,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -#### `is_latest_desired_state_synced_with_provider` +### `is_latest_desired_state_synced_with_provider` Format: `Boolean` @@ -192,13 +192,13 @@ Indicates whether the latest state of the [credential](../../../capability-guide --- -#### `is_managed` +### `is_managed` Format: `Boolean` --- -#### `is_multi_phone_sync_credential` +### `is_multi_phone_sync_credential` Format: `Boolean` @@ -206,7 +206,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -#### `is_one_time_use` +### `is_one_time_use` Format: `Boolean` @@ -214,7 +214,7 @@ Indicates whether the [credential](../../../capability-guides/access-systems/man --- -#### `issued_at` +### `issued_at` Format: `Datetime` @@ -222,7 +222,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -#### `latest_desired_state_synced_with_provider_at` +### `latest_desired_state_synced_with_provider_at` Format: `Datetime` @@ -230,7 +230,7 @@ Date and time at which the state of the [credential](../../../capability-guides/ --- -#### `parent_acs_credential_id` +### `parent_acs_credential_id` Format: `UUID` @@ -238,7 +238,7 @@ ID of the parent [credential](../../../capability-guides/access-systems/managing --- -#### `starts_at` +### `starts_at` Format: `String` @@ -246,7 +246,7 @@ Date and time at which the [credential](../../../capability-guides/access-system --- -#### `visionline_metadata` +### `visionline_metadata` Format: `Object` @@ -306,7 +306,7 @@ Possible enum values: --- -#### [`warnings`](./#warnings-1) +### [`warnings`](./#warnings-1) Format: `List` @@ -316,7 +316,7 @@ Warnings associated with the [credential](../../../capability-guides/access-syst --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index ea4a0607f..53ce78629 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -6,9 +6,9 @@ The Encoders route contains the following resources: Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -## Properties +### Properties -#### `acs_encoder_id` +### `acs_encoder_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -32,7 +32,7 @@ Date and time at which the [encoder](../../../capability-guides/access-systems/w --- -#### `display_name` +### `display_name` Format: `String` @@ -40,7 +40,7 @@ Display name for the [encoder](../../../capability-guides/access-systems/working --- -#### `errors` +### `errors` Format: `List` @@ -74,7 +74,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index a08e6241d..36a2096f1 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -40,9 +40,9 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. Encoding credential data from physical encoder. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -50,13 +50,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -81,7 +81,7 @@ Possible enum values: --- -##### `result` +#### `result` Format: `Object` @@ -433,7 +433,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 2ea0ff24a..91078e1d8 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -31,9 +31,9 @@ ID of the `acs_encoder` to use for the scan. Reading credential data from physical encoder. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -41,13 +41,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -70,7 +70,7 @@ Possible enum values: --- -##### `result` +#### `result` Format: `Object` @@ -604,7 +604,7 @@ Possible enum values: --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 847fac9f5..1662bd413 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -6,9 +6,9 @@ The Entrances route contains the following resources: Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## Properties +### Properties -#### `acs_entrance_id` +### `acs_entrance_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [entrance](../../../capability-guides/access-systems/retrieving-entran --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `assa_abloy_vostio_metadata` +### `assa_abloy_vostio_metadata` Format: `Object` @@ -68,7 +68,7 @@ Possible enum values: --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -76,7 +76,7 @@ Date and time at which the [entrance](../../../capability-guides/access-systems/ --- -#### `display_name` +### `display_name` Format: `String` @@ -84,7 +84,7 @@ Display name for the [entrance](../../../capability-guides/access-systems/retrie --- -#### `dormakaba_community_metadata` +### `dormakaba_community_metadata` Format: `Object` @@ -98,7 +98,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca --- -#### `errors` +### `errors` Format: `List` @@ -124,7 +124,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -#### `latch_metadata` +### `latch_metadata` Format: `Object` @@ -156,7 +156,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide --- -#### `salto_ks_metadata` +### `salto_ks_metadata` Format: `Object` @@ -212,7 +212,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu --- -#### `salto_space_metadata` +### `salto_space_metadata` Format: `Object` @@ -238,7 +238,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability --- -#### `visionline_metadata` +### `visionline_metadata` Format: `Object` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index e6c256b48..37d7ff779 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -6,9 +6,9 @@ The Systems route contains the following resources: Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## Properties +### Properties -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -16,7 +16,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `can_add_acs_users_to_acs_access_groups` +### `can_add_acs_users_to_acs_access_groups` Format: `Boolean` @@ -24,7 +24,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -#### `can_automate_enrollment` +### `can_automate_enrollment` Format: `Boolean` @@ -32,7 +32,7 @@ Indicates whether it is possible to [launch enrollment automations](../../../cap --- -#### `can_create_acs_access_groups` +### `can_create_acs_access_groups` Format: `Boolean` @@ -40,7 +40,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -#### `can_remove_acs_users_from_acs_access_groups` +### `can_remove_acs_users_from_acs_access_groups` Format: `Boolean` @@ -48,7 +48,7 @@ Indicates whether the [access control system](https://docs.seam.co/latest/capabi --- -#### `connected_account_id` +### `connected_account_id` Format: `UUID` @@ -56,7 +56,7 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m --- -#### `connected_account_ids` +### `connected_account_ids` {% hint style="warning" %} **Deprecated**. Use `connected_account_id`. @@ -70,7 +70,7 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -78,7 +78,7 @@ Date and time at which the [access control system](https://docs.seam.co/latest/c --- -#### `default_credential_manager_acs_system_id` +### `default_credential_manager_acs_system_id` Format: `UUID` @@ -86,7 +86,7 @@ ID of the default credential manager `acs_system` for this [access control syste --- -#### [`errors`](./#errors-1) +### [`errors`](./#errors-1) Format: `List` @@ -96,7 +96,7 @@ Errors associated with the [access control system](https://docs.seam.co/latest/c --- -#### `external_type` +### `external_type` Format: `Enum` @@ -119,7 +119,7 @@ Possible enum values: --- -#### `external_type_display_name` +### `external_type_display_name` Format: `String` @@ -127,7 +127,7 @@ Display name that corresponds to the brand-specific terminology for the [access --- -#### `image_alt_text` +### `image_alt_text` Format: `String` @@ -135,7 +135,7 @@ Alternative text for the [access control system](https://docs.seam.co/latest/cap --- -#### `image_url` +### `image_url` Format: `String` @@ -143,7 +143,7 @@ URL for the image that represents the [access control system](https://docs.seam. --- -#### `is_credential_manager` +### `is_credential_manager` Format: `Boolean` @@ -151,7 +151,7 @@ Indicates whether the `acs_system` is a credential manager. --- -#### `location` +### `location` Format: `Object` @@ -165,7 +165,7 @@ Time zone in which the [access control system](https://docs.seam.co/latest/capab --- -#### `name` +### `name` Format: `String` @@ -173,7 +173,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -#### `system_type` +### `system_type` {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -198,7 +198,7 @@ Possible enum values: --- -#### `system_type_display_name` +### `system_type_display_name` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -208,7 +208,7 @@ Format: `String` --- -#### `visionline_metadata` +### `visionline_metadata` Format: `Object` @@ -238,7 +238,7 @@ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel i --- -#### [`warnings`](./#warnings-1) +### [`warnings`](./#warnings-1) Format: `List` @@ -248,7 +248,7 @@ Warnings associated with the [access control system](https://docs.seam.co/latest --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index f42e0e4c7..f337d8f3b 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -6,9 +6,9 @@ The ACS Users route contains the following resources: Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -## Properties +### Properties -#### `access_schedule` +### `access_schedule` Format: `Object` @@ -32,7 +32,7 @@ Date and time at which the user's access starts, in [ISO 8601](https://www.iso.o --- -#### `acs_system_id` +### `acs_system_id` Format: `UUID` @@ -40,7 +40,7 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- -#### `acs_user_id` +### `acs_user_id` Format: `UUID` @@ -48,7 +48,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -56,7 +56,7 @@ Date and time at which the [ACS user](https://docs.seam.co/latest/capability-gui --- -#### `display_name` +### `display_name` Format: `String` @@ -64,7 +64,7 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -#### `email` +### `email` {% hint style="warning" %} **Deprecated**. use email_address. @@ -74,7 +74,7 @@ Format: `String` --- -#### `email_address` +### `email_address` Format: `String` @@ -82,7 +82,7 @@ Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -#### [`errors`](./#errors-1) +### [`errors`](./#errors-1) Format: `List` @@ -92,7 +92,7 @@ Errors associated with the [ACS user](https://docs.seam.co/latest/capability-gui --- -#### `external_type` +### `external_type` Format: `Enum` @@ -109,7 +109,7 @@ Possible enum values: --- -#### `external_type_display_name` +### `external_type_display_name` Format: `String` @@ -117,7 +117,7 @@ Display name that corresponds to the brand-specific terminology for the [ACS use --- -#### `full_name` +### `full_name` Format: `String` @@ -125,19 +125,19 @@ Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access --- -#### `hid_acs_system_id` +### `hid_acs_system_id` Format: `UUID` --- -#### `is_managed` +### `is_managed` Format: `Boolean` --- -#### `is_suspended` +### `is_suspended` Format: `Boolean` @@ -145,7 +145,7 @@ Indicates whether the [ACS user](https://docs.seam.co/latest/capability-guides/a --- -#### `phone_number` +### `phone_number` Format: `String` @@ -153,7 +153,7 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- -#### `user_identity_email_address` +### `user_identity_email_address` Format: `String` @@ -161,7 +161,7 @@ Email address of the user identity associated with the [ACS user](https://docs.s --- -#### `user_identity_full_name` +### `user_identity_full_name` Format: `String` @@ -169,7 +169,7 @@ Full name of the user identity associated with the [ACS user](https://docs.seam. --- -#### `user_identity_id` +### `user_identity_id` Format: `String` @@ -177,7 +177,7 @@ ID of the user identity associated with the [ACS user](https://docs.seam.co/late --- -#### `user_identity_phone_number` +### `user_identity_phone_number` Format: `String` @@ -185,7 +185,7 @@ Phone number of the user identity associated with the [ACS user](https://docs.se --- -#### [`warnings`](./#warnings-1) +### [`warnings`](./#warnings-1) Format: `List` @@ -195,7 +195,7 @@ Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-g --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 1980a4865..40cfc1e80 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -6,9 +6,9 @@ The Phones route contains the following resources: Represents an app user's mobile phone. -## Properties +### Properties -#### `created_at` +### `created_at` Format: `Datetime` @@ -16,7 +16,7 @@ Date and time at which the `phone` was created. --- -#### `custom_metadata` +### `custom_metadata` Format: `Record` @@ -24,7 +24,7 @@ Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to --- -#### `device_id` +### `device_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the `phone`. --- -#### `device_type` +### `device_type` Format: `Enum` @@ -44,7 +44,7 @@ Possible enum values: --- -#### `display_name` +### `display_name` Format: `String` @@ -52,7 +52,7 @@ Display name of the phone. Defaults to `nickname` (if it is set) or `properties. --- -#### `errors` +### `errors` Format: `List` @@ -74,7 +74,7 @@ Errors associated with the `phone`. --- -#### `nickname` +### `nickname` Format: `String` @@ -82,7 +82,7 @@ Optional nickname to describe the phone, settable through Seam. --- -#### `properties` +### `properties` Format: `Object` @@ -146,7 +146,7 @@ Indicates whether the credential service has an active associated phone. --- -#### `warnings` +### `warnings` Format: `List` @@ -168,7 +168,7 @@ Warnings associated with the `phone`. --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index f389bd98d..3581cf675 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -172,9 +172,9 @@ ID of the desired thermostat device. Activating climate preset. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -182,13 +182,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -206,7 +206,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -214,7 +214,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index c11883961..e5eeb887a 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -182,9 +182,9 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index e572ed4aa..e94c92dfe 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -182,9 +182,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 6ccc97c7c..e45bed8d1 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -206,9 +206,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -216,13 +216,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -240,7 +240,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -248,7 +248,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 8499e4124..b5d29835a 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -154,9 +154,9 @@ ID of the desired thermostat device. Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -164,13 +164,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -188,7 +188,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -196,7 +196,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index f48dbb861..8eb560191 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -6,9 +6,9 @@ The Thermostat Schedules route contains the following resources: Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. -## Properties +### Properties -#### `climate_preset_key` +### `climate_preset_key` Format: `String` @@ -16,7 +16,7 @@ Key of the [climate preset](../../../capability-guides/thermostats/creating-and- --- -#### `created_at` +### `created_at` Format: `Datetime` @@ -24,7 +24,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -#### `device_id` +### `device_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/the --- -#### `ends_at` +### `ends_at` Format: `Datetime` @@ -40,7 +40,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -#### `errors` +### `errors` Format: `List` @@ -66,7 +66,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -#### `max_override_period_minutes` +### `max_override_period_minutes` Format: `Number` @@ -74,7 +74,7 @@ Number of minutes for which a person at the thermostat can change the thermostat --- -#### `name` +### `name` Format: `String` @@ -82,7 +82,7 @@ User-friendly name to identify the [thermostat schedule](../../../capability-gui --- -#### `starts_at` +### `starts_at` Format: `Datetime` @@ -90,7 +90,7 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther --- -#### `thermostat_schedule_id` +### `thermostat_schedule_id` Format: `UUID` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 9c801e3aa..cbc03d518 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -182,9 +182,9 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos Setting fan mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -192,13 +192,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -216,7 +216,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -224,7 +224,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index b60e9003a..0619e31be 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -220,9 +220,9 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -## Properties +#### Properties -##### `action_attempt_id` +#### `action_attempt_id` Format: `UUID` @@ -230,13 +230,13 @@ The ID of the action attempt. --- -##### `action_type` +#### `action_type` Format: `String` --- -##### `error` +#### `error` Format: `Object` @@ -254,7 +254,7 @@ Format: `Object` --- -##### `result` +#### `result` Format: `Object` @@ -262,7 +262,7 @@ This object has no properties. --- -##### `status` +#### `status` Format: `Enum` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 6453bfe0e..07800df08 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -6,9 +6,9 @@ The User Identities route contains the following resources: Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. -## Properties +### Properties -#### `created_at` +### `created_at` Format: `Datetime` @@ -16,13 +16,13 @@ Date and time at which the user identity was created. --- -#### `display_name` +### `display_name` Format: `String` --- -#### `email_address` +### `email_address` Format: `String` @@ -30,13 +30,13 @@ Unique email address for the user identity. --- -#### `full_name` +### `full_name` Format: `String` --- -#### `phone_number` +### `phone_number` Format: `String` @@ -44,7 +44,7 @@ Unique phone number for the user identity in [E.164 format](https://www.itu.int/ --- -#### `user_identity_id` +### `user_identity_id` Format: `UUID` @@ -52,7 +52,7 @@ ID of the user identity. --- -#### `user_identity_key` +### `user_identity_key` Format: `String` @@ -60,7 +60,7 @@ Unique key for the user identity. --- -#### `workspace_id` +### `workspace_id` Format: `UUID` diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index a7ed61101..7f4938ee8 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -6,9 +6,9 @@ The Enrollment Automations route contains the following resources: Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). -## Properties +### Properties -#### `created_at` +### `created_at` Format: `Datetime` @@ -16,7 +16,7 @@ Date and time at which the enrollment automation was created. --- -#### `credential_manager_acs_system_id` +### `credential_manager_acs_system_id` Format: `UUID` @@ -24,7 +24,7 @@ ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/ --- -#### `enrollment_automation_id` +### `enrollment_automation_id` Format: `UUID` @@ -32,7 +32,7 @@ ID of the enrollment automation. --- -#### `user_identity_id` +### `user_identity_id` Format: `UUID` @@ -40,7 +40,7 @@ ID of the associated [user identity](https://docs.seam.co/latest/capability-guid --- -#### `workspace_id` +### `workspace_id` Format: `UUID` From 34737c51bde7e544d0633fe20bdb6e4cd0a3aedc Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 14:35:31 -0400 Subject: [PATCH 013/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index ee55e650b..e4768fa74 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -9,9 +9,9 @@ {{/if}} {{#if headingOffset}} -#### Properties -{{else}} ### Properties +{{else}} +## Properties {{/if}} {{#each properties}} From 04705d9c0e3639aa643b4d59841dfbc9232bac2a Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 18:36:32 +0000 Subject: [PATCH 014/233] ci: Generate docs --- docs/api/acs/access_groups/README.md | 2 +- docs/api/acs/credentials/README.md | 2 +- docs/api/acs/encoders/README.md | 2 +- docs/api/acs/encoders/encode_credential.md | 2 +- docs/api/acs/encoders/scan_credential.md | 2 +- docs/api/acs/entrances/README.md | 2 +- docs/api/acs/systems/README.md | 2 +- docs/api/acs/users/README.md | 2 +- docs/api/phones/README.md | 2 +- docs/api/thermostats/activate_climate_preset.md | 2 +- docs/api/thermostats/cool.md | 2 +- docs/api/thermostats/heat.md | 2 +- docs/api/thermostats/heat_cool.md | 2 +- docs/api/thermostats/off.md | 2 +- docs/api/thermostats/schedules/README.md | 2 +- docs/api/thermostats/set_fan_mode.md | 2 +- docs/api/thermostats/set_hvac_mode.md | 2 +- docs/api/user_identities/README.md | 2 +- docs/api/user_identities/enrollment_automations/README.md | 2 +- 19 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index fd2400a91..b03ebddae 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -7,7 +7,7 @@ The Access Groups route contains the following resources: 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. The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -### Properties +## Properties ### `access_group_type` diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 554994b65..18756514c 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -6,7 +6,7 @@ The Credentials route contains the following resources: Means by which an [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). For each `acs_credential` object, you define the access method. You can also specify additional properties, such as a PIN code. -### Properties +## Properties ### `access_method` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 53ce78629..90948c79d 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -6,7 +6,7 @@ The Encoders route contains the following resources: Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). See also [Working with Card Encoders and Scanners](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -### Properties +## Properties ### `acs_encoder_id` diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 36a2096f1..a626b06ca 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -40,7 +40,7 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. Encoding credential data from physical encoder. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 91078e1d8..8ebba014d 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -31,7 +31,7 @@ ID of the `acs_encoder` to use for the scan. Reading credential data from physical encoder. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 1662bd413..447d43527 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -6,7 +6,7 @@ The Entrances route contains the following resources: Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -### Properties +## Properties ### `acs_entrance_id` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 37d7ff779..55c80b1b1 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -6,7 +6,7 @@ The Systems route contains the following resources: Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -### Properties +## Properties ### `acs_system_id` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index f337d8f3b..3685eb873 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -6,7 +6,7 @@ The ACS Users route contains the following resources: Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -### Properties +## Properties ### `access_schedule` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 40cfc1e80..fc7b8b5b0 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -6,7 +6,7 @@ The Phones route contains the following resources: Represents an app user's mobile phone. -### Properties +## Properties ### `created_at` diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 3581cf675..350ad3cae 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -172,7 +172,7 @@ ID of the desired thermostat device. Activating climate preset. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index e5eeb887a..77d36b7aa 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -182,7 +182,7 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index e94c92dfe..4b8658a2d 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -182,7 +182,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index e45bed8d1..fb0ec58bc 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -206,7 +206,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index b5d29835a..0e187e167 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -154,7 +154,7 @@ ID of the desired thermostat device. Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 8eb560191..d368f6887 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -6,7 +6,7 @@ The Thermostat Schedules route contains the following resources: Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. -### Properties +## Properties ### `climate_preset_key` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index cbc03d518..50ca28637 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -182,7 +182,7 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos Setting fan mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 0619e31be..a08ccb187 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -220,7 +220,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. -#### Properties +### Properties #### `action_attempt_id` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 07800df08..0655fc022 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -6,7 +6,7 @@ The User Identities route contains the following resources: Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. -### Properties +## Properties ### `created_at` diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 7f4938ee8..0b1a2b65e 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -6,7 +6,7 @@ The Enrollment Automations route contains the following resources: Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). -### Properties +## Properties ### `created_at` From a0140ac1662c65ed66d6b52eaf862e65920be466 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:15:43 -0400 Subject: [PATCH 015/233] Update acs-users.yaml --- .../code-sample-definitions/acs-users.yaml | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/src/data/code-sample-definitions/acs-users.yaml b/src/data/code-sample-definitions/acs-users.yaml index 77bd23cd8..c09f27b8c 100644 --- a/src/data/code-sample-definitions/acs-users.yaml +++ b/src/data/code-sample-definitions/acs-users.yaml @@ -1,6 +1,49 @@ --- - title: 'Create a new ACS user' description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).' + request: + path: '/acs/users/create' + parameters: + acs_system_id: '123e4567-e89b-12d3-a456-426614174000' + full_name: 'Jane Doe' + email_address: 'jane@example.com' + phone_number: '+15555550100' + response: + body: + acs_user: + acs_user_id: '123e4567-e89b-12d3-a456-426614174000' + acs_system_id: '123e4567-e89b-12d3-a456-426614174000' + workspace_id: '123e4567-e89b-12d3-a456-426614174000' + created_at: '2024-04-05T07:57:05.323Z' + display_name: 'Jane Doe' + full_name: 'Jane Doe' + email_address: 'jane@example.com' + phone_number: '+15555550100' +- title: 'Create a new ACS user' + description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule.' + request: + path: '/acs/users/create' + parameters: + acs_system_id: '123e4567-e89b-12d3-a456-426614174000' + full_name: 'Jane Doe' + email_address: 'jane@example.com' + phone_number: '+15555550100' + access_schedule: + starts_at: '2024-11-01T15:00:00.000Z' + ends_at: '2024-11-04T11:00:00.000Z' + response: + body: + acs_user: + acs_user_id: '123e4567-e89b-12d3-a456-426614174000' + acs_system_id: '123e4567-e89b-12d3-a456-426614174000' + workspace_id: '123e4567-e89b-12d3-a456-426614174000' + created_at: '2024-04-05T07:57:05.323Z' + display_name: 'Jane Doe' + full_name: 'Jane Doe' + email_address: 'jane@example.com' + phone_number: '+15555550100' +- title: 'Create a new ACS user in an access group' + description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups).' request: path: '/acs/users/create' parameters: From c614e4e22a538c8af14a86df367779d2894550e9 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:16:44 +0000 Subject: [PATCH 016/233] ci: Generate docs --- docs/api/acs/users/create.md | 349 +++++++++++++++++++++++++++++++++++ 1 file changed, 349 insertions(+) diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 6137a24e7..20a37cbdf 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -10,6 +10,355 @@ Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-sy {% tab title="JavaScript" %} #### Request +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", + access_schedule={ + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: [ + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-04T11:00:00.000Z", + ] +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"} +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + AccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String("2024-11-01T15:00:00.000Z"), EndsAt: api.String("2024-11-04T11:00:00.000Z")}, + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% tab title="JavaScript" %} +#### Request + ```javascript await seam.acs.users.create({ acs_system_id: "123e4567-e89b-12d3-a456-426614174000", From 5519bcffe6be5cfbe5939cd1fb060a4e7468df93 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:21:07 +0000 Subject: [PATCH 017/233] ci: Generate docs --- docs/api/acs/entrances/README.md | 2 ++ docs/api/acs/systems/README.md | 2 ++ docs/api/acs/users/README.md | 2 ++ 3 files changed, 6 insertions(+) diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index a6312457d..3a0f02725 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -8,6 +8,8 @@ Represents an [entrance](../../../capability-guides/access-systems/retrieving-en 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. +## Properties + ### `acs_entrance_id` Format: `UUID` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 5697d778e..b3faa7fa5 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -10,6 +10,8 @@ Within an `acs_system`, create [`acs_user`s](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/latest/api/acs). +## Properties + ### `acs_system_id` Format: `UUID` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 460f53235..a43216b0d 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -10,6 +10,8 @@ An `acs_user` typically refers to an individual who requires access, like an emp For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +## Properties + ### `access_schedule` Format: `Object` From 802f992846f72635e0de44bdc0bcca48a93fd95f Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:47:07 -0400 Subject: [PATCH 018/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 1e41aec61..695fd5015 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -7,10 +7,10 @@ {{{description}}} {{#if codeSamples.length}} -{% tabs %} {{#each codeSamples}} +{% tabs %} {{#each this.code}} -{% tab title="{{this.title}}" %} +{% tab title="{{this.title}} TEST" %} #### Request ```{{@key}} From 5268d8f61e79b718018246e52f416f229959ab81 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:48:04 +0000 Subject: [PATCH 019/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 12 +++--- docs/api/acs/access_groups/get.md | 12 +++--- docs/api/acs/access_groups/list.md | 12 +++--- .../list_accessible_entrances.md | 12 +++--- docs/api/acs/access_groups/list_users.md | 12 +++--- docs/api/acs/access_groups/remove_user.md | 12 +++--- docs/api/acs/credentials/assign.md | 12 +++--- docs/api/acs/credentials/create.md | 12 +++--- docs/api/acs/credentials/delete.md | 12 +++--- docs/api/acs/credentials/get.md | 12 +++--- docs/api/acs/credentials/list.md | 12 +++--- .../credentials/list_accessible_entrances.md | 12 +++--- docs/api/acs/credentials/unassign.md | 12 +++--- docs/api/acs/credentials/update.md | 12 +++--- docs/api/acs/entrances/get.md | 12 +++--- docs/api/acs/entrances/list.md | 12 +++--- .../entrances/list_credentials_with_access.md | 12 +++--- docs/api/acs/systems/get.md | 12 +++--- docs/api/acs/systems/list.md | 12 +++--- ...mpatible_credential_manager_acs_systems.md | 12 +++--- docs/api/acs/users/add_to_access_group.md | 12 +++--- docs/api/acs/users/create.md | 38 ++++++++++--------- docs/api/acs/users/delete.md | 12 +++--- docs/api/acs/users/get.md | 12 +++--- docs/api/acs/users/list.md | 12 +++--- .../api/acs/users/remove_from_access_group.md | 12 +++--- docs/api/acs/users/suspend.md | 12 +++--- docs/api/acs/users/unsuspend.md | 12 +++--- docs/api/acs/users/update.md | 12 +++--- .../thermostats/activate_climate_preset.md | 12 +++--- docs/api/thermostats/cool.md | 12 +++--- docs/api/thermostats/create_climate_preset.md | 12 +++--- docs/api/thermostats/delete_climate_preset.md | 12 +++--- docs/api/thermostats/heat.md | 12 +++--- docs/api/thermostats/heat_cool.md | 12 +++--- docs/api/thermostats/list.md | 12 +++--- docs/api/thermostats/off.md | 12 +++--- docs/api/thermostats/schedules/create.md | 12 +++--- docs/api/thermostats/schedules/delete.md | 12 +++--- docs/api/thermostats/schedules/get.md | 12 +++--- docs/api/thermostats/schedules/list.md | 12 +++--- docs/api/thermostats/schedules/update.md | 12 +++--- .../set_fallback_climate_preset.md | 12 +++--- docs/api/thermostats/set_fan_mode.md | 12 +++--- docs/api/thermostats/set_hvac_mode.md | 12 +++--- .../thermostats/set_temperature_threshold.md | 12 +++--- docs/api/thermostats/update_climate_preset.md | 12 +++--- docs/api/user_identities/add_acs_user.md | 12 +++--- docs/api/user_identities/create.md | 12 +++--- docs/api/user_identities/delete.md | 12 +++--- .../enrollment_automations/delete.md | 12 +++--- .../enrollment_automations/get.md | 12 +++--- .../enrollment_automations/launch.md | 12 +++--- .../enrollment_automations/list.md | 12 +++--- docs/api/user_identities/get.md | 12 +++--- .../user_identities/grant_access_to_device.md | 12 +++--- docs/api/user_identities/list.md | 12 +++--- .../list_accessible_devices.md | 12 +++--- docs/api/user_identities/list_acs_systems.md | 12 +++--- docs/api/user_identities/list_acs_users.md | 12 +++--- docs/api/user_identities/remove_acs_user.md | 12 +++--- .../revoke_access_to_device.md | 12 +++--- 62 files changed, 386 insertions(+), 384 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 983d05410..ec8c530c7 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -7,7 +7,7 @@ PUT /acs/access_groups/add_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.accessGroups.addUser({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-4 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index e33a8cb19..a2322f7ce 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -7,7 +7,7 @@ POST /acs/access_groups/get ⇒ { acs_access_group } Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -34,7 +34,7 @@ await seam.acs.accessGroups.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -59,7 +59,7 @@ AcsAccessGroup( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -84,7 +84,7 @@ seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-4444444 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -113,7 +113,7 @@ $seam->acs->access_groups->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -138,7 +138,7 @@ seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 103b790ba..4864901b8 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -7,7 +7,7 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -37,7 +37,7 @@ await seam.acs.accessGroups.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -67,7 +67,7 @@ seam.acs.access_groups.list( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -97,7 +97,7 @@ seam.acs.access_groups.list( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -129,7 +129,7 @@ $seam->acs->access_groups->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -156,7 +156,7 @@ seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-11111111111 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 265ab76d3..6eaa6c4d8 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -7,7 +7,7 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -32,7 +32,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -57,7 +57,7 @@ seam.acs.access_groups.list_accessible_entrances( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -82,7 +82,7 @@ seam.acs.access_groups.list_accessible_entrances( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -109,7 +109,7 @@ $seam->acs->access_groups->list_accessible_entrances( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -132,7 +132,7 @@ seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index c366a94a6..ddad886c1 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -7,7 +7,7 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -44,7 +44,7 @@ await seam.acs.accessGroups.listUsers({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -81,7 +81,7 @@ seam.acs.access_groups.list_users( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -116,7 +116,7 @@ seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444- ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -155,7 +155,7 @@ $seam->acs->access_groups->list_users( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -190,7 +190,7 @@ seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 6902f8394..2eca16489 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -7,7 +7,7 @@ POST /acs/access_groups/remove_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.accessGroups.removeUser({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-444 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index e1cae31f5..834f543b3 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -7,7 +7,7 @@ PATCH /acs/credentials/assign ⇒ void Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.credentials.assign({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index af1e25bfe..01a2b4434 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -7,7 +7,7 @@ POST /acs/credentials/create ⇒ { acs_credential } Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -42,7 +42,7 @@ await seam.acs.credentials.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -77,7 +77,7 @@ AcsCredential( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -112,7 +112,7 @@ seam.acs.credentials.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -149,7 +149,7 @@ $seam->acs->credentials->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -173,7 +173,7 @@ seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 9a0fee13f..16de68075 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -7,7 +7,7 @@ POST /acs/credentials/delete ⇒ void Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.acs.credentials.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -68,7 +68,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -82,7 +82,7 @@ seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-6666666 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 649794cee..bb1217312 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -7,7 +7,7 @@ POST /acs/credentials/get ⇒ { acs_credential } Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -33,7 +33,7 @@ await seam.acs.credentials.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -57,7 +57,7 @@ AcsCredential( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -81,7 +81,7 @@ seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-66666666666 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -109,7 +109,7 @@ $seam->acs->credentials->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -133,7 +133,7 @@ seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-6666666666 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 2f656b113..e2ad59fb8 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -7,7 +7,7 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -38,7 +38,7 @@ await seam.acs.credentials.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -69,7 +69,7 @@ seam.acs.credentials.list( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -100,7 +100,7 @@ seam.acs.credentials.list( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -133,7 +133,7 @@ $seam->acs->credentials->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -159,7 +159,7 @@ seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" - ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3dddcd871..5db94f202 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -7,7 +7,7 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -42,7 +42,7 @@ await seam.acs.credentials.listAccessibleEntrances({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -77,7 +77,7 @@ seam.acs.credentials.list_accessible_entrances( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -107,7 +107,7 @@ seam.acs.credentials.list_accessible_entrances( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -144,7 +144,7 @@ $seam->acs->credentials->list_accessible_entrances( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -177,7 +177,7 @@ seam acs credentials list-accessible-entrances --acs_credential_id "66666666-666 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 187a30eb3..264c237db 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -7,7 +7,7 @@ PATCH /acs/credentials/unassign ⇒ void Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.credentials.unassign({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-33333333333 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 549c4a2b5..c6721e70d 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -7,7 +7,7 @@ PATCH /acs/credentials/update ⇒ void Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.credentials.update({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -40,7 +40,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -54,7 +54,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -72,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -86,7 +86,7 @@ seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-6666666 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index b4bbbbdf4..734bd8887 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -7,7 +7,7 @@ POST /acs/entrances/get ⇒ { acs_entrance } Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.acs.entrances.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -47,7 +47,7 @@ AcsEntrance( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -66,7 +66,7 @@ seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -89,7 +89,7 @@ $seam->acs->entrances->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -108,7 +108,7 @@ seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index acf540d23..54fcee250 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -7,7 +7,7 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.acs.entrances.list(); ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -49,7 +49,7 @@ seam.acs.entrances.list() ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -70,7 +70,7 @@ seam.acs.entrances.list() ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -93,7 +93,7 @@ $seam->acs->entrances->list(); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -114,7 +114,7 @@ seam acs entrances list ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6cd85a7bf..053d62a32 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -7,7 +7,7 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -46,7 +46,7 @@ await seam.acs.entrances.listCredentialsWithAccess({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -85,7 +85,7 @@ seam.acs.entrances.list_credentials_with_access( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -124,7 +124,7 @@ seam.acs.entrances.list_credentials_with_access( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -166,7 +166,7 @@ $seam->acs->entrances->list_credentials_with_access( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -203,7 +203,7 @@ seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index a4c54c150..e1fa0bbaa 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -9,7 +9,7 @@ Returns a specified [access control system](https://docs.seam.co/latest/capabili Specify the desired access control system by including the corresponding `acs_system_id` in the request body. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -25,7 +25,7 @@ await seam.acs.systems.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -39,7 +39,7 @@ seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -53,7 +53,7 @@ seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -69,7 +69,7 @@ $seam->acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -83,7 +83,7 @@ seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 61766cfe3..32b1ab1fc 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -11,7 +11,7 @@ To filter the list of returned access control systems by a specific connected ac response includes all access control systems connected to your workspace. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -27,7 +27,7 @@ await seam.acs.systems.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -55,7 +55,7 @@ seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-42661417400 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -73,7 +73,7 @@ $seam->acs->systems->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -87,7 +87,7 @@ seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-4266141740 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 64204002a..c5a3e276a 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -11,7 +11,7 @@ Specify the ACS system for which you want to retrieve all compatible credential systems by including the corresponding `acs_system_id` in the request body. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -27,7 +27,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -43,7 +43,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -59,7 +59,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -77,7 +77,7 @@ $seam->acs->systems->list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -91,7 +91,7 @@ seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 220fea9d0..93fdd17fb 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -7,7 +7,7 @@ PUT /acs/users/add_to_access_group ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.users.addToAccessGroup({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 20a37cbdf..2641bb68e 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -7,7 +7,7 @@ POST /acs/users/create ⇒ { acs_user } Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -35,7 +35,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -63,7 +63,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -91,7 +91,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -121,7 +121,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -144,7 +144,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go @@ -173,7 +173,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 ``` {% endtab %} -{% tab title="JavaScript" %} +{% tabs %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -205,7 +206,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -237,7 +238,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -269,7 +270,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -303,7 +304,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -326,7 +327,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go @@ -356,7 +357,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 ``` {% endtab %} -{% tab title="JavaScript" %} +{% tabs %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -385,7 +387,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -414,7 +416,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -443,7 +445,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -474,7 +476,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -497,7 +499,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index fcae60e5b..dce805a1a 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -7,7 +7,7 @@ POST /acs/users/delete ⇒ void Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.acs.users.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -66,7 +66,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -80,7 +80,7 @@ seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 997149da3..f02cebce3 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -7,7 +7,7 @@ POST /acs/users/get ⇒ { acs_user } Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -32,7 +32,7 @@ await seam.acs.users.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -55,7 +55,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -78,7 +78,7 @@ seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -103,7 +103,7 @@ $seam->acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -126,7 +126,7 @@ seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index b23c5a49e..d5939d529 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -7,7 +7,7 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -30,7 +30,7 @@ await seam.acs.users.list(); ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -53,7 +53,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -76,7 +76,7 @@ seam.acs.users.list() ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -101,7 +101,7 @@ $seam->acs->users->list(); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -124,7 +124,7 @@ seam acs users list ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 7a5808809..90412f2b7 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -7,7 +7,7 @@ POST /acs/users/remove_from_access_group ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.users.removeFromAccessGroup({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 3e7988c69..841c5bf23 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -7,7 +7,7 @@ POST /acs/users/suspend ⇒ void [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.acs.users.suspend({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -66,7 +66,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -80,7 +80,7 @@ seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index e2f624dd0..07baad2b3 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -7,7 +7,7 @@ POST /acs/users/unsuspend ⇒ void [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.acs.users.unsuspend({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -68,7 +68,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -82,7 +82,7 @@ seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index dccb7c8af..19d4df4e1 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -7,7 +7,7 @@ PATCH /acs/users/update ⇒ void Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.acs.users.update({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -40,7 +40,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -57,7 +57,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -75,7 +75,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -89,7 +89,7 @@ seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --pho ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 2f654e1d3..8400c4589 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -7,7 +7,7 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.thermostats.activateClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -48,7 +48,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -69,7 +69,7 @@ seam.thermostats.activate_climate_preset( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -92,7 +92,7 @@ $seam->thermostats->activate_climate_preset( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -110,7 +110,7 @@ seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-42 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 9794da83a..905835b43 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -7,7 +7,7 @@ POST /thermostats/cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.thermostats.cool({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -48,7 +48,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -69,7 +69,7 @@ seam.thermostats.cool( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -92,7 +92,7 @@ $seam->thermostats->cool( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -110,7 +110,7 @@ seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooli ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 069c4b3c5..862b657e4 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -7,7 +7,7 @@ POST /thermostats/create_climate_preset ⇒ void Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -30,7 +30,7 @@ await seam.thermostats.createClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -53,7 +53,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -76,7 +76,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -100,7 +100,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -114,7 +114,7 @@ seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 570123781..d862f9094 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -7,7 +7,7 @@ POST /thermostats/delete_climate_preset ⇒ void Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.thermostats.deleteClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -40,7 +40,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -57,7 +57,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -75,7 +75,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -89,7 +89,7 @@ seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index bb1189645..f77d3f637 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -7,7 +7,7 @@ POST /thermostats/heat ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.thermostats.heat({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -48,7 +48,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -69,7 +69,7 @@ seam.thermostats.heat( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -92,7 +92,7 @@ $seam->thermostats->heat( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -110,7 +110,7 @@ seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heati ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index e29392489..6d8a9b3e4 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -7,7 +7,7 @@ POST /thermostats/heat_cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -29,7 +29,7 @@ await seam.thermostats.heatCool({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -51,7 +51,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -73,7 +73,7 @@ seam.thermostats.heat_cool( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -97,7 +97,7 @@ $seam->thermostats->heat_cool( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -115,7 +115,7 @@ seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" -- ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index f0adedbe6..40f4daa30 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -7,7 +7,7 @@ POST /thermostats/list ⇒ { devices: [device, …] } Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -44,7 +44,7 @@ await seam.thermostats.list(); ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -81,7 +81,7 @@ seam.thermostats.list() ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -118,7 +118,7 @@ seam.thermostats.list() ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -162,7 +162,7 @@ $seam->thermostats->list(); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -199,7 +199,7 @@ seam thermostats list ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 0242bd842..e447ba0a6 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -7,7 +7,7 @@ POST /thermostats/off ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -27,7 +27,7 @@ await seam.thermostats.off({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -45,7 +45,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -63,7 +63,7 @@ seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -83,7 +83,7 @@ $seam->thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -101,7 +101,7 @@ seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 834ad88a1..6e15e4043 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -7,7 +7,7 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -36,7 +36,7 @@ await seam.thermostats.schedules.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -65,7 +65,7 @@ ThermostatSchedule( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -94,7 +94,7 @@ seam.thermostats.schedules.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -125,7 +125,7 @@ $seam->thermostats->schedules->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -147,7 +147,7 @@ seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index ca4fc4575..fa2febb2a 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -7,7 +7,7 @@ POST /thermostats/schedules/delete ⇒ void Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.thermostats.schedules.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -39,7 +39,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -53,7 +53,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -70,7 +70,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -84,7 +84,7 @@ seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 1534426d7..be6d39e57 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -7,7 +7,7 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -31,7 +31,7 @@ await seam.thermostats.schedules.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -55,7 +55,7 @@ ThermostatSchedule( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -77,7 +77,7 @@ seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b- ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -103,7 +103,7 @@ $seam->thermostats->schedules->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -125,7 +125,7 @@ seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 3ee8d7463..f61fdaaee 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -7,7 +7,7 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -42,7 +42,7 @@ await seam.thermostats.schedules.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -75,7 +75,7 @@ seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -108,7 +108,7 @@ seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -145,7 +145,7 @@ $seam->thermostats->schedules->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -178,7 +178,7 @@ seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-42661417400 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 3c72f533a..773774b87 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -7,7 +7,7 @@ PATCH /thermostats/schedules/update ⇒ void Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.thermostats.schedules.update({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 2cbfe3e09..248ac1b00 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -7,7 +7,7 @@ POST /thermostats/set_fallback_climate_preset ⇒ void Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.thermostats.setFallbackClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -40,7 +40,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -57,7 +57,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -75,7 +75,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -89,7 +89,7 @@ seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a45 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 8f42e6633..f07e2ccc8 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -7,7 +7,7 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -28,7 +28,7 @@ await seam.thermostats.setFanMode({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -48,7 +48,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -69,7 +69,7 @@ seam.thermostats.set_fan_mode( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -92,7 +92,7 @@ $seam->thermostats->set_fan_mode( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -110,7 +110,7 @@ seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 05e2f4bb8..92cd1cefa 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -7,7 +7,7 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -30,7 +30,7 @@ await seam.thermostats.setHvacMode({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -53,7 +53,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -76,7 +76,7 @@ seam.thermostats.set_hvac_mode( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -101,7 +101,7 @@ $seam->thermostats->set_hvac_mode( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -119,7 +119,7 @@ seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index ca66a4ecc..0ff0003f3 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -7,7 +7,7 @@ PATCH /thermostats/set_temperature_threshold ⇒ void Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -25,7 +25,7 @@ await seam.thermostats.setTemperatureThreshold({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -43,7 +43,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -61,7 +61,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -80,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -94,7 +94,7 @@ seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456- ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 777f9bc9e..8c5d6022b 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -7,7 +7,7 @@ PATCH /thermostats/update_climate_preset ⇒ void Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -26,7 +26,7 @@ await seam.thermostats.updateClimatePreset({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -45,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -64,7 +64,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -84,7 +84,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -98,7 +98,7 @@ seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index af928ae44..90421eeef 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -7,7 +7,7 @@ PUT /user_identities/add_acs_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.userIdentities.addAcsUser({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0b ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 817473e5c..4326f5640 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -7,7 +7,7 @@ POST /user_identities/create ⇒ { user_identity } Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -35,7 +35,7 @@ await seam.userIdentities.create({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -63,7 +63,7 @@ UserIdentity( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -91,7 +91,7 @@ seam.user_identities.create( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -121,7 +121,7 @@ $seam->user_identities->create( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -144,7 +144,7 @@ seam user-identities create --user_identity_key "jean_doe" --email_address "jean ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 2bdc55ac5..0c0720b35 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -7,7 +7,7 @@ POST /user_identities/delete ⇒ void Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.userIdentities.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -37,7 +37,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -51,7 +51,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -68,7 +68,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -82,7 +82,7 @@ seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceec ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 2e1962b93..54cbe59d3 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -7,7 +7,7 @@ POST /user_identities/enrollment_automations/delete ⇒ void Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -23,7 +23,7 @@ await seam.userIdentities.enrollmentAutomations.delete({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -39,7 +39,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -55,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -72,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -86,7 +86,7 @@ seam user-identities enrollment-automations delete --enrollment_automation_id "0 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index b53917f31..67530c3e3 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -7,7 +7,7 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -31,7 +31,7 @@ await seam.userIdentities.enrollmentAutomations.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -55,7 +55,7 @@ EnrollmentAutomation( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -79,7 +79,7 @@ seam.user_identities.enrollment_automations.get( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -107,7 +107,7 @@ $seam->user_identities->enrollment_automations->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -129,7 +129,7 @@ seam user-identities enrollment-automations get --enrollment_automation_id "0550 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 5dc340903..a23e5b103 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -7,7 +7,7 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -34,7 +34,7 @@ await seam.userIdentities.enrollmentAutomations.launch({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -61,7 +61,7 @@ Unknown( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -88,7 +88,7 @@ seam.user_identities.enrollment_automations.launch( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -119,7 +119,7 @@ $seam->user_identities->enrollment_automations->launch( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -141,7 +141,7 @@ seam user-identities enrollment-automations launch --user_identity_id "5c945ab5- ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 8ed1a89c7..49009f4fc 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -7,7 +7,7 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -33,7 +33,7 @@ await seam.userIdentities.enrollmentAutomations.list({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -59,7 +59,7 @@ seam.user_identities.enrollment_automations.list( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -85,7 +85,7 @@ seam.user_identities.enrollment_automations.list( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -115,7 +115,7 @@ $seam->user_identities->enrollment_automations->list( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -139,7 +139,7 @@ seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c7 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index a76dbf454..001cd912a 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -7,7 +7,7 @@ POST /user_identities/get ⇒ { user_identity } Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -32,7 +32,7 @@ await seam.userIdentities.get({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -55,7 +55,7 @@ UserIdentity( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -78,7 +78,7 @@ seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -105,7 +105,7 @@ $seam->user_identities->get( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -128,7 +128,7 @@ seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index b5121cc74..b63120782 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -7,7 +7,7 @@ PUT /user_identities/grant_access_to_device ⇒ void Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.userIdentities.grantAccessToDevice({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-43 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 7044c7aaa..e23c138b8 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -7,7 +7,7 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -32,7 +32,7 @@ await seam.userIdentities.list(); ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -57,7 +57,7 @@ seam.user_identities.list() ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -82,7 +82,7 @@ seam.user_identities.list() ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -109,7 +109,7 @@ $seam->user_identities->list(); ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -134,7 +134,7 @@ seam user-identities list ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index e84acbefb..65f9c77fe 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -7,7 +7,7 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -75,7 +75,7 @@ await seam.userIdentities.listAccessibleDevices({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -143,7 +143,7 @@ seam.user_identities.list_accessible_devices( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -215,7 +215,7 @@ seam.user_identities.list_accessible_devices( ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -292,7 +292,7 @@ $seam->user_identities->list_accessible_devices( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -358,7 +358,7 @@ seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 27b7403e1..b16202e11 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -7,7 +7,7 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -35,7 +35,7 @@ await seam.userIdentities.listAcsSystems({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -63,7 +63,7 @@ seam.user_identities.list_acs_systems( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -89,7 +89,7 @@ seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -119,7 +119,7 @@ $seam->user_identities->list_acs_systems( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -145,7 +145,7 @@ seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index d585f3090..de3f8bdc1 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -7,7 +7,7 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -37,7 +37,7 @@ await seam.userIdentities.listAcsUsers({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -67,7 +67,7 @@ seam.user_identities.list_acs_users( ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -95,7 +95,7 @@ seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0 ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -127,7 +127,7 @@ $seam->user_identities->list_acs_users( ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -155,7 +155,7 @@ seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5- ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 9ddac01d2..348533b75 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -7,7 +7,7 @@ POST /user_identities/remove_acs_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.userIdentities.removeAcsUser({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index bf09b47be..9d9de2ef4 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -7,7 +7,7 @@ POST /user_identities/revoke_access_to_device ⇒ void Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% tabs %} -{% tab title="JavaScript" %} +{% tab title="JavaScript TEST" %} #### Request ```javascript @@ -24,7 +24,7 @@ await seam.userIdentities.revokeAccessToDevice({ ``` {% endtab %} -{% tab title="Python" %} +{% tab title="Python TEST" %} #### Request ```python @@ -41,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby" %} +{% tab title="Ruby TEST" %} #### Request ```ruby @@ -58,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP" %} +{% tab title="PHP TEST" %} #### Request ```php @@ -76,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI" %} +{% tab title="Seam CLI TEST" %} #### Request ```seam_cli @@ -90,7 +90,7 @@ seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4 ``` {% endtab %} -{% tab title="Go" %} +{% tab title="Go TEST" %} #### Request ```go From 8ec7f59eb13e4210963f8ad56dd029c5cd7e2b85 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:50:09 -0400 Subject: [PATCH 020/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 695fd5015..0cef66c32 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -8,9 +8,13 @@ {{#if codeSamples.length}} {{#each codeSamples}} +## {{this.title}} + +{{this.description}} + {% tabs %} {{#each this.code}} -{% tab title="{{this.title}} TEST" %} +{% tab title="{{this.title}}" %} #### Request ```{{@key}} @@ -24,10 +28,9 @@ ``` {% endtab %} -{{/each}} {{/each}} {% endtabs %} - +{{/each}} {{/if}} {{#if authMethods}} ## Authentication Methods From 09dcacca88df8b67dea44ffd7aac2a66ff9fed1f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:51:09 +0000 Subject: [PATCH 021/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 17 ++++--- docs/api/acs/access_groups/get.md | 17 ++++--- docs/api/acs/access_groups/list.md | 17 ++++--- .../list_accessible_entrances.md | 17 ++++--- docs/api/acs/access_groups/list_users.md | 17 ++++--- docs/api/acs/access_groups/remove_user.md | 17 ++++--- docs/api/acs/credentials/assign.md | 17 ++++--- docs/api/acs/credentials/create.md | 17 ++++--- docs/api/acs/credentials/delete.md | 17 ++++--- docs/api/acs/credentials/get.md | 17 ++++--- docs/api/acs/credentials/list.md | 17 ++++--- .../credentials/list_accessible_entrances.md | 17 ++++--- docs/api/acs/credentials/unassign.md | 17 ++++--- docs/api/acs/credentials/update.md | 17 ++++--- docs/api/acs/entrances/get.md | 17 ++++--- docs/api/acs/entrances/list.md | 17 ++++--- .../entrances/list_credentials_with_access.md | 17 ++++--- docs/api/acs/systems/get.md | 17 ++++--- docs/api/acs/systems/list.md | 17 ++++--- ...mpatible_credential_manager_acs_systems.md | 17 ++++--- docs/api/acs/users/add_to_access_group.md | 17 ++++--- docs/api/acs/users/create.md | 51 ++++++++++++------- docs/api/acs/users/delete.md | 17 ++++--- docs/api/acs/users/get.md | 17 ++++--- docs/api/acs/users/list.md | 17 ++++--- .../api/acs/users/remove_from_access_group.md | 17 ++++--- docs/api/acs/users/suspend.md | 17 ++++--- docs/api/acs/users/unsuspend.md | 17 ++++--- docs/api/acs/users/update.md | 17 ++++--- .../thermostats/activate_climate_preset.md | 17 ++++--- docs/api/thermostats/cool.md | 17 ++++--- docs/api/thermostats/create_climate_preset.md | 17 ++++--- docs/api/thermostats/delete_climate_preset.md | 17 ++++--- docs/api/thermostats/heat.md | 17 ++++--- docs/api/thermostats/heat_cool.md | 17 ++++--- docs/api/thermostats/list.md | 17 ++++--- docs/api/thermostats/off.md | 17 ++++--- docs/api/thermostats/schedules/create.md | 17 ++++--- docs/api/thermostats/schedules/delete.md | 17 ++++--- docs/api/thermostats/schedules/get.md | 17 ++++--- docs/api/thermostats/schedules/list.md | 17 ++++--- docs/api/thermostats/schedules/update.md | 17 ++++--- .../set_fallback_climate_preset.md | 17 ++++--- docs/api/thermostats/set_fan_mode.md | 17 ++++--- docs/api/thermostats/set_hvac_mode.md | 17 ++++--- .../thermostats/set_temperature_threshold.md | 17 ++++--- docs/api/thermostats/update_climate_preset.md | 17 ++++--- docs/api/user_identities/add_acs_user.md | 17 ++++--- docs/api/user_identities/create.md | 17 ++++--- docs/api/user_identities/delete.md | 17 ++++--- .../enrollment_automations/delete.md | 17 ++++--- .../enrollment_automations/get.md | 17 ++++--- .../enrollment_automations/launch.md | 17 ++++--- .../enrollment_automations/list.md | 17 ++++--- docs/api/user_identities/get.md | 17 ++++--- .../user_identities/grant_access_to_device.md | 17 ++++--- docs/api/user_identities/list.md | 17 ++++--- .../list_accessible_devices.md | 17 ++++--- docs/api/user_identities/list_acs_systems.md | 17 ++++--- docs/api/user_identities/list_acs_users.md | 17 ++++--- docs/api/user_identities/remove_acs_user.md | 17 ++++--- .../revoke_access_to_device.md | 17 ++++--- 62 files changed, 642 insertions(+), 446 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index ec8c530c7..2c7bf69b6 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -6,8 +6,12 @@ PUT /acs/access_groups/add_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Add an ACS user to an access group + +Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.accessGroups.addUser({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-4 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index a2322f7ce..e206f704c 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -6,8 +6,12 @@ POST /acs/access_groups/get ⇒ { acs_access_group } Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Get a specific access group + +Specify the `acs_access_group_id` of the access group that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -34,7 +38,7 @@ await seam.acs.accessGroups.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -59,7 +63,7 @@ AcsAccessGroup( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -84,7 +88,7 @@ seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-4444444 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -113,7 +117,7 @@ $seam->acs->access_groups->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -138,7 +142,7 @@ seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -165,7 +169,6 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 4864901b8..70efeda96 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -6,8 +6,12 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## List access groups + +To filter the list of access groups, include an `acs_system_id` or `acs_user_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -37,7 +41,7 @@ await seam.acs.accessGroups.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -67,7 +71,7 @@ seam.acs.access_groups.list( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -97,7 +101,7 @@ seam.acs.access_groups.list( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -129,7 +133,7 @@ $seam->acs->access_groups->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -156,7 +160,7 @@ seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-11111111111 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -184,7 +188,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 6eaa6c4d8..46e0fb964 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -6,8 +6,12 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## List accessible entrances for an access group + +Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -32,7 +36,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -57,7 +61,7 @@ seam.acs.access_groups.list_accessible_entrances( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -82,7 +86,7 @@ seam.acs.access_groups.list_accessible_entrances( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -109,7 +113,7 @@ $seam->acs->access_groups->list_accessible_entrances( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -132,7 +136,7 @@ seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -159,7 +163,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index ddad886c1..d099bf156 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -6,8 +6,12 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## List ACS users in an access group + +Specify the `acs_access_group_id` to retrieve all ACS users in an access group. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -44,7 +48,7 @@ await seam.acs.accessGroups.listUsers({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -81,7 +85,7 @@ seam.acs.access_groups.list_users( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -116,7 +120,7 @@ seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444- ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -155,7 +159,7 @@ $seam->acs->access_groups->list_users( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -190,7 +194,7 @@ seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -217,7 +221,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 2eca16489..161a62830 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -6,8 +6,12 @@ POST /acs/access_groups/remove_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Remove an ACS user from an access group + +Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.accessGroups.removeUser({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-444 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 834f543b3..53f6ed344 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -6,8 +6,12 @@ PATCH /acs/credentials/assign ⇒ void Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Assign a credential to an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.credentials.assign({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 01a2b4434..db9ddf2e3 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -6,8 +6,12 @@ POST /acs/credentials/create ⇒ { acs_credential } Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Create a credential for an ACS user + +Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -42,7 +46,7 @@ await seam.acs.credentials.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -77,7 +81,7 @@ AcsCredential( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -112,7 +116,7 @@ seam.acs.credentials.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -149,7 +153,7 @@ $seam->acs->credentials->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -173,7 +177,7 @@ seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -206,7 +210,6 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 16de68075..17dc00afb 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -6,8 +6,12 @@ POST /acs/credentials/delete ⇒ void Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +## Delete a credential + +Specify the desired `acs_credential_id` to delete the specified credential. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.acs.credentials.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -68,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -82,7 +86,7 @@ seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-6666666 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -109,7 +113,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index bb1217312..d98f72ca4 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -6,8 +6,12 @@ POST /acs/credentials/get ⇒ { acs_credential } Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +## Get a credential + +Specify the `acs_credential_id` of the credential that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -33,7 +37,7 @@ await seam.acs.credentials.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -57,7 +61,7 @@ AcsCredential( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -81,7 +85,7 @@ seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-66666666666 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -109,7 +113,7 @@ $seam->acs->credentials->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -133,7 +137,7 @@ seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-6666666666 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -160,7 +164,6 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index e2ad59fb8..3f9791c47 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -6,8 +6,12 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). +## List credentials + +Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -38,7 +42,7 @@ await seam.acs.credentials.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -69,7 +73,7 @@ seam.acs.credentials.list( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -100,7 +104,7 @@ seam.acs.credentials.list( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -133,7 +137,7 @@ $seam->acs->credentials->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -159,7 +163,7 @@ seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" - ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -189,7 +193,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 5db94f202..a77cf978d 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -6,8 +6,12 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. +## List accessible entrances + +Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -42,7 +46,7 @@ await seam.acs.credentials.listAccessibleEntrances({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -77,7 +81,7 @@ seam.acs.credentials.list_accessible_entrances( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -107,7 +111,7 @@ seam.acs.credentials.list_accessible_entrances( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -144,7 +148,7 @@ $seam->acs->credentials->list_accessible_entrances( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -177,7 +181,7 @@ seam acs credentials list-accessible-entrances --acs_credential_id "66666666-666 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -204,7 +208,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 264c237db..e7fa89f16 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -6,8 +6,12 @@ PATCH /acs/credentials/unassign ⇒ void Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Unassign a credential from an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.credentials.unassign({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-33333333333 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index c6721e70d..2d8502e70 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -6,8 +6,12 @@ PATCH /acs/credentials/update ⇒ void Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +## Update a credential + +Specify the desired `acs_credential_id` and updated `code` to update the credential. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.credentials.update({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -40,7 +44,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -54,7 +58,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -72,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -86,7 +90,7 @@ seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-6666666 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -114,7 +118,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 734bd8887..3d5c4d908 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -6,8 +6,12 @@ POST /acs/entrances/get ⇒ { acs_entrance } Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +## Get an entrance + +Specify the `acs_entrance_id` of the entrance that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.acs.entrances.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -47,7 +51,7 @@ AcsEntrance( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -66,7 +70,7 @@ seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -89,7 +93,7 @@ $seam->acs->entrances->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -108,7 +112,7 @@ seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -135,7 +139,6 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 54fcee250..5d3eec62d 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -6,8 +6,12 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). +## List entrances + +To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.acs.entrances.list(); ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -49,7 +53,7 @@ seam.acs.entrances.list() ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -70,7 +74,7 @@ seam.acs.entrances.list() ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -93,7 +97,7 @@ $seam->acs->entrances->list(); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -114,7 +118,7 @@ seam acs entrances list ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -133,7 +137,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 053d62a32..6f96ce7fe 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -6,8 +6,12 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +## List credentials with access to an entrance + +Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -46,7 +50,7 @@ await seam.acs.entrances.listCredentialsWithAccess({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -85,7 +89,7 @@ seam.acs.entrances.list_credentials_with_access( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -124,7 +128,7 @@ seam.acs.entrances.list_credentials_with_access( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -166,7 +170,7 @@ $seam->acs->entrances->list_credentials_with_access( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -203,7 +207,7 @@ seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -230,7 +234,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index e1fa0bbaa..63a4959ca 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -8,8 +8,12 @@ Returns a specified [access control system](https://docs.seam.co/latest/capabili Specify the desired access control system by including the corresponding `acs_system_id` in the request body. +## Get a Specific ACS system + +Specify the `acs_system_id` of the ACS system that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -25,7 +29,7 @@ await seam.acs.systems.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -39,7 +43,7 @@ seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -53,7 +57,7 @@ seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -69,7 +73,7 @@ $seam->acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -83,7 +87,7 @@ seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -110,7 +114,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 32b1ab1fc..aade874d2 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -10,8 +10,12 @@ To filter the list of returned access control systems by a specific connected ac `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. +## List ACS systems by connected account + +To filter the list of ACS systems, include a `connected_account_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -27,7 +31,7 @@ await seam.acs.systems.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -55,7 +59,7 @@ seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-42661417400 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -73,7 +77,7 @@ $seam->acs->systems->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -87,7 +91,7 @@ seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-4266141740 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -114,7 +118,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index c5a3e276a..6db41acc3 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -10,8 +10,12 @@ Returns a list of all credential manager ACS systems that are compatible with a Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. +## List compatible credential manager ACS systems + +Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -27,7 +31,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -43,7 +47,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -59,7 +63,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -77,7 +81,7 @@ $seam->acs->systems->list_compatible_credential_manager_acs_systems( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -91,7 +95,7 @@ seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 93fdd17fb..e1b640b59 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -6,8 +6,12 @@ PUT /acs/users/add_to_access_group ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Add an ACS user to an access group + +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.users.addToAccessGroup({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 2641bb68e..5213f5e45 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -6,8 +6,12 @@ POST /acs/users/create ⇒ { acs_user } Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -35,7 +39,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -63,7 +67,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -91,7 +95,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -121,7 +125,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -144,7 +148,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -173,8 +177,13 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 ``` {% endtab %} +{% endtabs %} +## Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -206,7 +215,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -238,7 +247,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -270,7 +279,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -304,7 +313,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -327,7 +336,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -357,8 +366,13 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 ``` {% endtab %} +{% endtabs %} +## Create a new ACS user in an access group + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -387,7 +401,7 @@ await seam.acs.users.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -416,7 +430,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -445,7 +459,7 @@ seam.acs.users.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -476,7 +490,7 @@ $seam->acs->users->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -499,7 +513,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -530,7 +544,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index dce805a1a..ae6f78535 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -6,8 +6,12 @@ POST /acs/users/delete ⇒ void Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). +## Delete an ACS user + +Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.acs.users.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -66,7 +70,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -80,7 +84,7 @@ seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -107,7 +111,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index f02cebce3..48b33f7b5 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -6,8 +6,12 @@ POST /acs/users/get ⇒ { acs_user } Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Get a specific ACS user + +Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -32,7 +36,7 @@ await seam.acs.users.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -55,7 +59,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -78,7 +82,7 @@ seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -103,7 +107,7 @@ $seam->acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -126,7 +130,7 @@ seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -153,7 +157,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index d5939d529..f0a22d044 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -6,8 +6,12 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## List all ACS users + +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -30,7 +34,7 @@ await seam.acs.users.list(); ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -53,7 +57,7 @@ AcsUser( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -76,7 +80,7 @@ seam.acs.users.list() ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -101,7 +105,7 @@ $seam->acs->users->list(); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -124,7 +128,7 @@ seam acs users list ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -143,7 +147,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 90412f2b7..b66a08f2b 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -6,8 +6,12 @@ POST /acs/users/remove_from_access_group ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Remove an ACS user from an access group + +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.users.removeFromAccessGroup({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 841c5bf23..e49074db2 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -6,8 +6,12 @@ POST /acs/users/suspend ⇒ void [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. +## Suspend an ACS user + +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.acs.users.suspend({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -66,7 +70,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -80,7 +84,7 @@ seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -107,7 +111,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 07baad2b3..8ca3d0f22 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -6,8 +6,12 @@ POST /acs/users/unsuspend ⇒ void [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. +## Unsuspend an ACS user + +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.acs.users.unsuspend({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -68,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -82,7 +86,7 @@ seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -109,7 +113,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 19d4df4e1..2b0b499e1 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -6,8 +6,12 @@ PATCH /acs/users/update ⇒ void Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Update an ACS user + +Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.acs.users.update({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -40,7 +44,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -57,7 +61,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -75,7 +79,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -89,7 +93,7 @@ seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --pho ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 8400c4589..958544873 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -6,8 +6,12 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Activate a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.thermostats.activateClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -48,7 +52,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -69,7 +73,7 @@ seam.thermostats.activate_climate_preset( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -92,7 +96,7 @@ $seam->thermostats->activate_climate_preset( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -110,7 +114,7 @@ seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-42 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -137,7 +141,6 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 905835b43..cbd50743e 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -6,8 +6,12 @@ POST /thermostats/cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +## Set to cool mode + +Specify the desired cooling set point in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.thermostats.cool({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -48,7 +52,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -69,7 +73,7 @@ seam.thermostats.cool( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -92,7 +96,7 @@ $seam->thermostats->cool( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -110,7 +114,7 @@ seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooli ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -137,7 +141,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 862b657e4..f89b97c88 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -6,8 +6,12 @@ POST /thermostats/create_climate_preset ⇒ void Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Create a climate preset + +Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -30,7 +34,7 @@ await seam.thermostats.createClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -53,7 +57,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -76,7 +80,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -100,7 +104,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -114,7 +118,7 @@ seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -147,7 +151,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index d862f9094..05dadf8a3 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -6,8 +6,12 @@ POST /thermostats/delete_climate_preset ⇒ void Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Delete a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.thermostats.deleteClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -40,7 +44,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -57,7 +61,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -75,7 +79,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -89,7 +93,7 @@ seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -116,7 +120,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index f77d3f637..4fec06289 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -6,8 +6,12 @@ POST /thermostats/heat ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +## Set to heat mode + +Specify the desired heating set point in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.thermostats.heat({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -48,7 +52,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -69,7 +73,7 @@ seam.thermostats.heat( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -92,7 +96,7 @@ $seam->thermostats->heat( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -110,7 +114,7 @@ seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heati ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -137,7 +141,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 6d8a9b3e4..b1b660f81 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -6,8 +6,12 @@ POST /thermostats/heat_cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +## Set to heat-cool (auto) mode + +Specify the desired heating set point in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -29,7 +33,7 @@ await seam.thermostats.heatCool({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -51,7 +55,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -73,7 +77,7 @@ seam.thermostats.heat_cool( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -97,7 +101,7 @@ $seam->thermostats->heat_cool( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -115,7 +119,7 @@ seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" -- ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -143,7 +147,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 40f4daa30..f1b56dd92 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -6,8 +6,12 @@ POST /thermostats/list ⇒ { devices: [device, …] } Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). +## List thermostats + +To filter the list of returned thermostats, specify the desired parameters. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -44,7 +48,7 @@ await seam.thermostats.list(); ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -81,7 +85,7 @@ seam.thermostats.list() ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -118,7 +122,7 @@ seam.thermostats.list() ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -162,7 +166,7 @@ $seam->thermostats->list(); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -199,7 +203,7 @@ seam thermostats list ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -218,7 +222,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index e447ba0a6..143fb0841 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -6,8 +6,12 @@ POST /thermostats/off ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +## Set to off mode + +Specify the `device_id` of the thermostat that you want to set to off mode. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -27,7 +31,7 @@ await seam.thermostats.off({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -45,7 +49,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -63,7 +67,7 @@ seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -83,7 +87,7 @@ $seam->thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -101,7 +105,7 @@ seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -127,7 +131,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 6e15e4043..77b3445f7 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -6,8 +6,12 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Create a thermostat schedule + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -36,7 +40,7 @@ await seam.thermostats.schedules.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -65,7 +69,7 @@ ThermostatSchedule( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -94,7 +98,7 @@ seam.thermostats.schedules.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -125,7 +129,7 @@ $seam->thermostats->schedules->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -147,7 +151,7 @@ seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -179,7 +183,6 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746 {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index fa2febb2a..7f7532003 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -6,8 +6,12 @@ POST /thermostats/schedules/delete ⇒ void Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Delete a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.thermostats.schedules.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -39,7 +43,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -53,7 +57,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -70,7 +74,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -84,7 +88,7 @@ seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -111,7 +115,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index be6d39e57..b75581bc5 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -6,8 +6,12 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +## Get a specific thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -31,7 +35,7 @@ await seam.thermostats.schedules.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -55,7 +59,7 @@ ThermostatSchedule( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -77,7 +81,7 @@ seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b- ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -103,7 +107,7 @@ $seam->thermostats->schedules->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -125,7 +129,7 @@ seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -152,7 +156,6 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index f61fdaaee..ef5e66b3d 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -6,8 +6,12 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## List thermostat schedules for a thermostat + +Specify the `device_id` of the desired thermostat. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -42,7 +46,7 @@ await seam.thermostats.schedules.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -75,7 +79,7 @@ seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -108,7 +112,7 @@ seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -145,7 +149,7 @@ $seam->thermostats->schedules->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -178,7 +182,7 @@ seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-42661417400 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -205,7 +209,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 773774b87..0889ea147 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -6,8 +6,12 @@ PATCH /thermostats/schedules/update ⇒ void Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +## Update a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.thermostats.schedules.update({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -118,7 +122,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 248ac1b00..24c644ebc 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -6,8 +6,12 @@ POST /thermostats/set_fallback_climate_preset ⇒ void Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Set the fallback climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.thermostats.setFallbackClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -40,7 +44,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -57,7 +61,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -75,7 +79,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -89,7 +93,7 @@ seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a45 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -116,7 +120,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index f07e2ccc8..dfa1bafc1 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -6,8 +6,12 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Set fan mode setting + +Specify the desired fan mode setting. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -28,7 +32,7 @@ await seam.thermostats.setFanMode({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -48,7 +52,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -69,7 +73,7 @@ seam.thermostats.set_fan_mode( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -92,7 +96,7 @@ $seam->thermostats->set_fan_mode( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -110,7 +114,7 @@ seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -137,7 +141,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 92cd1cefa..85f530cf1 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -6,8 +6,12 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Set HVAC mode + +Specify the desired heating and cooling set points in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -30,7 +34,7 @@ await seam.thermostats.setHvacMode({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -53,7 +57,7 @@ ActionAttempt( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -76,7 +80,7 @@ seam.thermostats.set_hvac_mode( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -101,7 +105,7 @@ $seam->thermostats->set_hvac_mode( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -119,7 +123,7 @@ seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -148,7 +152,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 0ff0003f3..e9425a28c 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -6,8 +6,12 @@ PATCH /thermostats/set_temperature_threshold ⇒ void Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. +## Set a temperature threshold + +Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -25,7 +29,7 @@ await seam.thermostats.setTemperatureThreshold({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -43,7 +47,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -61,7 +65,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -80,7 +84,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -94,7 +98,7 @@ seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456- ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -122,7 +126,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 8c5d6022b..186da7b28 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -6,8 +6,12 @@ PATCH /thermostats/update_climate_preset ⇒ void Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +## Update a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -26,7 +30,7 @@ await seam.thermostats.updateClimatePreset({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -45,7 +49,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -64,7 +68,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -84,7 +88,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -98,7 +102,7 @@ seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -127,7 +131,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 90421eeef..3edf37f08 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -6,8 +6,12 @@ PUT /user_identities/add_acs_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Add an ACS user to a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.userIdentities.addAcsUser({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0b ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 4326f5640..188c9bb5a 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -6,8 +6,12 @@ POST /user_identities/create ⇒ { user_identity } Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Create a user identity + +Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -35,7 +39,7 @@ await seam.userIdentities.create({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -63,7 +67,7 @@ UserIdentity( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -91,7 +95,7 @@ seam.user_identities.create( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -121,7 +125,7 @@ $seam->user_identities->create( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -144,7 +148,7 @@ seam user-identities create --user_identity_key "jean_doe" --email_address "jean ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -173,7 +177,6 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 0c0720b35..6a4fee0d4 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -6,8 +6,12 @@ POST /user_identities/delete ⇒ void Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. +## Delete a user identity + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.userIdentities.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -37,7 +41,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -51,7 +55,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -68,7 +72,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -82,7 +86,7 @@ seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceec ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -108,7 +112,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 54cbe59d3..36b0ce73a 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -6,8 +6,12 @@ POST /user_identities/enrollment_automations/delete ⇒ void Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). +## Delete an enrollment automation + +Specify the desired `enrollment_automation_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -23,7 +27,7 @@ await seam.userIdentities.enrollmentAutomations.delete({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -39,7 +43,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -55,7 +59,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -72,7 +76,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -86,7 +90,7 @@ seam user-identities enrollment-automations delete --enrollment_automation_id "0 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -113,7 +117,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 67530c3e3..a5fa0ec7e 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -6,8 +6,12 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). +## Get an enrollment automation + +Specify the desired `enrollment_automation_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -31,7 +35,7 @@ await seam.userIdentities.enrollmentAutomations.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -55,7 +59,7 @@ EnrollmentAutomation( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -79,7 +83,7 @@ seam.user_identities.enrollment_automations.get( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -107,7 +111,7 @@ $seam->user_identities->enrollment_automations->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -129,7 +133,7 @@ seam user-identities enrollment-automations get --enrollment_automation_id "0550 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -156,7 +160,6 @@ api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index a23e5b103..554e8e5c5 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -6,8 +6,12 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). +## Launch an enrollment automation + +Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -34,7 +38,7 @@ await seam.userIdentities.enrollmentAutomations.launch({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -61,7 +65,7 @@ Unknown( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -88,7 +92,7 @@ seam.user_identities.enrollment_automations.launch( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -119,7 +123,7 @@ $seam->user_identities->enrollment_automations->launch( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -141,7 +145,7 @@ seam user-identities enrollment-automations launch --user_identity_id "5c945ab5- ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -171,7 +175,6 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 49009f4fc..1d85c81fb 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -6,8 +6,12 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List enrollment automations + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -33,7 +37,7 @@ await seam.userIdentities.enrollmentAutomations.list({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -59,7 +63,7 @@ seam.user_identities.enrollment_automations.list( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -85,7 +89,7 @@ seam.user_identities.enrollment_automations.list( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -115,7 +119,7 @@ $seam->user_identities->enrollment_automations->list( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -139,7 +143,7 @@ seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c7 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -166,7 +170,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 001cd912a..8cd5b9bfb 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -6,8 +6,12 @@ POST /user_identities/get ⇒ { user_identity } Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Get a user identity + +Specify the `user_identity_id` of the user identity that you want to retrieve. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -32,7 +36,7 @@ await seam.userIdentities.get({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -55,7 +59,7 @@ UserIdentity( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -78,7 +82,7 @@ seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -105,7 +109,7 @@ $seam->user_identities->get( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -128,7 +132,7 @@ seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -154,7 +158,6 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index b63120782..a1a815225 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -6,8 +6,12 @@ PUT /user_identities/grant_access_to_device ⇒ void Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). +## Grant a user identity access to a device + +Specify the desired `user_identity_id` and `device_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.userIdentities.grantAccessToDevice({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-43 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index e23c138b8..a94896839 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -6,8 +6,12 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List user identities + +To filter the list of user identities, specify the desired `credential_manager_acs_system_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -32,7 +36,7 @@ await seam.userIdentities.list(); ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -57,7 +61,7 @@ seam.user_identities.list() ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -82,7 +86,7 @@ seam.user_identities.list() ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -109,7 +113,7 @@ $seam->user_identities->list(); ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -134,7 +138,7 @@ seam user-identities list ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -153,7 +157,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 65f9c77fe..9ac82b8ee 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -6,8 +6,12 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List accessible devices for a user identity + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -75,7 +79,7 @@ await seam.userIdentities.listAccessibleDevices({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -143,7 +147,7 @@ seam.user_identities.list_accessible_devices( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -215,7 +219,7 @@ seam.user_identities.list_accessible_devices( ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -292,7 +296,7 @@ $seam->user_identities->list_accessible_devices( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -358,7 +362,7 @@ seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -384,7 +388,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index b16202e11..9e3de822e 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -6,8 +6,12 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List ACS systems associated with a user identity + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -35,7 +39,7 @@ await seam.userIdentities.listAcsSystems({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -63,7 +67,7 @@ seam.user_identities.list_acs_systems( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -89,7 +93,7 @@ seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -119,7 +123,7 @@ $seam->user_identities->list_acs_systems( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -145,7 +149,7 @@ seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -171,7 +175,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index de3f8bdc1..3cc8ed5c3 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -6,8 +6,12 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## List ACS users for a user identity + +Specify the desired `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -37,7 +41,7 @@ await seam.userIdentities.listAcsUsers({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -67,7 +71,7 @@ seam.user_identities.list_acs_users( ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -95,7 +99,7 @@ seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0 ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -127,7 +131,7 @@ $seam->user_identities->list_acs_users( ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -155,7 +159,7 @@ seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5- ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -181,7 +185,6 @@ func main() { {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 348533b75..a51c702af 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -6,8 +6,12 @@ POST /user_identities/remove_acs_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Remove an ACS user from a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.userIdentities.removeAcsUser({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 9d9de2ef4..a1deac4cc 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -6,8 +6,12 @@ POST /user_identities/revoke_access_to_device ⇒ void Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +## Revoke access to a device from a user identity + +Specify the desired `user_identity_id` and `device_id`. + {% tabs %} -{% tab title="JavaScript TEST" %} +{% tab title="JavaScript" %} #### Request ```javascript @@ -24,7 +28,7 @@ await seam.userIdentities.revokeAccessToDevice({ ``` {% endtab %} -{% tab title="Python TEST" %} +{% tab title="Python" %} #### Request ```python @@ -41,7 +45,7 @@ None ``` {% endtab %} -{% tab title="Ruby TEST" %} +{% tab title="Ruby" %} #### Request ```ruby @@ -58,7 +62,7 @@ nil ``` {% endtab %} -{% tab title="PHP TEST" %} +{% tab title="PHP" %} #### Request ```php @@ -76,7 +80,7 @@ null ``` {% endtab %} -{% tab title="Seam CLI TEST" %} +{% tab title="Seam CLI" %} #### Request ```seam_cli @@ -90,7 +94,7 @@ seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4 ``` {% endtab %} -{% tab title="Go TEST" %} +{% tab title="Go" %} #### Request ```go @@ -117,7 +121,6 @@ nil {% endtab %} {% endtabs %} - ## Authentication Methods - API key From 2d17524790e6a1385ba3584cc494d59fcedf8300 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:53:41 -0400 Subject: [PATCH 022/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 0cef66c32..da03adb50 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -7,7 +7,7 @@ {{{description}}} {{#if codeSamples.length}} -{{#each codeSamples}} +{{#each this.codeSamples}} ## {{this.title}} {{this.description}} From 7b55ca8ab76e417468c39cddc0d1f9d039fe5e3f Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 15:57:14 -0400 Subject: [PATCH 023/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index da03adb50..4b6bee91f 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -30,6 +30,7 @@ {{/each}} {% endtabs %} + {{/each}} {{/if}} {{#if authMethods}} @@ -68,3 +69,35 @@ None {{> api-resource response.actionAttempt headingOffset=true}} {{/if}} + +*** + +## Code Samples + {{#if codeSamples.length}} +{{#each this.codeSamples}} +### {{this.title}} + +{{this.description}} + +{% tabs %} +{{#each this.code}} +{% tab title="{{this.title}}" %} +#### Request + +```{{@key}} +{{this.request}} +``` + +#### Response + +```{{@key}} +{{this.response}} +``` +{% endtab %} + +{{/each}} +{% endtabs %} + +{{/each}} +{{/if}} + From 56fb11c529a95f6e532183784e932c940acdeef1 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 19:58:11 +0000 Subject: [PATCH 024/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 123 ++++ docs/api/acs/access_groups/get.md | 170 ++++++ docs/api/acs/access_groups/list.md | 189 ++++++ .../list_accessible_entrances.md | 164 ++++++ docs/api/acs/access_groups/list_users.md | 222 +++++++ docs/api/acs/access_groups/remove_user.md | 123 ++++ docs/api/acs/credentials/assign.md | 123 ++++ docs/api/acs/credentials/create.md | 211 +++++++ docs/api/acs/credentials/delete.md | 114 ++++ docs/api/acs/credentials/get.md | 165 ++++++ docs/api/acs/credentials/list.md | 194 +++++++ .../credentials/list_accessible_entrances.md | 209 +++++++ docs/api/acs/credentials/unassign.md | 123 ++++ docs/api/acs/credentials/update.md | 119 ++++ docs/api/acs/encoders/encode_credential.md | 5 + docs/api/acs/encoders/list.md | 5 + docs/api/acs/encoders/scan_credential.md | 5 + .../next_credential_encode_will_fail.md | 5 + .../next_credential_encode_will_succeed.md | 5 + .../next_credential_scan_will_fail.md | 5 + .../next_credential_scan_will_succeed.md | 5 + docs/api/acs/entrances/get.md | 140 +++++ docs/api/acs/entrances/grant_access.md | 5 + docs/api/acs/entrances/list.md | 138 +++++ .../entrances/list_credentials_with_access.md | 235 ++++++++ docs/api/acs/systems/get.md | 113 ++++ docs/api/acs/systems/list.md | 115 ++++ ...mpatible_credential_manager_acs_systems.md | 119 ++++ docs/api/acs/users/add_to_access_group.md | 123 ++++ docs/api/acs/users/create.md | 549 ++++++++++++++++++ docs/api/acs/users/delete.md | 112 ++++ docs/api/acs/users/get.md | 158 +++++ docs/api/acs/users/list.md | 148 +++++ .../acs/users/list_accessible_entrances.md | 5 + .../api/acs/users/remove_from_access_group.md | 123 ++++ .../users/revoke_access_to_all_entrances.md | 5 + docs/api/acs/users/suspend.md | 112 ++++ docs/api/acs/users/unsuspend.md | 114 ++++ docs/api/acs/users/update.md | 122 ++++ docs/api/phones/deactivate.md | 5 + docs/api/phones/get.md | 5 + docs/api/phones/list.md | 5 + .../phones/simulate/create_sandbox_phone.md | 5 + .../thermostats/activate_climate_preset.md | 142 +++++ docs/api/thermostats/cool.md | 142 +++++ docs/api/thermostats/create_climate_preset.md | 152 +++++ docs/api/thermostats/delete_climate_preset.md | 121 ++++ docs/api/thermostats/heat.md | 142 +++++ docs/api/thermostats/heat_cool.md | 148 +++++ docs/api/thermostats/list.md | 223 +++++++ docs/api/thermostats/off.md | 132 +++++ docs/api/thermostats/schedules/create.md | 184 ++++++ docs/api/thermostats/schedules/delete.md | 116 ++++ docs/api/thermostats/schedules/get.md | 157 +++++ docs/api/thermostats/schedules/list.md | 210 +++++++ docs/api/thermostats/schedules/update.md | 123 ++++ .../set_fallback_climate_preset.md | 121 ++++ docs/api/thermostats/set_fan_mode.md | 142 +++++ docs/api/thermostats/set_hvac_mode.md | 153 +++++ .../thermostats/set_temperature_threshold.md | 127 ++++ .../simulate/hvac_mode_adjusted.md | 5 + .../simulate/temperature_reached.md | 5 + docs/api/thermostats/update_climate_preset.md | 132 +++++ docs/api/user_identities/add_acs_user.md | 122 ++++ docs/api/user_identities/create.md | 178 ++++++ docs/api/user_identities/delete.md | 113 ++++ .../enrollment_automations/delete.md | 118 ++++ .../enrollment_automations/get.md | 161 +++++ .../enrollment_automations/launch.md | 176 ++++++ .../enrollment_automations/list.md | 171 ++++++ docs/api/user_identities/get.md | 159 +++++ .../user_identities/grant_access_to_device.md | 122 ++++ docs/api/user_identities/list.md | 158 +++++ .../list_accessible_devices.md | 389 +++++++++++++ docs/api/user_identities/list_acs_systems.md | 176 ++++++ docs/api/user_identities/list_acs_users.md | 186 ++++++ docs/api/user_identities/remove_acs_user.md | 122 ++++ .../revoke_access_to_device.md | 122 ++++ docs/api/user_identities/update.md | 5 + 79 files changed, 9895 insertions(+) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 2c7bf69b6..1cb598c03 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired user. ## Return Type void + +*** + +## Code Samples +### Add an ACS user to an access group + +Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.addUser({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.add_user( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + acs_user_id="33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.add_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->add_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.AddUser( + context.Background(), + accessgroups.AccessGroupsAddUserRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index e206f704c..895b39449 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -169,6 +169,7 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -189,3 +190,172 @@ ID of the desired access group. ## Return Type [acs\_access\_group](./) + +*** + +## Code Samples +### Get a specific access group + +Specify the `acs_access_group_id` of the access group that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.get({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +}); +``` + +#### Response + +```javascript +{ + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444") +``` + +#### Response + +```python +AcsAccessGroup( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + name="Lobby Access", + display_name="Lobby Access", + access_group_type_display_name="PTI access level", + access_group_type="pti_access_level", + external_type="pti_access_level", + external_type_display_name="PTI access level", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2023-11-30T06:27:15.437Z", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444") +``` + +#### Response + +```ruby +{ + "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->get( + acs_access_group_id: "44444444-4444-4444-4444-444444444444" +); +``` + +#### Response + +```php + "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444" +``` + +#### Response + +```seam_cli +{ + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.Get( + context.Background(), + accessgroups.AccessGroupsGetRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + }, + ) +} +``` + +#### Response + +```go +api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 70efeda96..8d77f25a4 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -188,6 +188,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -217,3 +218,191 @@ ID of the user for which you want to retrieve all access groups. ## Return Type Array<[acs\_access\_group](./)> + +*** + +## Code Samples +### List access groups + +To filter the list of access groups, include an `acs_system_id` or `acs_user_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.list({ + acs_system_id: "11111111-1111-1111-1111-111111111111", + acs_user_id: "33333333-3333-3333-3333-333333333333", +}); +``` + +#### Response + +```javascript +[ + { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.list( + acs_system_id="11111111-1111-1111-1111-111111111111", + acs_user_id="33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```python +[ + AcsAccessGroup( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + name="Lobby Access", + display_name="Lobby Access", + access_group_type_display_name="PTI access level", + access_group_type="pti_access_level", + external_type="pti_access_level", + external_type_display_name="PTI access level", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2023-11-30T06:27:15.437Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.list( + acs_system_id: "11111111-1111-1111-1111-111111111111", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```ruby +[ + { + "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->list( + acs_system_id: "11111111-1111-1111-1111-111111111111", + acs_user_id: "33333333-3333-3333-3333-333333333333" +); +``` + +#### Response + +```php + "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333" +``` + +#### Response + +```seam_cli +[ + { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.List( + context.Background(), + accessgroups.AccessGroupsListRequest{ + AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 46e0fb964..3f16648fc 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -163,6 +163,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -183,3 +184,166 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Return Type Array<[acs\_entrance](./)> + +*** + +## Code Samples +### List accessible entrances for an access group + +Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.listAccessibleEntrances({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +}); +``` + +#### Response + +```javascript +[ + { + "acs_entrance_id": "66666666-6666-6666-6666-666666666666", + "name": "Main Entrance", + "display_name": "Main Entrance", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-10-15T12:00:00.000Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.list_accessible_entrances( + acs_access_group_id="44444444-4444-4444-4444-444444444444" +) +``` + +#### Response + +```python +[ + AcsEntrance( + acs_entrance_id="66666666-6666-6666-6666-666666666666", + name="Main Entrance", + display_name="Main Entrance", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-10-15T12:00:00.000Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.list_accessible_entrances( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +) +``` + +#### Response + +```ruby +[ + { + "acs_entrance_id" => "66666666-6666-6666-6666-666666666666", + "name" => "Main Entrance", + "display_name" => "Main Entrance", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-10-15T12:00:00.000Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->list_accessible_entrances( + acs_access_group_id: "44444444-4444-4444-4444-444444444444" +); +``` + +#### Response + +```php + "66666666-6666-6666-6666-666666666666", + "name" => "Main Entrance", + "display_name" => "Main Entrance", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-10-15T12:00:00.000Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444" +``` + +#### Response + +```seam_cli +[ + { + "acs_entrance_id": "66666666-6666-6666-6666-666666666666", + "name": "Main Entrance", + "display_name": "Main Entrance", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-10-15T12:00:00.000Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.ListAccessibleEntrances( + context.Background(), + accessgroups.AccessGroupsListAccessibleEntrancesRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index d099bf156..fcc04c210 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -221,6 +221,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -241,3 +242,224 @@ ID of the access group for which you want to retrieve all users. ## Return Type Array<[acs\_user](./)> + +*** + +## Code Samples +### List ACS users in an access group + +Specify the `acs_access_group_id` to retrieve all ACS users in an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.listUsers({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +}); +``` + +#### Response + +```javascript +[ + { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email": "jane@example.com", + "email_address": "jane@example.com", + "phone_number": "+15555550100", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-05T07:14:28.531Z", + "is_suspended": false, + "access_schedule": { + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z" + }, + "user_identity_id": "22222222-2222-2222-2222-222222222222", + "user_identity_full_name": "Jane Doe", + "user_identity_email_address": "jane@example.com", + "user_identity_phone_number": "+15555550100" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.list_users( + acs_access_group_id="44444444-4444-4444-4444-444444444444" +) +``` + +#### Response + +```python +[ + AcsUser( + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Jane Doe", + full_name="Jane Doe", + email="jane@example.com", + email_address="jane@example.com", + phone_number="+15555550100", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-05T07:14:28.531Z", + is_suspended=false, + access_schedule={ + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z", + }, + user_identity_id="22222222-2222-2222-2222-222222222222", + user_identity_full_name="Jane Doe", + user_identity_email_address="jane@example.com", + user_identity_phone_number="+15555550100", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444") +``` + +#### Response + +```ruby +[ + { + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email" => "jane@example.com", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-05T07:14:28.531Z", + "is_suspended" => false, + "access_schedule" => { + starts_at: "2024-03-01T10:40:00.000Z", + ends_at: "2024-03-04T10:40:00.000Z", + }, + "user_identity_id" => "22222222-2222-2222-2222-222222222222", + "user_identity_full_name" => "Jane Doe", + "user_identity_email_address" => "jane@example.com", + "user_identity_phone_number" => "+15555550100", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->list_users( + acs_access_group_id: "44444444-4444-4444-4444-444444444444" +); +``` + +#### Response + +```php + "33333333-3333-3333-3333-333333333333", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email" => "jane@example.com", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-05T07:14:28.531Z", + "is_suspended" => false, + "access_schedule" => [ + "starts_at" => "2024-03-01T10:40:00.000Z", + "ends_at" => "2024-03-04T10:40:00.000Z", + ], + "user_identity_id" => "22222222-2222-2222-2222-222222222222", + "user_identity_full_name" => "Jane Doe", + "user_identity_email_address" => "jane@example.com", + "user_identity_phone_number" => "+15555550100", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444" +``` + +#### Response + +```seam_cli +[ + { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email": "jane@example.com", + "email_address": "jane@example.com", + "phone_number": "+15555550100", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-05T07:14:28.531Z", + "is_suspended": false, + "access_schedule": { + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z" + }, + "user_identity_id": "22222222-2222-2222-2222-222222222222", + "user_identity_full_name": "Jane Doe", + "user_identity_email_address": "jane@example.com", + "user_identity_phone_number": "+15555550100" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.ListUsers( + context.Background(), + accessgroups.AccessGroupsListUsersRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 161a62830..6d62b1086 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired user. ## Return Type void + +*** + +## Code Samples +### Remove an ACS user from an access group + +Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.accessGroups.removeUser({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.access_groups.remove_user( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + acs_user_id="33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.access_groups.remove_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->access_groups->remove_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.RemoveUser( + context.Background(), + accessgroups.AccessGroupsRemoveUserRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 53f6ed344..86e4d2907 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired user. ## Return Type void + +*** + +## Code Samples +### Assign a credential to an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.assign({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.assign( + acs_user_id="33333333-3333-3333-3333-333333333333", + acs_credential_id="66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.assign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->assign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Assign( + context.Background(), + credentials.CredentialsAssignRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index db9ddf2e3..24f92bcba 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -210,6 +210,7 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -320,3 +321,213 @@ Visionline-specific metadata for the new credential. ## Return Type [acs\_credential](./) + +*** + +## Code Samples +### Create a credential for an ACS user + +Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.create({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + access_method: "mobile_key", + allowed_acs_entrance_ids: [ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000", + ], + credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential: true, + starts_at: "2024-03-01T10:40:00Z", + ends_at: "2024-03-04T10:40:00Z", +}); +``` + +#### Response + +```javascript +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "88888888-8888-8888-8888-888888888888", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.create( + acs_user_id="33333333-3333-3333-3333-333333333333", + access_method="mobile_key", + allowed_acs_entrance_ids=[ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000", + ], + credential_manager_acs_system_id="88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential=true, + starts_at="2024-03-01T10:40:00Z", + ends_at="2024-03-04T10:40:00Z", +) +``` + +#### Response + +```python +AcsCredential( + acs_credential_id="99999999-9999-9999-9999-999999999999", + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Multi Phone Sync Credential", + code=None, + acs_system_id="88888888-8888-8888-8888-888888888888", + access_method="mobile_key", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-12T03:56:22.396Z", + is_multi_phone_sync_credential=true, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.create( + acs_user_id: "33333333-3333-3333-3333-333333333333", + access_method: "mobile_key", + allowed_acs_entrance_ids: %w[ + 55555555-5555-5555-5555-555555555555 + 55555555-5555-5555-5555-000000000000 + ], + credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential: true, + starts_at: "2024-03-01T10:40:00Z", + ends_at: "2024-03-04T10:40:00Z", +) +``` + +#### Response + +```ruby +{ + "acs_credential_id" => "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => nil, + "acs_system_id" => "88888888-8888-8888-8888-888888888888", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->create( + acs_user_id: "33333333-3333-3333-3333-333333333333", + access_method: "mobile_key", + allowed_acs_entrance_ids: [ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000", + ], + credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential: true, + starts_at: "2024-03-01T10:40:00Z", + ends_at: "2024-03-04T10:40:00Z" +); +``` + +#### Response + +```php + "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => null, + "acs_system_id" => "88888888-8888-8888-8888-888888888888", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z" +``` + +#### Response + +```seam_cli +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "88888888-8888-8888-8888-888888888888", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Create( + context.Background(), + credentials.CredentialsCreateRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AccessMethod: api.String("mobile_key"), + AllowedAcsEntranceIds: [2]string{api.String("55555555-5555-5555-5555-555555555555"), api.String("55555555-5555-5555-5555-000000000000")}, + CredentialManagerAcsSystemId: api.String("88888888-8888-8888-8888-888888888888"), + IsMultiPhoneSyncCredential: api.Bool(true), + StartsAt: api.String("2024-03-01T10:40:00Z"), + EndsAt: api.String("2024-03-04T10:40:00Z"), + }, + ) +} +``` + +#### Response + +```go +api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 17dc00afb..30abfe8ba 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -113,6 +113,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -133,3 +134,116 @@ ID of the desired credential. ## Return Type void + +*** + +## Code Samples +### Delete a credential + +Specify the desired `acs_credential_id` to delete the specified credential. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.delete({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->delete( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Delete( + context.Background(), + credentials.CredentialsDeleteRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index d98f72ca4..8bde9999a 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -164,6 +164,7 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -184,3 +185,167 @@ ID of the desired credential. ## Return Type [acs\_credential](./) + +*** + +## Code Samples +### Get a credential + +Specify the `acs_credential_id` of the credential that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.get({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666") +``` + +#### Response + +```python +AcsCredential( + acs_credential_id="99999999-9999-9999-9999-999999999999", + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Multi Phone Sync Credential", + code=None, + acs_system_id="11111111-1111-1111-1111-111111111111", + access_method="mobile_key", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-12T03:56:22.396Z", + is_multi_phone_sync_credential=true, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666") +``` + +#### Response + +```ruby +{ + "acs_credential_id" => "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => nil, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->get( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php + "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => null, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Get( + context.Background(), + credentials.CredentialsGetRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 3f9791c47..c560e2c19 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -193,6 +193,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -259,3 +260,196 @@ ID of the user identity for which you want to retrieve all credentials. ## Return Type Array<[acs\_credential](./)> + +*** + +## Code Samples +### List credentials + +Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.list({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_system_id: "11111111-1111-1111-1111-111111111111", + user_identity_id: "22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential: true, +}); +``` + +#### Response + +```javascript +[ + { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.list( + acs_user_id="33333333-3333-3333-3333-333333333333", + acs_system_id="11111111-1111-1111-1111-111111111111", + user_identity_id="22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential=true, +) +``` + +#### Response + +```python +[ + AcsCredential( + acs_credential_id="99999999-9999-9999-9999-999999999999", + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Multi Phone Sync Credential", + code=None, + acs_system_id="11111111-1111-1111-1111-111111111111", + access_method="mobile_key", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-12T03:56:22.396Z", + is_multi_phone_sync_credential=true, + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.list( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_system_id: "11111111-1111-1111-1111-111111111111", + user_identity_id: "22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential: true, +) +``` + +#### Response + +```ruby +[ + { + "acs_credential_id" => "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => nil, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->list( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_system_id: "11111111-1111-1111-1111-111111111111", + user_identity_id: "22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential: true +); +``` + +#### Response + +```php + "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => null, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true +``` + +#### Response + +```seam_cli +[ + { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.List( + context.Background(), + credentials.CredentialsListRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), + UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"), + IsMultiPhoneSyncCredential: api.Bool(true), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index a77cf978d..db591cb57 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -208,6 +208,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -228,3 +229,211 @@ ID of the credential for which you want to retrieve all entrances to which this ## Return Type Array<[acs\_entrance](./)> + +*** + +## Code Samples +### List accessible entrances + +Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.listAccessibleEntrances({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +[ + { + "acs_entrance_id": "55555555-5555-5555-5555-555555555555", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "visionline_metadata": { + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE" + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest" + }, + "latch_metadata": null, + "display_name": "Guest Lock 2", + "created_at": "2024-03-26T14:31:18.979Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.list_accessible_entrances( + acs_credential_id="66666666-6666-6666-6666-666666666666" +) +``` + +#### Response + +```python +[ + AcsEntrance( + acs_entrance_id="55555555-5555-5555-5555-555555555555", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + visionline_metadata={ + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE", + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest", + }, + latch_metadata=None, + display_name="Guest Lock 2", + created_at="2024-03-26T14:31:18.979Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.list_accessible_entrances( + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```ruby +[ + { + "acs_entrance_id" => "55555555-5555-5555-5555-555555555555", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "visionline_metadata" => { + profiles: [{ visionline_door_profile_id: "Guest Door", visionline_door_profile_type: "BLE" }], + door_name: "Guest Lock 2", + door_category: "guest", + }, + "latch_metadata" => nil, + "display_name" => "Guest Lock 2", + "created_at" => "2024-03-26T14:31:18.979Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->list_accessible_entrances( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php + "55555555-5555-5555-5555-555555555555", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "visionline_metadata" => [ + "profiles" => [ + [ + "visionline_door_profile_id" => "Guest Door", + "visionline_door_profile_type" => "BLE", + ], + ], + "door_name" => "Guest Lock 2", + "door_category" => "guest", + ], + "latch_metadata" => null, + "display_name" => "Guest Lock 2", + "created_at" => "2024-03-26T14:31:18.979Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +[ + { + "acs_entrance_id": "55555555-5555-5555-5555-555555555555", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "visionline_metadata": { + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE" + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest" + }, + "latch_metadata": null, + "display_name": "Guest Lock 2", + "created_at": "2024-03-26T14:31:18.979Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.ListAccessibleEntrances( + context.Background(), + credentials.CredentialsListAccessibleEntrancesRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index e7fa89f16..ad72bdeed 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired user. ## Return Type void + +*** + +## Code Samples +### Unassign a credential from an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.unassign({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.unassign( + acs_user_id="33333333-3333-3333-3333-333333333333", + acs_credential_id="66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.unassign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->unassign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Unassign( + context.Background(), + credentials.CredentialsUnassignRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 2d8502e70..fdeefde3f 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -118,6 +118,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -156,3 +157,121 @@ Replacement date and time at which the validity of the credential ends, in [ISO ## Return Type void + +*** + +## Code Samples +### Update a credential + +Specify the desired `acs_credential_id` and updated `code` to update the credential. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.credentials.update({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", + code: "7890", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.credentials.update( + acs_credential_id="66666666-6666-6666-6666-666666666666", code="7890" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->credentials->update( + acs_credential_id: "66666666-6666-6666-6666-666666666666", + code: "7890" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Update( + context.Background(), + credentials.CredentialsUpdateRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + Code: api.String("7890"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 5a6a6b23a..0cb53296e 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -69,3 +69,8 @@ Possible enum values: --- + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 5705eee18..65b013eda 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -53,3 +53,8 @@ Number of `acs_encoders` to return. ## Return Type Array<[acs\_encoder](./)> + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index b84d478c2..89afb83e8 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -58,3 +58,8 @@ Possible enum values: --- + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 5f919c365..1fc31bb28 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -44,3 +44,8 @@ Code of the error to simulate. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index dd3a7fbee..8243a680d 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -35,3 +35,8 @@ Scenario to simulate. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 8a3333506..b73df5e5c 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -44,3 +44,8 @@ Required: No ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 92f05df53..ca507296d 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -44,3 +44,8 @@ Scenario to simulate. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 3d5c4d908..395eb7118 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -139,6 +139,7 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -158,3 +159,142 @@ Required: Yes ## Return Type [acs\_entrance](./) + +*** + +## Code Samples +### Get an entrance + +Specify the `acs_entrance_id` of the entrance that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.entrances.get({ + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +{ + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```python +AcsEntrance( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="text", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```ruby +{ + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->entrances->get( + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +{ + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import entrances "github.com/seamapi/go/entrances" + +func main() { + client.Acs.Entrances.Get( + context.Background(), + entrances.EntrancesGetRequest{ + AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 8ea04aa67..931f14017 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -35,3 +35,8 @@ Required: Yes ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 5d3eec62d..8d621ea4d 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -137,6 +137,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -167,3 +168,140 @@ Required: No ## Return Type Array<[acs\_entrance](./)> + +*** + +## Code Samples +### List entrances + +To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.entrances.list(); +``` + +#### Response + +```javascript +[ + { + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.entrances.list() +``` + +#### Response + +```python +[ + AcsEntrance( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="text", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.entrances.list() +``` + +#### Response + +```ruby +[ + { + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->entrances->list(); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs entrances list +``` + +#### Response + +```seam_cli +[ + { + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +func main() { + client.Acs.Entrances.List(context.Background()) +} +``` + +#### Response + +```go +[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6f96ce7fe..6dc4a8e12 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -234,6 +234,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -264,3 +265,237 @@ Required: No ## Return Type Array<[acs\_credential](./)> + +*** + +## Code Samples +### List credentials with access to an entrance + +Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.entrances.listCredentialsWithAccess({ + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +[ + { + "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "display_name": "text", + "code": "text", + "card_number": "text", + "is_issued": false, + "issued_at": "2024-10-15T12:54:04.155Z", + "access_method": "code", + "external_type": "pti_card", + "external_type_display_name": "text", + "created_at": "2024-10-15T12:54:04.155Z", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "starts_at": "text", + "ends_at": "text", + "is_multi_phone_sync_credential": false, + "is_latest_desired_state_synced_with_provider": false, + "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.entrances.list_credentials_with_access( + acs_entrance_id="123e4567-e89b-12d3-a456-426614174000" +) +``` + +#### Response + +```python +[ + AcsCredential( + acs_credential_id="123e4567-e89b-12d3-a456-426614174000", + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_credential_pool_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + parent_acs_credential_id="123e4567-e89b-12d3-a456-426614174000", + display_name="text", + code="text", + card_number="text", + is_issued=false, + issued_at="2024-10-15T12:54:04.155Z", + access_method="code", + external_type="pti_card", + external_type_display_name="text", + created_at="2024-10-15T12:54:04.155Z", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + starts_at="text", + ends_at="text", + is_multi_phone_sync_credential=false, + is_latest_desired_state_synced_with_provider=false, + latest_desired_state_synced_with_provider_at="2024-10-15T12:54:04.155Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.entrances.list_credentials_with_access( + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```ruby +[ + { + "acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", + "display_name" => "text", + "code" => "text", + "card_number" => "text", + "is_issued" => false, + "issued_at" => "2024-10-15T12:54:04.155Z", + "access_method" => "code", + "external_type" => "pti_card", + "external_type_display_name" => "text", + "created_at" => "2024-10-15T12:54:04.155Z", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "starts_at" => "text", + "ends_at" => "text", + "is_multi_phone_sync_credential" => false, + "is_latest_desired_state_synced_with_provider" => false, + "latest_desired_state_synced_with_provider_at" => "2024-10-15T12:54:04.155Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->entrances->list_credentials_with_access( + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", + "display_name" => "text", + "code" => "text", + "card_number" => "text", + "is_issued" => false, + "issued_at" => "2024-10-15T12:54:04.155Z", + "access_method" => "code", + "external_type" => "pti_card", + "external_type_display_name" => "text", + "created_at" => "2024-10-15T12:54:04.155Z", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "starts_at" => "text", + "ends_at" => "text", + "is_multi_phone_sync_credential" => false, + "is_latest_desired_state_synced_with_provider" => false, + "latest_desired_state_synced_with_provider_at" => + "2024-10-15T12:54:04.155Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +[ + { + "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "display_name": "text", + "code": "text", + "card_number": "text", + "is_issued": false, + "issued_at": "2024-10-15T12:54:04.155Z", + "access_method": "code", + "external_type": "pti_card", + "external_type_display_name": "text", + "created_at": "2024-10-15T12:54:04.155Z", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "starts_at": "text", + "ends_at": "text", + "is_multi_phone_sync_credential": false, + "is_latest_desired_state_synced_with_provider": false, + "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import entrances "github.com/seamapi/go/entrances" + +func main() { + client.Acs.Entrances.ListCredentialsWithAccess( + context.Background(), + entrances.EntrancesListCredentialsWithAccessRequest{ + AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 63a4959ca..6d230071b 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -114,6 +114,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -134,3 +135,115 @@ ID of the desired access control system. ## Return Type [acs\_system](./) + +*** + +## Code Samples +### Get a Specific ACS system + +Specify the `acs_system_id` of the ACS system that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.systems.get({ + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Response + +```php + "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import systems "github.com/seamapi/go/systems" + +func main() { + client.Acs.Systems.Get( + context.Background(), + systems.SystemsGetRequest{ + AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index aade874d2..77276f01e 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -118,6 +118,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -139,3 +140,117 @@ ID of the connected account by which to filter the list of returned access contr ## Return Type Array<[acs\_system](./)> + +*** + +## Code Samples +### List ACS systems by connected account + +To filter the list of ACS systems, include a `connected_account_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.systems.list({ + connected_account_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```python +[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```ruby +[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->systems->list( + connected_account_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php + "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import systems "github.com/seamapi/go/systems" + +func main() { + client.Acs.Systems.List( + context.Background(), + systems.SystemsListRequest{ + ConnectedAccountId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 6db41acc3..a918d9b67 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -122,6 +122,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -142,3 +143,121 @@ ID of the ACS system for which you want to retrieve all compatible credential ma ## Return Type Array<[acs\_system](./)> + +*** + +## Code Samples +### List compatible credential manager ACS systems + +Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.systems.list_compatible_credential_manager_acs_systems( + acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33" +) +``` + +#### Response + +```python +[AcsSystem(acs_system_id="aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4")] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.systems.list_compatible_credential_manager_acs_systems( + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +) +``` + +#### Response + +```ruby +[{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->systems->list_compatible_credential_manager_acs_systems( + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +); +``` + +#### Response + +```php + "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"]]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import systems "github.com/seamapi/go/systems" + +func main() { + client.Acs.Systems.ListCompatibleCredentialManagerAcsSystems( + context.Background(), + systems.SystemsListCompatibleCredentialManagerAcsSystemsRequest{ + AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index e1b640b59..22ba0d052 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Add an ACS user to an access group + +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.addToAccessGroup({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.add_to_access_group( + acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.add_to_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->add_to_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.AddToAccessGroup( + context.Background(), + users.UsersAddToAccessGroupRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 5213f5e45..912003eea 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -178,6 +178,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Create a new ACS user Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. @@ -367,6 +368,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Create a new ACS user in an access group Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). @@ -544,6 +546,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -627,3 +630,549 @@ ID of the user identity with which to associate the new `acs_user`. ## Return Type [acs\_user](./) + +*** + +## Code Samples +### Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + +### Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", + access_schedule={ + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: [ + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-04T11:00:00.000Z", + ] +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"} +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + AccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String("2024-11-01T15:00:00.000Z"), EndsAt: api.String("2024-11-04T11:00:00.000Z")}, + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + +### Create a new ACS user in an access group + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", + acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"], +) +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], +) +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"] +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"] +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")}, + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index ae6f78535..0605b8f8b 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -111,6 +111,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -131,3 +132,114 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Delete an ACS user + +Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.delete({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Delete( + context.Background(), + users.UsersDeleteRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 48b33f7b5..0a3661c38 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -157,6 +157,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -177,3 +178,160 @@ ID of the desired `acs_user`. ## Return Type [acs\_user](./) + +*** + +## Code Samples +### Get a specific ACS user + +Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.get({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Get( + context.Background(), + users.UsersGetRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index f0a22d044..64e97c1a2 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -147,6 +147,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -231,3 +232,150 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s ## Return Type Array<[acs\_user](./)> + +*** + +## Code Samples +### List all ACS users + +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.list(); +``` + +#### Response + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.list() +``` + +#### Response + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.list() +``` + +#### Response + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->list(); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users list +``` + +#### Response + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +func main() { + client.Acs.Users.List(context.Background()) +} +``` + +#### Response + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index c5c4ad636..7d977b4b6 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -27,3 +27,8 @@ ID of the desired `acs_user`. ## Return Type Array<[acs\_entrance](./)> + +*** + +## Code Samples + diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index b66a08f2b..2987c3a99 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -151,3 +152,125 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Remove an ACS user from an access group + +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.removeFromAccessGroup({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.remove_from_access_group( + acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.remove_from_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->remove_from_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.RemoveFromAccessGroup( + context.Background(), + users.UsersRemoveFromAccessGroupRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 8a5357160..03f020b54 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -26,3 +26,8 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index e49074db2..79cda84ba 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -111,6 +111,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -131,3 +132,114 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Suspend an ACS user + +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.suspend({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Suspend( + context.Background(), + users.UsersSuspendRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 8ca3d0f22..7f8bf93e7 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -113,6 +113,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -133,3 +134,116 @@ ID of the desired `acs_user`. ## Return Type void + +*** + +## Code Samples +### Unsuspend an ACS user + +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.unsuspend({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->unsuspend( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Unsuspend( + context.Background(), + users.UsersUnsuspendRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 2b0b499e1..354c24786 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -195,3 +196,124 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc ## Return Type void + +*** + +## Code Samples +### Update an ACS user + +Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.acs.users.update({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: "+15555550222", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.acs.users.update( + acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", phone_number="+15555550222" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.acs.users.update( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: "+15555550222", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +acs->users->update( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: "+15555550222" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Update( + context.Background(), + users.UsersUpdateRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + PhoneNumber: api.String("+15555550222"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 00de709b3..ed1250399 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -27,3 +27,8 @@ Device ID of the desired phone. ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 1c06ba47a..48e060396 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -26,3 +26,8 @@ Device ID of the desired phone. ## Return Type [phone](./) + +*** + +## Code Samples + diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index d0e79e40a..bfab017d9 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,3 +35,8 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type Array<[phone](./)> + +*** + +## Code Samples + diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index a1e393a65..ddff632a6 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -53,3 +53,8 @@ Metadata to associate with the simulated phone. ## Return Type [phone](./) + +*** + +## Code Samples + diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 958544873..f8da1445f 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -141,6 +141,7 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -202,3 +203,144 @@ Possible enum values: --- + +*** + +## Code Samples +### Activate a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.activateClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", + "status": "pending", + "action_type": "ACTIVATE_CLIMATE_PRESET" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.activate_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="05de2295-d1dc-4748-aae3-9931658bde20", + status="pending", + action_type="ACTIVATE_CLIMATE_PRESET", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.activate_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20", + "status" => "pending", + "action_type" => "ACTIVATE_CLIMATE_PRESET", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->activate_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied" +); +``` + +#### Response + +```php + "05de2295-d1dc-4748-aae3-9931658bde20", + "status" => "pending", + "action_type" => "ACTIVATE_CLIMATE_PRESET", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", + "status": "pending", + "action_type": "ACTIVATE_CLIMATE_PRESET" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.ActivateClimatePreset( + context.Background(), + api.ThermostatsActivateClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index cbd50743e..f7a1997a9 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -141,6 +141,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -212,3 +213,144 @@ Possible enum values: --- + +*** + +## Code Samples +### Set to cool mode + +Specify the desired cooling set point in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.cool({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_COOL" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.cool( + device_id="123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius=25 +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_COOL", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_COOL", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25 +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_COOL", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_COOL" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.Cool( + context.Background(), + api.ThermostatsCoolRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + CoolingSetPointCelsius: api.Float64(25), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index f89b97c88..3186ba867 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -151,6 +151,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -253,3 +254,154 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void + +*** + +## Code Samples +### Create a climate preset + +Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.createClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + name: "Occupied", + fan_mode_setting: "auto", + hvac_mode_setting: "heat_cool", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, + manual_override_allowed: true, +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.create_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", + climate_preset_key="occupied", + name="Occupied", + fan_mode_setting="auto", + hvac_mode_setting="heat_cool", + cooling_set_point_celsius=25, + heating_set_point_celsius=20, + manual_override_allowed=true, +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.create_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + name: "Occupied", + fan_mode_setting: "auto", + hvac_mode_setting: "heat_cool", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, + manual_override_allowed: true, +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->create_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + name: "Occupied", + fan_mode_setting: "auto", + hvac_mode_setting: "heat_cool", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, + manual_override_allowed: true +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.CreateClimatePreset( + context.Background(), + api.ThermostatsCreateClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + Name: api.String("Occupied"), + FanModeSetting: api.String("auto"), + HvacModeSetting: api.String("heat_cool"), + CoolingSetPointCelsius: api.Float64(25), + HeatingSetPointCelsius: api.Float64(20), + ManualOverrideAllowed: api.Bool(true), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 05dadf8a3..76b3092c2 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -120,6 +120,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,123 @@ ID of the desired thermostat device. ## Return Type void + +*** + +## Code Samples +### Delete a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.deleteClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.delete_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.delete_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->delete_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.DeleteClimatePreset( + context.Background(), + api.ThermostatsDeleteClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 4fec06289..9fa86fb74 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -141,6 +141,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -212,3 +213,144 @@ Possible enum values: --- + +*** + +## Code Samples +### Set to heat mode + +Specify the desired heating set point in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.heat({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 20, +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.heat( + device_id="123e4567-e89b-12d3-a456-426614174000", heating_set_point_celsius=20 +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_HEAT", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.heat( + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 20, +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->heat( + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 20 +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20 +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.Heat( + context.Background(), + api.ThermostatsHeatRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + HeatingSetPointCelsius: api.Float64(20), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index b1b660f81..1e2893482 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -147,6 +147,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -236,3 +237,150 @@ Possible enum values: --- + +*** + +## Code Samples +### Set to heat-cool (auto) mode + +Specify the desired heating set point in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.heatCool({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT_COOL" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.heat_cool( + device_id="123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius=25, + heating_set_point_celsius=20, +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_HEAT_COOL", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.heat_cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT_COOL", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->heat_cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20 +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT_COOL", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT_COOL" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.HeatCool( + context.Background(), + api.ThermostatsHeatCoolRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + CoolingSetPointCelsius: api.Float64(25), + HeatingSetPointCelsius: api.Float64(20), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index f1b56dd92..b6fa1bd64 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -222,6 +222,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -333,3 +334,225 @@ Your own internal user ID for the user by which to filter devices. ## Return Type Array<[device](./)> + +*** + +## Code Samples +### List thermostats + +To filter the list of returned thermostats, specify the desired parameters. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.list(); +``` + +#### Response + +```javascript +[ + { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "device_type": "ecobee_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z" + } + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.list() +``` + +#### Response + +```python +[ + Device( + device_id="123e4567-e89b-12d3-a456-426614174000", + device_type="ecobee_thermostat", + capabilities_supported=["thermostat"], + properties={ + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false, + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + }, + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.list() +``` + +#### Response + +```ruby +[ + { + "device_id" => "123e4567-e89b-12d3-a456-426614174000", + "device_type" => "ecobee_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => { + name: "Entryway", + online: "true,", + relative_humidity: 0.36, + temperature_farenheit: 70, + available_hvac_mode_settings: %w[cool heat heat_cool off], + current_climate_setting: { + hvac_mode_setting: "heat_cool", + cooling_set_point_farenheit: 75, + heating_set_point_farenheit: 65, + manual_override_allowed: false, + }, + location: null, + connected_account_id: "123e4567-e89b-12d3-a456-426614174000", + workspace_id: "123e4567-e89b-12d3-a456-426614174000", + created_at: "2024-04-05T07:57:05.323Z", + }, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->list(); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "device_type" => "ecobee_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => [ + "name" => "Entryway", + "online" => "true,", + "relative_humidity" => 0.36, + "temperature_farenheit" => 70, + "available_hvac_mode_settings" => [ + "cool", + "heat", + "heat_cool", + "off", + ], + "current_climate_setting" => [ + "hvac_mode_setting" => "heat_cool", + "cooling_set_point_farenheit" => 75, + "heating_set_point_farenheit" => 65, + "manual_override_allowed" => false, + ], + "location" => null, + "connected_account_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + ], + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats list +``` + +#### Response + +```seam_cli +[ + { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "device_type": "ecobee_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z" + } + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +func main() { + client.Thermostats.List(context.Background()) +} +``` + +#### Response + +```go +[]api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 143fb0841..ab5ef8d14 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -131,6 +131,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -184,3 +185,134 @@ Possible enum values: --- + +*** + +## Code Samples +### Set to off mode + +Specify the `device_id` of the thermostat that you want to set to off mode. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.off({ + device_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_THERMOSTAT_OFF" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_THERMOSTAT_OFF", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_THERMOSTAT_OFF", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_THERMOSTAT_OFF", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_THERMOSTAT_OFF" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.Off( + context.Background(), + api.ThermostatsOffRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 77b3445f7..a58997c78 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -183,6 +183,7 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746 {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -258,3 +259,186 @@ User-friendly name to identify the thermostat schedule. ## Return Type [thermostat\_schedule](./) + +*** + +## Code Samples +### Create a thermostat schedule + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.create({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + name: "Reservation 1", + climate_preset_key: "occupied", + starts_at: "2024-11-01T15:00:00Z", + ends_at: "2024-11-05T12:00:00Z", + max_override_period_minutes: 90, +}); +``` + +#### Response + +```javascript +{ + "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name": "Reservation 1", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-05T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.create( + device_id="123e4567-e89b-12d3-a456-426614174000", + name="Reservation 1", + climate_preset_key="occupied", + starts_at="2024-11-01T15:00:00Z", + ends_at="2024-11-05T12:00:00Z", + max_override_period_minutes=90, +) +``` + +#### Response + +```python +ThermostatSchedule( + thermostat_schedule_id="56d29fcf-0674-4db5-8e03-b2370a77460a", + name="Reservation 1", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-01T15:00:00.000Z", + ends_at="2024-11-05T12:00:00.000Z", + max_override_period_minutes=90, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.create( + device_id: "123e4567-e89b-12d3-a456-426614174000", + name: "Reservation 1", + climate_preset_key: "occupied", + starts_at: "2024-11-01T15:00:00Z", + ends_at: "2024-11-05T12:00:00Z", + max_override_period_minutes: 90, +) +``` + +#### Response + +```ruby +{ + "thermostat_schedule_id" => "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name" => "Reservation 1", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-05T12:00:00.000Z", + "max_override_period_minutes" => 90, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->create( + device_id: "123e4567-e89b-12d3-a456-426614174000", + name: "Reservation 1", + climate_preset_key: "occupied", + starts_at: "2024-11-01T15:00:00Z", + ends_at: "2024-11-05T12:00:00Z", + max_override_period_minutes: 90 +); +``` + +#### Response + +```php + "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name" => "Reservation 1", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-05T12:00:00.000Z", + "max_override_period_minutes" => 90, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90 +``` + +#### Response + +```seam_cli +{ + "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name": "Reservation 1", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-05T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Create( + context.Background(), + schedules.SchedulesCreateRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + Name: api.String("Reservation 1"), + ClimatePresetKey: api.String("occupied"), + StartsAt: api.String("2024-11-01T15:00:00Z"), + EndsAt: api.String("2024-11-05T12:00:00Z"), + MaxOverridePeriodMinutes: api.Float64(90), + }, + ) +} +``` + +#### Response + +```go +api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 7f7532003..4b8337d2e 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -115,6 +115,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -136,3 +137,118 @@ ID of the desired thermostat schedule. ## Return Type void + +*** + +## Code Samples +### Delete a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.delete({ + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.delete( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->delete( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Delete( + context.Background(), + schedules.SchedulesDeleteRequest{ + ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index b75581bc5..32b0c1b1a 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -156,6 +156,7 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -177,3 +178,159 @@ ID of the desired thermostat schedule. ## Return Type [thermostat\_schedule](./) + +*** + +## Code Samples +### Get a specific thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.get({ + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", +}); +``` + +#### Response + +```javascript +{ + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.get( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" +) +``` + +#### Response + +```python +ThermostatSchedule( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", + name="Reservation 2", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-10T15:00:00.000Z", + ends_at="2024-11-15T12:00:00.000Z", + max_override_period_minutes=90, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") +``` + +#### Response + +```ruby +{ + "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->get( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +); +``` + +#### Response + +```php + "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +``` + +#### Response + +```seam_cli +{ + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Get( + context.Background(), + schedules.SchedulesGetRequest{ + ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), + }, + ) +} +``` + +#### Response + +```go +api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index ef5e66b3d..3919e321d 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -209,6 +209,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -239,3 +240,212 @@ User identifier key by which to filter the list of returned thermostat schedules ## Return Type Array<[thermostat\_schedule](./)> + +*** + +## Code Samples +### List thermostat schedules for a thermostat + +Specify the `device_id` of the desired thermostat. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.list({ + device_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Response + +```javascript +[ + { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 + }, + { + "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", + "name": "Reservation 3", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-16T15:00:00.000Z", + "ends_at": "2024-11-18T12:00:00.000Z", + "max_override_period_minutes": 90 + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```python +[ + ThermostatSchedule( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", + name="Reservation 2", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-10T15:00:00.000Z", + ends_at="2024-11-15T12:00:00.000Z", + max_override_period_minutes=90, + ), + ThermostatSchedule( + thermostat_schedule_id="665553d1-94f9-4e92-9739-06ac6362c959", + name="Reservation 3", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-16T15:00:00.000Z", + ends_at="2024-11-18T12:00:00.000Z", + max_override_period_minutes=90, + ), +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Response + +```ruby +[ + { + "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, + }, + { + "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", + "name" => "Reservation 3", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-16T15:00:00.000Z", + "ends_at" => "2024-11-18T12:00:00.000Z", + "max_override_period_minutes" => 90, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->list( + device_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Response + +```php + "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, + ], + [ + "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", + "name" => "Reservation 3", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-16T15:00:00.000Z", + "ends_at" => "2024-11-18T12:00:00.000Z", + "max_override_period_minutes" => 90, + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Response + +```seam_cli +[ + { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 + }, + { + "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", + "name": "Reservation 3", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-16T15:00:00.000Z", + "ends_at": "2024-11-18T12:00:00.000Z", + "max_override_period_minutes": 90 + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.List( + context.Background(), + schedules.SchedulesListRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Response + +```go +[]api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 0889ea147..d981dc510 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -122,6 +122,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -197,3 +198,125 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www ## Return Type void + +*** + +## Code Samples +### Update a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.schedules.update({ + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.schedules.update( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at="2024-11-15T15:00:00Z", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.schedules.update( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->schedules->update( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Update( + context.Background(), + schedules.SchedulesUpdateRequest{ + ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), + EndsAt: api.String("2024-11-15T15:00:00Z"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 24c644ebc..b2d3ae442 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -120,6 +120,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -149,3 +150,123 @@ ID of the desired thermostat device. ## Return Type void + +*** + +## Code Samples +### Set the fallback climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.setFallbackClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.set_fallback_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="eco" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.set_fallback_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->set_fallback_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetFallbackClimatePreset( + context.Background(), + api.ThermostatsSetFallbackClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("eco"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index dfa1bafc1..b7fdd5477 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -141,6 +141,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -212,3 +213,144 @@ Possible enum values: --- + +*** + +## Code Samples +### Set fan mode setting + +Specify the desired fan mode setting. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.setFanMode({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + fan_mode_setting: "auto", +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_FAN_MODE" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.set_fan_mode( + device_id="123e4567-e89b-12d3-a456-426614174000", fan_mode_setting="auto" +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_FAN_MODE", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.set_fan_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + fan_mode_setting: "auto", +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_FAN_MODE", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->set_fan_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + fan_mode_setting: "auto" +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_FAN_MODE", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto" +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_FAN_MODE" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetFanMode( + context.Background(), + api.ThermostatsSetFanModeRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FanModeSetting: api.String("auto"), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 85f530cf1..56a428823 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -152,6 +152,7 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -250,3 +251,155 @@ Possible enum values: --- + +*** + +## Code Samples +### Set HVAC mode + +Specify the desired heating and cooling set points in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.setHvacMode({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting: "heat_cool", + heating_set_point_celsius: 20, + cooling_set_point_celsius: 25, +}); +``` + +#### Response + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "success", + "action_type": "SET_HVAC_MODE" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.set_hvac_mode( + device_id="123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting="heat_cool", + heating_set_point_celsius=20, + cooling_set_point_celsius=25, +) +``` + +#### Response + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="success", + action_type="SET_HVAC_MODE", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.set_hvac_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting: "heat_cool", + heating_set_point_celsius: 20, + cooling_set_point_celsius: 25, +) +``` + +#### Response + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "success", + "action_type" => "SET_HVAC_MODE", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->set_hvac_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting: "heat_cool", + heating_set_point_celsius: 20, + cooling_set_point_celsius: 25 +); +``` + +#### Response + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "success", + "action_type" => "SET_HVAC_MODE", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25 +``` + +#### Response + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "success", + "action_type": "SET_HVAC_MODE" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetHvacMode( + context.Background(), + api.ThermostatsSetHvacModeRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + HvacModeSetting: api.String("heat_cool"), + HeatingSetPointCelsius: api.Float64(20), + CoolingSetPointCelsius: api.Float64(25), + }, + ) +} +``` + +#### Response + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index e9425a28c..e6e122407 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -126,6 +126,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -182,3 +183,129 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i ## Return Type void + +*** + +## Code Samples +### Set a temperature threshold + +Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.setTemperatureThreshold({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30, +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.set_temperature_threshold( + device_id="123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius=4, + upper_limit_celsius=30, +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.set_temperature_threshold( + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30, +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->set_temperature_threshold( + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30 +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30 +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetTemperatureThreshold( + context.Background(), + api.ThermostatsSetTemperatureThresholdRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + LowerLimitCelsius: api.Float64(4), + UpperLimitCelsius: api.Float64(30), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 490f7e8a4..5d17e66bc 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -71,3 +71,8 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 467b35d50..0176847da 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -44,3 +44,8 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` ## Return Type void + +*** + +## Code Samples + diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 186da7b28..a40dc8972 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -131,6 +131,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -233,3 +234,134 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void + +*** + +## Code Samples +### Update a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.thermostats.updateClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + cooling_set_point_celsius: 24, + manual_override_allowed: true, +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.thermostats.update_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", + climate_preset_key="occupied", + cooling_set_point_celsius=24, + manual_override_allowed=true, +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.thermostats.update_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + cooling_set_point_celsius: 24, + manual_override_allowed: true, +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +thermostats->update_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + cooling_set_point_celsius: 24, + manual_override_allowed: true +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.UpdateClimatePreset( + context.Background(), + api.ThermostatsUpdateClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + CoolingSetPointCelsius: api.Float64(24), + ManualOverrideAllowed: api.Bool(true), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 3edf37f08..266811c1e 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,124 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Add an ACS user to a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.addAcsUser({ + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.add_acs_user( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.add_acs_user( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->add_acs_user( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.AddAcsUser( + context.Background(), + api.UserIdentitiesAddAcsUserRequest{ + UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), + AcsUserId: api.String("4d223973-0874-4831-8630-bfcb29e6bce0"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 188c9bb5a..e459f32d0 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -177,6 +177,7 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -224,3 +225,180 @@ Unique key for the user identity. ## Return Type [user\_identity](./) + +*** + +## Code Samples +### Create a user identity + +Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.create({ + user_identity_key: "jean_doe", + email_address: "jean@example.com", + phone_number: "+15555550110", + full_name: "Jean Doe", +}); +``` + +#### Response + +```javascript +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.create( + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + full_name="Jean Doe", +) +``` + +#### Response + +```python +UserIdentity( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + display_name="Jean Doe", + full_name="Jean Doe", + created_at="2024-01-11T05:37:50.264Z", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.create( + user_identity_key: "jean_doe", + email_address: "jean@example.com", + phone_number: "+15555550110", + full_name: "Jean Doe", +) +``` + +#### Response + +```ruby +{ + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->create( + user_identity_key: "jean_doe", + email_address: "jean@example.com", + phone_number: "+15555550110", + full_name: "Jean Doe" +); +``` + +#### Response + +```php + "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe" +``` + +#### Response + +```seam_cli +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.Create( + context.Background(), + api.UserIdentitiesCreateRequest{ + UserIdentityKey: api.String("jean_doe"), + EmailAddress: api.String("jean@example.com"), + PhoneNumber: api.String("+15555550110"), + FullName: api.String("Jean Doe"), + }, + ) +} +``` + +#### Response + +```go +api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 6a4fee0d4..73e69e699 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -112,6 +112,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -132,3 +133,115 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Delete a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.delete({ + user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135") +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135") +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->delete( + user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.Delete( + context.Background(), + api.UserIdentitiesDeleteRequest{ + UserIdentityId: api.String("44d48b20-0dbe-419d-91ca-ab8bceecd135"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 36b0ce73a..3b249f382 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -117,6 +117,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -137,3 +138,120 @@ ID of the desired enrollment automation. ## Return Type void + +*** + +## Code Samples +### Delete an enrollment automation + +Specify the desired `enrollment_automation_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.enrollmentAutomations.delete({ + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.enrollment_automations.delete( + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.enrollment_automations.delete( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->enrollment_automations->delete( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.Delete( + context.Background(), + enrollmentautomations.EnrollmentAutomationsDeleteRequest{ + EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index a5fa0ec7e..84378be83 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -160,6 +160,7 @@ api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -181,3 +182,163 @@ ID of the desired enrollment automation. ## Return Type [enrollment\_automation](./) + +*** + +## Code Samples +### Get an enrollment automation + +Specify the desired `enrollment_automation_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.enrollmentAutomations.get({ + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +}); +``` + +#### Response + +```javascript +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.enrollment_automations.get( + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" +) +``` + +#### Response + +```python +EnrollmentAutomation( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", + acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + is_running=true, + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-09T05:45:33.068Z", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.enrollment_automations.get( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +) +``` + +#### Response + +```ruby +{ + "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->enrollment_automations->get( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" +); +``` + +#### Response + +```php + "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => + "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => + "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" +``` + +#### Response + +```seam_cli +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.Get( + context.Background(), + enrollmentautomations.EnrollmentAutomationsGetRequest{ + EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), + }, + ) +} +``` + +#### Response + +```go +api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 554e8e5c5..df9d748bf 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -175,6 +175,7 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -231,3 +232,178 @@ ID of the associated ACS user within the credential manager. If you specify a `c ## Return Type [unknown](./) + +*** + +## Code Samples +### Launch an enrollment automation + +Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.enrollmentAutomations.launch({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user: true, +}); +``` + +#### Response + +```javascript +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.enrollment_automations.launch( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id="3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user=true, +) +``` + +#### Response + +```python +Unknown( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", + acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + is_running=true, + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-09T05:45:33.068Z", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.enrollment_automations.launch( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user: true, +) +``` + +#### Response + +```ruby +{ + "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->enrollment_automations->launch( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user: true +); +``` + +#### Response + +```php + "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => + "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => + "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true +``` + +#### Response + +```seam_cli +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.Launch( + context.Background(), + enrollmentautomations.EnrollmentAutomationsLaunchRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + CredentialManagerAcsSystemId: api.String("6737e186-8d54-48ce-a7da-a0be4d252172"), + AcsCredentialPoolId: api.String("3fa85f64-5717-4562-b3fc-2c963f66afa6"), + CreateCredentialManagerUser: api.Bool(true), + }, + ) +} +``` + +#### Response + +```go +api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 1d85c81fb..9d4a8a9db 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -170,6 +170,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -191,3 +192,173 @@ ID of the user identity for which you want to retrieve all enrollment automation ## Return Type Array<[enrollment\_automation](./)> + +*** + +## Code Samples +### List enrollment automations + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.enrollmentAutomations.list({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", +}); +``` + +#### Response + +```javascript +[ + { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.enrollment_automations.list( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" +) +``` + +#### Response + +```python +[ + EnrollmentAutomation( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", + acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + is_running=true, + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-09T05:45:33.068Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.enrollment_automations.list( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", +) +``` + +#### Response + +```ruby +[ + { + "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->enrollment_automations->list( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +); +``` + +#### Response + +```php + "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => + "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => + "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +``` + +#### Response + +```seam_cli +[ + { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.List( + context.Background(), + enrollmentautomations.EnrollmentAutomationsListRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + }, + ) +} +``` + +#### Response + +```go +[]api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 8cd5b9bfb..d20d09b4e 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -158,6 +158,7 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -187,3 +188,161 @@ Required: No ## Return Type [user\_identity](./) + +*** + +## Code Samples +### Get a user identity + +Specify the `user_identity_id` of the user identity that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.get({ + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", +}); +``` + +#### Response + +```javascript +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") +``` + +#### Response + +```python +UserIdentity( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + display_name="Jean Doe", + full_name="Jean Doe", + created_at="2024-01-11T05:37:50.264Z", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") +``` + +#### Response + +```ruby +{ + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->get( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +); +``` + +#### Response + +```php + "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +``` + +#### Response + +```seam_cli +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.Get( + context.Background(), + api.UserIdentitiesGetRequest{ + UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), + }, + ) +} +``` + +#### Response + +```go +api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index a1a815225..5b4905085 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,124 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Grant a user identity access to a device + +Specify the desired `user_identity_id` and `device_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.grantAccessToDevice({ + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.grant_access_to_device( + user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id="054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.grant_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->grant_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.GrantAccessToDevice( + context.Background(), + api.UserIdentitiesGrantAccessToDeviceRequest{ + UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), + DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index a94896839..7420e0403 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -157,6 +157,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -178,3 +179,160 @@ Required: No ## Return Type Array<[user\_identity](./)> + +*** + +## Code Samples +### List user identities + +To filter the list of user identities, specify the desired `credential_manager_acs_system_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.list(); +``` + +#### Response + +```javascript +[ + { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.list() +``` + +#### Response + +```python +[ + UserIdentity( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + display_name="Jean Doe", + full_name="Jean Doe", + created_at="2024-01-11T05:37:50.264Z", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.list() +``` + +#### Response + +```ruby +[ + { + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->list(); +``` + +#### Response + +```php + "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities list +``` + +#### Response + +```seam_cli +[ + { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +func main() { + client.UserIdentities.List(context.Background()) +} +``` + +#### Response + +```go +[]api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 9ac82b8ee..b5f2255ef 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -388,6 +388,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -408,3 +409,391 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Return Type Array<[device](./)> + +*** + +## Code Samples +### List accessible devices for a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.listAccessibleDevices({ + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", +}); +``` + +#### Response + +```javascript +[ + { + "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname": "", + "display_name": "Seam Thermostat", + "device_type": "nest_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68 + }, + "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": { "name": "" }, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false + }, + "location": null, + "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-02-29T21:57:33.397Z", + "errors": [], + "warnings": [], + "is_managed": true, + "custom_metadata": {} + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.list_accessible_devices( + user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf" +) +``` + +#### Response + +```python +[ + Device( + device_id="054765c8-a2fc-4599-b486-14c19f462c45", + nickname="", + display_name="Seam Thermostat", + device_type="nest_thermostat", + capabilities_supported=["thermostat"], + properties={ + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a", + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68, + }, + "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": {"name": ""}, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false, + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false, + }, + location=None, + connected_account_id="44284499-a50b-4947-86c1-58264f014be5", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-02-29T21:57:33.397Z", + errors=[], + warnings=[], + is_managed=true, + custom_metadata={}, + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.list_accessible_devices( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", +) +``` + +#### Response + +```ruby +[ + { + "device_id" => "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname" => "", + "display_name" => "Seam Thermostat", + "device_type" => "nest_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => { + online: true, + is_cooling: false, + is_heating: false, + manufacturer: "nest", + nest_metadata: { + custom_name: "", + device_name: + "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + nest_device_id: "bcca8c5f-1854-4906-9911-c877d513e00a", + }, + is_fan_running: false, + has_direct_power: true, + relative_humidity: 0.46, + temperature_celsius: 24.64, + temperature_fahrenheit: 76.352, + current_climate_setting: { + hvac_mode_setting: "heat_cool", + manual_override_allowed: true, + cooling_set_point_celsius: 21.5, + heating_set_point_celsius: 20, + cooling_set_point_fahrenheit: 70.7, + heating_set_point_fahrenheit: 68, + }, + available_hvac_mode_settings: %w[heat cool heat_cool off], + is_temporary_manual_override_active: false, + name: "", + appearance: { + name: "", + }, + model: { + display_name: "Thermostat", + manufacturer_display_name: "Nest", + accessory_keypad_supported: false, + }, + image_url: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + image_alt_text: "Placeholder Lock Image", + is_climate_setting_schedule_active: false, + }, + "location" => nil, + "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-02-29T21:57:33.397Z", + "errors" => [], + "warnings" => [], + "is_managed" => true, + "custom_metadata" => { + }, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->list_accessible_devices( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf" +); +``` + +#### Response + +```php + "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname" => "", + "display_name" => "Seam Thermostat", + "device_type" => "nest_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => [ + "online" => true, + "is_cooling" => false, + "is_heating" => false, + "manufacturer" => "nest", + "nest_metadata" => [ + "custom_name" => "", + "device_name" => + "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id" => "bcca8c5f-1854-4906-9911-c877d513e00a", + ], + "is_fan_running" => false, + "has_direct_power" => true, + "relative_humidity" => 0.46, + "temperature_celsius" => 24.64, + "temperature_fahrenheit" => 76.352, + "current_climate_setting" => [ + "hvac_mode_setting" => "heat_cool", + "manual_override_allowed" => true, + "cooling_set_point_celsius" => 21.5, + "heating_set_point_celsius" => 20, + "cooling_set_point_fahrenheit" => 70.7, + "heating_set_point_fahrenheit" => 68, + ], + "available_hvac_mode_settings" => [ + "heat", + "cool", + "heat_cool", + "off", + ], + "is_temporary_manual_override_active" => false, + "name" => "", + "appearance" => ["name" => ""], + "model" => [ + "display_name" => "Thermostat", + "manufacturer_display_name" => "Nest", + "accessory_keypad_supported" => false, + ], + "image_url" => + "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text" => "Placeholder Lock Image", + "is_climate_setting_schedule_active" => false, + ], + "location" => null, + "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-02-29T21:57:33.397Z", + "errors" => [], + "warnings" => [], + "is_managed" => true, + "custom_metadata" => [], + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" +``` + +#### Response + +```seam_cli +[ + { + "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname": "", + "display_name": "Seam Thermostat", + "device_type": "nest_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68 + }, + "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": { "name": "" }, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false + }, + "location": null, + "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-02-29T21:57:33.397Z", + "errors": [], + "warnings": [], + "is_managed": true, + "custom_metadata": {} + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.ListAccessibleDevices( + context.Background(), + api.UserIdentitiesListAccessibleDevicesRequest{ + UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), + }, + ) +} +``` + +#### Response + +```go +[]api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 9e3de822e..5e1fb5fdc 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -175,6 +175,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -196,3 +197,178 @@ ID of the user identity for which you want to retrieve all access control system ## Return Type Array<[acs\_system](./)> + +*** + +## Code Samples +### List ACS systems associated with a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.listAcsSystems({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", +}); +``` + +#### Response + +```javascript +[ + { + "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "name": "Assa Abloy Credential Service", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-05T07:16:51.971Z", + "system_type": "assa_abloy_credential_service", + "system_type_display_name": "Assa Abloy Credential Service", + "external_type": "assa_abloy_credential_service", + "external_type_display_name": "Assa Abloy Credential Service", + "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.list_acs_systems( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" +) +``` + +#### Response + +```python +[ + AcsSystem( + acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + name="Assa Abloy Credential Service", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-05T07:16:51.971Z", + system_type="assa_abloy_credential_service", + system_type_display_name="Assa Abloy Credential Service", + external_type="assa_abloy_credential_service", + external_type_display_name="Assa Abloy Credential Service", + connected_account_ids=["dc08066f-d9b8-42f0-9c4b-c781cd900153"], + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f") +``` + +#### Response + +```ruby +[ + { + "acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "name" => "Assa Abloy Credential Service", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-05T07:16:51.971Z", + "system_type" => "assa_abloy_credential_service", + "system_type_display_name" => "Assa Abloy Credential Service", + "external_type" => "assa_abloy_credential_service", + "external_type_display_name" => "Assa Abloy Credential Service", + "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->list_acs_systems( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +); +``` + +#### Response + +```php + "6737e186-8d54-48ce-a7da-a0be4d252172", + "name" => "Assa Abloy Credential Service", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-05T07:16:51.971Z", + "system_type" => "assa_abloy_credential_service", + "system_type_display_name" => "Assa Abloy Credential Service", + "external_type" => "assa_abloy_credential_service", + "external_type_display_name" => "Assa Abloy Credential Service", + "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +``` + +#### Response + +```seam_cli +[ + { + "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "name": "Assa Abloy Credential Service", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-05T07:16:51.971Z", + "system_type": "assa_abloy_credential_service", + "system_type_display_name": "Assa Abloy Credential Service", + "external_type": "assa_abloy_credential_service", + "external_type_display_name": "Assa Abloy Credential Service", + "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.ListAcsSystems( + context.Background(), + api.UserIdentitiesListAcsSystemsRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 3cc8ed5c3..a8fd57886 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -185,6 +185,7 @@ func main() { {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -205,3 +206,188 @@ ID of the user identity for which you want to retrieve all ACS users. ## Return Type Array<[acs\_user](./)> + +*** + +## Code Samples +### List ACS users for a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.listAcsUsers({ + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", +}); +``` + +#### Response + +```javascript +[ + { + "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "email_address": "jean@example.com", + "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-11T05:45:41.349Z", + "is_suspended": false, + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address": "jean@example.com", + "user_identity_phone_number": "+15555550110" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.list_acs_users( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +) +``` + +#### Response + +```python +[ + AcsUser( + acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", + display_name="Jean Doe", + full_name="Jean Doe", + email_address="jean@example.com", + acs_system_id="8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-11T05:45:41.349Z", + is_suspended=false, + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_email_address="jean@example.com", + user_identity_phone_number="+15555550110", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") +``` + +#### Response + +```ruby +[ + { + "acs_user_id" => "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "email_address" => "jean@example.com", + "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-11T05:45:41.349Z", + "is_suspended" => false, + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address" => "jean@example.com", + "user_identity_phone_number" => "+15555550110", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->list_acs_users( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +); +``` + +#### Response + +```php + "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "email_address" => "jean@example.com", + "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-11T05:45:41.349Z", + "is_suspended" => false, + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address" => "jean@example.com", + "user_identity_phone_number" => "+15555550110", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +``` + +#### Response + +```seam_cli +[ + { + "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "email_address": "jean@example.com", + "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-11T05:45:41.349Z", + "is_suspended": false, + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address": "jean@example.com", + "user_identity_phone_number": "+15555550110" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.ListAcsUsers( + context.Background(), + api.UserIdentitiesListAcsUsersRequest{ + UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), + }, + ) +} +``` + +#### Response + +```go +[]api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index a51c702af..e9afa1459 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,124 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Remove an ACS user from a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.removeAcsUser({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.remove_acs_user( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id="c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.remove_acs_user( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->remove_acs_user( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.RemoveAcsUser( + context.Background(), + api.UserIdentitiesRemoveAcsUserRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + AcsUserId: api.String("c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index a1deac4cc..3b3d016ec 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -121,6 +121,7 @@ nil {% endtab %} {% endtabs %} + ## Authentication Methods - API key @@ -150,3 +151,124 @@ ID of the desired user identity. ## Return Type void + +*** + +## Code Samples +### Revoke access to a device from a user identity + +Specify the desired `user_identity_id` and `device_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Request + +```javascript +await seam.userIdentities.revokeAccessToDevice({ + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +}); +``` + +#### Response + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Request + +```python +seam.user_identities.revoke_access_to_device( + user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id="054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Response + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Request + +```ruby +seam.user_identities.revoke_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Response + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Request + +```php +user_identities->revoke_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45" +); +``` + +#### Response + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Request + +```seam_cli +seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" +``` + +#### Response + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Request + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.RevokeAccessToDevice( + context.Background(), + api.UserIdentitiesRevokeAccessToDeviceRequest{ + UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), + DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), + }, + ) +} +``` + +#### Response + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index d5deb5c99..619573a92 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -62,3 +62,8 @@ Unique key for the user identity. ## Return Type void + +*** + +## Code Samples + From 667f07ca2c033f5922fd154068a83dcb3735b45f Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Wed, 26 Mar 2025 16:04:11 -0400 Subject: [PATCH 025/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ---- 1 file changed, 4 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 4b6bee91f..2d5f0db9c 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -8,10 +8,6 @@ {{#if codeSamples.length}} {{#each this.codeSamples}} -## {{this.title}} - -{{this.description}} - {% tabs %} {{#each this.code}} {% tab title="{{this.title}}" %} From cd8ec0bb06192ca5fa05de164fcf9d1f0083aa71 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Wed, 26 Mar 2025 20:05:12 +0000 Subject: [PATCH 026/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 4 ---- docs/api/acs/access_groups/get.md | 4 ---- docs/api/acs/access_groups/list.md | 4 ---- .../acs/access_groups/list_accessible_entrances.md | 4 ---- docs/api/acs/access_groups/list_users.md | 4 ---- docs/api/acs/access_groups/remove_user.md | 4 ---- docs/api/acs/credentials/assign.md | 4 ---- docs/api/acs/credentials/create.md | 4 ---- docs/api/acs/credentials/delete.md | 4 ---- docs/api/acs/credentials/get.md | 4 ---- docs/api/acs/credentials/list.md | 4 ---- .../api/acs/credentials/list_accessible_entrances.md | 4 ---- docs/api/acs/credentials/unassign.md | 4 ---- docs/api/acs/credentials/update.md | 4 ---- docs/api/acs/entrances/get.md | 4 ---- docs/api/acs/entrances/list.md | 4 ---- .../acs/entrances/list_credentials_with_access.md | 4 ---- docs/api/acs/systems/get.md | 4 ---- docs/api/acs/systems/list.md | 4 ---- ...list_compatible_credential_manager_acs_systems.md | 4 ---- docs/api/acs/users/add_to_access_group.md | 4 ---- docs/api/acs/users/create.md | 12 ------------ docs/api/acs/users/delete.md | 4 ---- docs/api/acs/users/get.md | 4 ---- docs/api/acs/users/list.md | 4 ---- docs/api/acs/users/remove_from_access_group.md | 4 ---- docs/api/acs/users/suspend.md | 4 ---- docs/api/acs/users/unsuspend.md | 4 ---- docs/api/acs/users/update.md | 4 ---- docs/api/thermostats/activate_climate_preset.md | 4 ---- docs/api/thermostats/cool.md | 4 ---- docs/api/thermostats/create_climate_preset.md | 4 ---- docs/api/thermostats/delete_climate_preset.md | 4 ---- docs/api/thermostats/heat.md | 4 ---- docs/api/thermostats/heat_cool.md | 4 ---- docs/api/thermostats/list.md | 4 ---- docs/api/thermostats/off.md | 4 ---- docs/api/thermostats/schedules/create.md | 4 ---- docs/api/thermostats/schedules/delete.md | 4 ---- docs/api/thermostats/schedules/get.md | 4 ---- docs/api/thermostats/schedules/list.md | 4 ---- docs/api/thermostats/schedules/update.md | 4 ---- docs/api/thermostats/set_fallback_climate_preset.md | 4 ---- docs/api/thermostats/set_fan_mode.md | 4 ---- docs/api/thermostats/set_hvac_mode.md | 4 ---- docs/api/thermostats/set_temperature_threshold.md | 4 ---- docs/api/thermostats/update_climate_preset.md | 4 ---- docs/api/user_identities/add_acs_user.md | 4 ---- docs/api/user_identities/create.md | 4 ---- docs/api/user_identities/delete.md | 4 ---- .../user_identities/enrollment_automations/delete.md | 4 ---- .../user_identities/enrollment_automations/get.md | 4 ---- .../user_identities/enrollment_automations/launch.md | 4 ---- .../user_identities/enrollment_automations/list.md | 4 ---- docs/api/user_identities/get.md | 4 ---- docs/api/user_identities/grant_access_to_device.md | 4 ---- docs/api/user_identities/list.md | 4 ---- docs/api/user_identities/list_accessible_devices.md | 4 ---- docs/api/user_identities/list_acs_systems.md | 4 ---- docs/api/user_identities/list_acs_users.md | 4 ---- docs/api/user_identities/remove_acs_user.md | 4 ---- docs/api/user_identities/revoke_access_to_device.md | 4 ---- 62 files changed, 256 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 1cb598c03..40f1a25d7 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -6,10 +6,6 @@ PUT /acs/access_groups/add_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Add an ACS user to an access group - -Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 895b39449..f33f02a98 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -6,10 +6,6 @@ POST /acs/access_groups/get ⇒ { acs_access_group } Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Get a specific access group - -Specify the `acs_access_group_id` of the access group that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 8d77f25a4..506319b03 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -6,10 +6,6 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## List access groups - -To filter the list of access groups, include an `acs_system_id` or `acs_user_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 3f16648fc..57f821e9c 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -6,10 +6,6 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## List accessible entrances for an access group - -Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index fcc04c210..d9b2db52c 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -6,10 +6,6 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## List ACS users in an access group - -Specify the `acs_access_group_id` to retrieve all ACS users in an access group. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 6d62b1086..6b8d2a7e0 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -6,10 +6,6 @@ POST /acs/access_groups/remove_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Remove an ACS user from an access group - -Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 86e4d2907..1bcc6e68a 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -6,10 +6,6 @@ PATCH /acs/credentials/assign ⇒ void Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Assign a credential to an ACS user - -Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 24f92bcba..0d08bcfea 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -6,10 +6,6 @@ POST /acs/credentials/create ⇒ { acs_credential } Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Create a credential for an ACS user - -Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 30abfe8ba..00fc9422c 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -6,10 +6,6 @@ POST /acs/credentials/delete ⇒ void Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -## Delete a credential - -Specify the desired `acs_credential_id` to delete the specified credential. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 8bde9999a..d74c7a7e2 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -6,10 +6,6 @@ POST /acs/credentials/get ⇒ { acs_credential } Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -## Get a credential - -Specify the `acs_credential_id` of the credential that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index c560e2c19..dee120b2d 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -6,10 +6,6 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). -## List credentials - -Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index db591cb57..ef6602c84 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -6,10 +6,6 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. -## List accessible entrances - -Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index ad72bdeed..762bc6b27 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -6,10 +6,6 @@ PATCH /acs/credentials/unassign ⇒ void Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Unassign a credential from an ACS user - -Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index fdeefde3f..19d51e5ce 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -6,10 +6,6 @@ PATCH /acs/credentials/update ⇒ void Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -## Update a credential - -Specify the desired `acs_credential_id` and updated `code` to update the credential. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 395eb7118..d05f0b15c 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -6,10 +6,6 @@ POST /acs/entrances/get ⇒ { acs_entrance } Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -## Get an entrance - -Specify the `acs_entrance_id` of the entrance that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 8d621ea4d..214fc6a23 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -6,10 +6,6 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). -## List entrances - -To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6dc4a8e12..054919f21 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -6,10 +6,6 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -## List credentials with access to an entrance - -Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 6d230071b..d450d72fd 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -8,10 +8,6 @@ Returns a specified [access control system](https://docs.seam.co/latest/capabili Specify the desired access control system by including the corresponding `acs_system_id` in the request body. -## Get a Specific ACS system - -Specify the `acs_system_id` of the ACS system that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 77276f01e..8db999568 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -10,10 +10,6 @@ To filter the list of returned access control systems by a specific connected ac `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. -## List ACS systems by connected account - -To filter the list of ACS systems, include a `connected_account_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index a918d9b67..bb716ce5a 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -10,10 +10,6 @@ Returns a list of all credential manager ACS systems that are compatible with a Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. -## List compatible credential manager ACS systems - -Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 22ba0d052..9bcb241b1 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -6,10 +6,6 @@ PUT /acs/users/add_to_access_group ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Add an ACS user to an access group - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 912003eea..30a637157 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -6,10 +6,6 @@ POST /acs/users/create ⇒ { acs_user } Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Create a new ACS user - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - {% tabs %} {% tab title="JavaScript" %} #### Request @@ -179,10 +175,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -## Create a new ACS user - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. - {% tabs %} {% tab title="JavaScript" %} #### Request @@ -369,10 +361,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -## Create a new ACS user in an access group - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 0605b8f8b..9917670cc 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -6,10 +6,6 @@ POST /acs/users/delete ⇒ void Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). -## Delete an ACS user - -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 0a3661c38..12ab83e39 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -6,10 +6,6 @@ POST /acs/users/get ⇒ { acs_user } Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Get a specific ACS user - -Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 64e97c1a2..5e6693d69 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -6,10 +6,6 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## List all ACS users - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 2987c3a99..364a86040 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -6,10 +6,6 @@ POST /acs/users/remove_from_access_group ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -## Remove an ACS user from an access group - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 79cda84ba..e97251386 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -6,10 +6,6 @@ POST /acs/users/suspend ⇒ void [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. -## Suspend an ACS user - -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 7f8bf93e7..7e0adb646 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -6,10 +6,6 @@ POST /acs/users/unsuspend ⇒ void [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. -## Unsuspend an ACS user - -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 354c24786..0bee5cc50 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -6,10 +6,6 @@ PATCH /acs/users/update ⇒ void Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -## Update an ACS user - -Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index f8da1445f..5c8997a42 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -6,10 +6,6 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Activate a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index f7a1997a9..8c2eecb37 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -6,10 +6,6 @@ POST /thermostats/cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -## Set to cool mode - -Specify the desired cooling set point in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 3186ba867..b36396fb5 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -6,10 +6,6 @@ POST /thermostats/create_climate_preset ⇒ void Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Create a climate preset - -Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 76b3092c2..df31db85a 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -6,10 +6,6 @@ POST /thermostats/delete_climate_preset ⇒ void Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Delete a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 9fa86fb74..b11967e9d 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -6,10 +6,6 @@ POST /thermostats/heat ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -## Set to heat mode - -Specify the desired heating set point in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 1e2893482..b78365c3e 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -6,10 +6,6 @@ POST /thermostats/heat_cool ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -## Set to heat-cool (auto) mode - -Specify the desired heating set point in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index b6fa1bd64..cf3336306 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -6,10 +6,6 @@ POST /thermostats/list ⇒ { devices: [device, …] } Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). -## List thermostats - -To filter the list of returned thermostats, specify the desired parameters. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index ab5ef8d14..25108600a 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -6,10 +6,6 @@ POST /thermostats/off ⇒ { action_attempt } Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -## Set to off mode - -Specify the `device_id` of the thermostat that you want to set to off mode. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index a58997c78..40cdd6e4f 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -6,10 +6,6 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Create a thermostat schedule - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 4b8337d2e..52fa56149 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -6,10 +6,6 @@ POST /thermostats/schedules/delete ⇒ void Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Delete a thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 32b0c1b1a..1cb2eff7c 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -6,10 +6,6 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -## Get a specific thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 3919e321d..8bc2bd352 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -6,10 +6,6 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## List thermostat schedules for a thermostat - -Specify the `device_id` of the desired thermostat. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index d981dc510..71697435e 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -6,10 +6,6 @@ PATCH /thermostats/schedules/update ⇒ void Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -## Update a thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index b2d3ae442..780307793 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -6,10 +6,6 @@ POST /thermostats/set_fallback_climate_preset ⇒ void Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Set the fallback climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index b7fdd5477..c5fc81c86 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -6,10 +6,6 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Set fan mode setting - -Specify the desired fan mode setting. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 56a428823..0e102e92e 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -6,10 +6,6 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Set HVAC mode - -Specify the desired heating and cooling set points in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index e6e122407..0590a0ba1 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -6,10 +6,6 @@ PATCH /thermostats/set_temperature_threshold ⇒ void Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. -## Set a temperature threshold - -Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index a40dc8972..b00c2bf55 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -6,10 +6,6 @@ PATCH /thermostats/update_climate_preset ⇒ void Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -## Update a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 266811c1e..299d79f08 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -6,10 +6,6 @@ PUT /user_identities/add_acs_user ⇒ void Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Add an ACS user to a user identity - -Specify the desired `acs_user_id` and `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index e459f32d0..8d95a69a3 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -6,10 +6,6 @@ POST /user_identities/create ⇒ { user_identity } Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Create a user identity - -Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 73e69e699..5cd1d2ae6 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -6,10 +6,6 @@ POST /user_identities/delete ⇒ void Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. -## Delete a user identity - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 3b249f382..0fa34d659 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -6,10 +6,6 @@ POST /user_identities/enrollment_automations/delete ⇒ void Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). -## Delete an enrollment automation - -Specify the desired `enrollment_automation_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 84378be83..e1ca50c85 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -6,10 +6,6 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -## Get an enrollment automation - -Specify the desired `enrollment_automation_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index df9d748bf..694ceec93 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -6,10 +6,6 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -## Launch an enrollment automation - -Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 9d4a8a9db..24f3a00cc 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -6,10 +6,6 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List enrollment automations - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index d20d09b4e..6a167fe05 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -6,10 +6,6 @@ POST /user_identities/get ⇒ { user_identity } Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Get a user identity - -Specify the `user_identity_id` of the user identity that you want to retrieve. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 5b4905085..a9d9be01e 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -6,10 +6,6 @@ PUT /user_identities/grant_access_to_device ⇒ void Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). -## Grant a user identity access to a device - -Specify the desired `user_identity_id` and `device_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 7420e0403..f6c16069d 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -6,10 +6,6 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List user identities - -To filter the list of user identities, specify the desired `credential_manager_acs_system_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index b5f2255ef..25ab353ef 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -6,10 +6,6 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List accessible devices for a user identity - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 5e1fb5fdc..ab7e02076 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -6,10 +6,6 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List ACS systems associated with a user identity - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index a8fd57886..aedc13092 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -6,10 +6,6 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## List ACS users for a user identity - -Specify the desired `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e9afa1459..e395588e7 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -6,10 +6,6 @@ POST /user_identities/remove_acs_user ⇒ void Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Remove an ACS user from a user identity - -Specify the desired `acs_user_id` and `user_identity_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 3b3d016ec..0ef025d83 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -6,10 +6,6 @@ POST /user_identities/revoke_access_to_device ⇒ void Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -## Revoke access to a device from a user identity - -Specify the desired `user_identity_id` and `device_id`. - {% tabs %} {% tab title="JavaScript" %} #### Request From 028b008873ea9d93db880e0144fbed5381b26159 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 19:45:09 +0000 Subject: [PATCH 027/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 122 ---- docs/api/acs/access_groups/get.md | 169 ------ docs/api/acs/access_groups/list.md | 188 ------ .../list_accessible_entrances.md | 163 ------ docs/api/acs/access_groups/list_users.md | 221 ------- docs/api/acs/access_groups/remove_user.md | 122 ---- docs/api/acs/credentials/assign.md | 122 ---- docs/api/acs/credentials/create.md | 210 ------- docs/api/acs/credentials/delete.md | 113 ---- docs/api/acs/credentials/get.md | 164 ------ docs/api/acs/credentials/list.md | 193 ------ .../credentials/list_accessible_entrances.md | 208 ------- docs/api/acs/credentials/unassign.md | 122 ---- docs/api/acs/credentials/update.md | 118 ---- docs/api/acs/encoders/encode_credential.md | 5 - docs/api/acs/encoders/list.md | 5 - docs/api/acs/encoders/scan_credential.md | 5 - .../next_credential_encode_will_fail.md | 5 - .../next_credential_encode_will_succeed.md | 5 - .../next_credential_scan_will_fail.md | 5 - .../next_credential_scan_will_succeed.md | 5 - docs/api/acs/entrances/get.md | 139 ----- docs/api/acs/entrances/grant_access.md | 5 - docs/api/acs/entrances/list.md | 137 ----- .../entrances/list_credentials_with_access.md | 234 -------- docs/api/acs/systems/get.md | 112 ---- docs/api/acs/systems/list.md | 114 ---- ...mpatible_credential_manager_acs_systems.md | 118 ---- docs/api/acs/users/add_to_access_group.md | 122 ---- docs/api/acs/users/create.md | 547 +----------------- docs/api/acs/users/delete.md | 111 ---- docs/api/acs/users/get.md | 157 ----- docs/api/acs/users/list.md | 147 ----- .../acs/users/list_accessible_entrances.md | 5 - .../api/acs/users/remove_from_access_group.md | 122 ---- .../users/revoke_access_to_all_entrances.md | 5 - docs/api/acs/users/suspend.md | 111 ---- docs/api/acs/users/unsuspend.md | 113 ---- docs/api/acs/users/update.md | 121 ---- docs/api/phones/deactivate.md | 5 - docs/api/phones/get.md | 5 - docs/api/phones/list.md | 5 - .../phones/simulate/create_sandbox_phone.md | 5 - .../thermostats/activate_climate_preset.md | 141 ----- docs/api/thermostats/cool.md | 141 ----- docs/api/thermostats/create_climate_preset.md | 151 ----- docs/api/thermostats/delete_climate_preset.md | 120 ---- docs/api/thermostats/heat.md | 141 ----- docs/api/thermostats/heat_cool.md | 147 ----- docs/api/thermostats/list.md | 222 ------- docs/api/thermostats/off.md | 131 ----- docs/api/thermostats/schedules/create.md | 183 ------ docs/api/thermostats/schedules/delete.md | 115 ---- docs/api/thermostats/schedules/get.md | 156 ----- docs/api/thermostats/schedules/list.md | 209 ------- docs/api/thermostats/schedules/update.md | 122 ---- .../set_fallback_climate_preset.md | 120 ---- docs/api/thermostats/set_fan_mode.md | 141 ----- docs/api/thermostats/set_hvac_mode.md | 152 ----- .../thermostats/set_temperature_threshold.md | 126 ---- .../simulate/hvac_mode_adjusted.md | 5 - .../simulate/temperature_reached.md | 5 - docs/api/thermostats/update_climate_preset.md | 131 ----- docs/api/user_identities/add_acs_user.md | 121 ---- docs/api/user_identities/create.md | 177 ------ docs/api/user_identities/delete.md | 112 ---- .../enrollment_automations/delete.md | 117 ---- .../enrollment_automations/get.md | 160 ----- .../enrollment_automations/launch.md | 175 ------ .../enrollment_automations/list.md | 170 ------ docs/api/user_identities/get.md | 158 ----- .../user_identities/grant_access_to_device.md | 121 ---- docs/api/user_identities/list.md | 157 ----- .../list_accessible_devices.md | 388 ------------- docs/api/user_identities/list_acs_systems.md | 175 ------ docs/api/user_identities/list_acs_users.md | 185 ------ docs/api/user_identities/remove_acs_user.md | 121 ---- .../revoke_access_to_device.md | 121 ---- docs/api/user_identities/update.md | 5 - 79 files changed, 1 insertion(+), 9831 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 40f1a25d7..983d05410 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -148,125 +148,3 @@ ID of the desired user. ## Return Type void - -*** - -## Code Samples -### Add an ACS user to an access group - -Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.addUser({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.add_user( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - acs_user_id="33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.add_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->add_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.AddUser( - context.Background(), - accessgroups.AccessGroupsAddUserRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index f33f02a98..e33a8cb19 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -186,172 +186,3 @@ ID of the desired access group. ## Return Type [acs\_access\_group](./) - -*** - -## Code Samples -### Get a specific access group - -Specify the `acs_access_group_id` of the access group that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.get({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -}); -``` - -#### Response - -```javascript -{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444") -``` - -#### Response - -```python -AcsAccessGroup( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - name="Lobby Access", - display_name="Lobby Access", - access_group_type_display_name="PTI access level", - access_group_type="pti_access_level", - external_type="pti_access_level", - external_type_display_name="PTI access level", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2023-11-30T06:27:15.437Z", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444") -``` - -#### Response - -```ruby -{ - "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->get( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` - -#### Response - -```php - "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444" -``` - -#### Response - -```seam_cli -{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.Get( - context.Background(), - accessgroups.AccessGroupsGetRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - }, - ) -} -``` - -#### Response - -```go -api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 506319b03..103b790ba 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -214,191 +214,3 @@ ID of the user for which you want to retrieve all access groups. ## Return Type Array<[acs\_access\_group](./)> - -*** - -## Code Samples -### List access groups - -To filter the list of access groups, include an `acs_system_id` or `acs_user_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.list({ - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333", -}); -``` - -#### Response - -```javascript -[ - { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.list( - acs_system_id="11111111-1111-1111-1111-111111111111", - acs_user_id="33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```python -[ - AcsAccessGroup( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - name="Lobby Access", - display_name="Lobby Access", - access_group_type_display_name="PTI access level", - access_group_type="pti_access_level", - external_type="pti_access_level", - external_type_display_name="PTI access level", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2023-11-30T06:27:15.437Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.list( - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```ruby -[ - { - "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->list( - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` - -#### Response - -```php - "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333" -``` - -#### Response - -```seam_cli -[ - { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.List( - context.Background(), - accessgroups.AccessGroupsListRequest{ - AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 57f821e9c..265ab76d3 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -180,166 +180,3 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Return Type Array<[acs\_entrance](./)> - -*** - -## Code Samples -### List accessible entrances for an access group - -Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.listAccessibleEntrances({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -}); -``` - -#### Response - -```javascript -[ - { - "acs_entrance_id": "66666666-6666-6666-6666-666666666666", - "name": "Main Entrance", - "display_name": "Main Entrance", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-10-15T12:00:00.000Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.list_accessible_entrances( - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` - -#### Response - -```python -[ - AcsEntrance( - acs_entrance_id="66666666-6666-6666-6666-666666666666", - name="Main Entrance", - display_name="Main Entrance", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-10-15T12:00:00.000Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.list_accessible_entrances( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -) -``` - -#### Response - -```ruby -[ - { - "acs_entrance_id" => "66666666-6666-6666-6666-666666666666", - "name" => "Main Entrance", - "display_name" => "Main Entrance", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-10-15T12:00:00.000Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->list_accessible_entrances( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` - -#### Response - -```php - "66666666-6666-6666-6666-666666666666", - "name" => "Main Entrance", - "display_name" => "Main Entrance", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-10-15T12:00:00.000Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444" -``` - -#### Response - -```seam_cli -[ - { - "acs_entrance_id": "66666666-6666-6666-6666-666666666666", - "name": "Main Entrance", - "display_name": "Main Entrance", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-10-15T12:00:00.000Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.ListAccessibleEntrances( - context.Background(), - accessgroups.AccessGroupsListAccessibleEntrancesRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index d9b2db52c..c366a94a6 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -238,224 +238,3 @@ ID of the access group for which you want to retrieve all users. ## Return Type Array<[acs\_user](./)> - -*** - -## Code Samples -### List ACS users in an access group - -Specify the `acs_access_group_id` to retrieve all ACS users in an access group. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.listUsers({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -}); -``` - -#### Response - -```javascript -[ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.list_users( - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` - -#### Response - -```python -[ - AcsUser( - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Jane Doe", - full_name="Jane Doe", - email="jane@example.com", - email_address="jane@example.com", - phone_number="+15555550100", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-05T07:14:28.531Z", - is_suspended=false, - access_schedule={ - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z", - }, - user_identity_id="22222222-2222-2222-2222-222222222222", - user_identity_full_name="Jane Doe", - user_identity_email_address="jane@example.com", - user_identity_phone_number="+15555550100", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444") -``` - -#### Response - -```ruby -[ - { - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email" => "jane@example.com", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-05T07:14:28.531Z", - "is_suspended" => false, - "access_schedule" => { - starts_at: "2024-03-01T10:40:00.000Z", - ends_at: "2024-03-04T10:40:00.000Z", - }, - "user_identity_id" => "22222222-2222-2222-2222-222222222222", - "user_identity_full_name" => "Jane Doe", - "user_identity_email_address" => "jane@example.com", - "user_identity_phone_number" => "+15555550100", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->list_users( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` - -#### Response - -```php - "33333333-3333-3333-3333-333333333333", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email" => "jane@example.com", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-05T07:14:28.531Z", - "is_suspended" => false, - "access_schedule" => [ - "starts_at" => "2024-03-01T10:40:00.000Z", - "ends_at" => "2024-03-04T10:40:00.000Z", - ], - "user_identity_id" => "22222222-2222-2222-2222-222222222222", - "user_identity_full_name" => "Jane Doe", - "user_identity_email_address" => "jane@example.com", - "user_identity_phone_number" => "+15555550100", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444" -``` - -#### Response - -```seam_cli -[ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.ListUsers( - context.Background(), - accessgroups.AccessGroupsListUsersRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 6b8d2a7e0..6902f8394 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -148,125 +148,3 @@ ID of the desired user. ## Return Type void - -*** - -## Code Samples -### Remove an ACS user from an access group - -Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.accessGroups.removeUser({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.access_groups.remove_user( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - acs_user_id="33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.access_groups.remove_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->access_groups->remove_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.RemoveUser( - context.Background(), - accessgroups.AccessGroupsRemoveUserRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 1bcc6e68a..e1cae31f5 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -148,125 +148,3 @@ ID of the desired user. ## Return Type void - -*** - -## Code Samples -### Assign a credential to an ACS user - -Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.assign({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.assign( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_credential_id="66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.assign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->assign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Assign( - context.Background(), - credentials.CredentialsAssignRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 0d08bcfea..af1e25bfe 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -317,213 +317,3 @@ Visionline-specific metadata for the new credential. ## Return Type [acs\_credential](./) - -*** - -## Code Samples -### Create a credential for an ACS user - -Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.create({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "mobile_key", - allowed_acs_entrance_ids: [ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z", -}); -``` - -#### Response - -```javascript -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.create( - acs_user_id="33333333-3333-3333-3333-333333333333", - access_method="mobile_key", - allowed_acs_entrance_ids=[ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - ], - credential_manager_acs_system_id="88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential=true, - starts_at="2024-03-01T10:40:00Z", - ends_at="2024-03-04T10:40:00Z", -) -``` - -#### Response - -```python -AcsCredential( - acs_credential_id="99999999-9999-9999-9999-999999999999", - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Multi Phone Sync Credential", - code=None, - acs_system_id="88888888-8888-8888-8888-888888888888", - access_method="mobile_key", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-12T03:56:22.396Z", - is_multi_phone_sync_credential=true, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.create( - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "mobile_key", - allowed_acs_entrance_ids: %w[ - 55555555-5555-5555-5555-555555555555 - 55555555-5555-5555-5555-000000000000 - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z", -) -``` - -#### Response - -```ruby -{ - "acs_credential_id" => "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => nil, - "acs_system_id" => "88888888-8888-8888-8888-888888888888", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->create( - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "mobile_key", - allowed_acs_entrance_ids: [ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z" -); -``` - -#### Response - -```php - "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => null, - "acs_system_id" => "88888888-8888-8888-8888-888888888888", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z" -``` - -#### Response - -```seam_cli -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Create( - context.Background(), - credentials.CredentialsCreateRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AccessMethod: api.String("mobile_key"), - AllowedAcsEntranceIds: [2]string{api.String("55555555-5555-5555-5555-555555555555"), api.String("55555555-5555-5555-5555-000000000000")}, - CredentialManagerAcsSystemId: api.String("88888888-8888-8888-8888-888888888888"), - IsMultiPhoneSyncCredential: api.Bool(true), - StartsAt: api.String("2024-03-01T10:40:00Z"), - EndsAt: api.String("2024-03-04T10:40:00Z"), - }, - ) -} -``` - -#### Response - -```go -api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 00fc9422c..9a0fee13f 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -130,116 +130,3 @@ ID of the desired credential. ## Return Type void - -*** - -## Code Samples -### Delete a credential - -Specify the desired `acs_credential_id` to delete the specified credential. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.delete({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->delete( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Delete( - context.Background(), - credentials.CredentialsDeleteRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index d74c7a7e2..649794cee 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -181,167 +181,3 @@ ID of the desired credential. ## Return Type [acs\_credential](./) - -*** - -## Code Samples -### Get a credential - -Specify the `acs_credential_id` of the credential that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.get({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666") -``` - -#### Response - -```python -AcsCredential( - acs_credential_id="99999999-9999-9999-9999-999999999999", - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Multi Phone Sync Credential", - code=None, - acs_system_id="11111111-1111-1111-1111-111111111111", - access_method="mobile_key", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-12T03:56:22.396Z", - is_multi_phone_sync_credential=true, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666") -``` - -#### Response - -```ruby -{ - "acs_credential_id" => "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => nil, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->get( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php - "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => null, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Get( - context.Background(), - credentials.CredentialsGetRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index dee120b2d..2f656b113 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -256,196 +256,3 @@ ID of the user identity for which you want to retrieve all credentials. ## Return Type Array<[acs\_credential](./)> - -*** - -## Code Samples -### List credentials - -Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.list({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential: true, -}); -``` - -#### Response - -```javascript -[ - { - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.list( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_system_id="11111111-1111-1111-1111-111111111111", - user_identity_id="22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential=true, -) -``` - -#### Response - -```python -[ - AcsCredential( - acs_credential_id="99999999-9999-9999-9999-999999999999", - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Multi Phone Sync Credential", - code=None, - acs_system_id="11111111-1111-1111-1111-111111111111", - access_method="mobile_key", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-12T03:56:22.396Z", - is_multi_phone_sync_credential=true, - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.list( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential: true, -) -``` - -#### Response - -```ruby -[ - { - "acs_credential_id" => "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => nil, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->list( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential: true -); -``` - -#### Response - -```php - "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => null, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true -``` - -#### Response - -```seam_cli -[ - { - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.List( - context.Background(), - credentials.CredentialsListRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), - UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"), - IsMultiPhoneSyncCredential: api.Bool(true), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index ef6602c84..3dddcd871 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -225,211 +225,3 @@ ID of the credential for which you want to retrieve all entrances to which this ## Return Type Array<[acs\_entrance](./)> - -*** - -## Code Samples -### List accessible entrances - -Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.listAccessibleEntrances({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -[ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.list_accessible_entrances( - acs_credential_id="66666666-6666-6666-6666-666666666666" -) -``` - -#### Response - -```python -[ - AcsEntrance( - acs_entrance_id="55555555-5555-5555-5555-555555555555", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - visionline_metadata={ - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE", - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest", - }, - latch_metadata=None, - display_name="Guest Lock 2", - created_at="2024-03-26T14:31:18.979Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.list_accessible_entrances( - acs_credential_id: "66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```ruby -[ - { - "acs_entrance_id" => "55555555-5555-5555-5555-555555555555", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "visionline_metadata" => { - profiles: [{ visionline_door_profile_id: "Guest Door", visionline_door_profile_type: "BLE" }], - door_name: "Guest Lock 2", - door_category: "guest", - }, - "latch_metadata" => nil, - "display_name" => "Guest Lock 2", - "created_at" => "2024-03-26T14:31:18.979Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->list_accessible_entrances( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php - "55555555-5555-5555-5555-555555555555", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "visionline_metadata" => [ - "profiles" => [ - [ - "visionline_door_profile_id" => "Guest Door", - "visionline_door_profile_type" => "BLE", - ], - ], - "door_name" => "Guest Lock 2", - "door_category" => "guest", - ], - "latch_metadata" => null, - "display_name" => "Guest Lock 2", - "created_at" => "2024-03-26T14:31:18.979Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -[ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.ListAccessibleEntrances( - context.Background(), - credentials.CredentialsListAccessibleEntrancesRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 762bc6b27..187a30eb3 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -148,125 +148,3 @@ ID of the desired user. ## Return Type void - -*** - -## Code Samples -### Unassign a credential from an ACS user - -Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.unassign({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.unassign( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_credential_id="66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.unassign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->unassign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Unassign( - context.Background(), - credentials.CredentialsUnassignRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 19d51e5ce..549c4a2b5 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -153,121 +153,3 @@ Replacement date and time at which the validity of the credential ends, in [ISO ## Return Type void - -*** - -## Code Samples -### Update a credential - -Specify the desired `acs_credential_id` and updated `code` to update the credential. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.credentials.update({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", - code: "7890", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.credentials.update( - acs_credential_id="66666666-6666-6666-6666-666666666666", code="7890" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->credentials->update( - acs_credential_id: "66666666-6666-6666-6666-666666666666", - code: "7890" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Update( - context.Background(), - credentials.CredentialsUpdateRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - Code: api.String("7890"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 0cb53296e..5a6a6b23a 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -69,8 +69,3 @@ Possible enum values: --- - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 65b013eda..5705eee18 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -53,8 +53,3 @@ Number of `acs_encoders` to return. ## Return Type Array<[acs\_encoder](./)> - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 89afb83e8..b84d478c2 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -58,8 +58,3 @@ Possible enum values: --- - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 1fc31bb28..5f919c365 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -44,8 +44,3 @@ Code of the error to simulate. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 8243a680d..dd3a7fbee 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -35,8 +35,3 @@ Scenario to simulate. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index b73df5e5c..8a3333506 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -44,8 +44,3 @@ Required: No ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index ca507296d..92f05df53 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -44,8 +44,3 @@ Scenario to simulate. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index d05f0b15c..b4bbbbdf4 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -155,142 +155,3 @@ Required: Yes ## Return Type [acs\_entrance](./) - -*** - -## Code Samples -### Get an entrance - -Specify the `acs_entrance_id` of the entrance that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.entrances.get({ - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -{ - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```python -AcsEntrance( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="text", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```ruby -{ - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->entrances->get( - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -{ - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import entrances "github.com/seamapi/go/entrances" - -func main() { - client.Acs.Entrances.Get( - context.Background(), - entrances.EntrancesGetRequest{ - AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 931f14017..8ea04aa67 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -35,8 +35,3 @@ Required: Yes ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 214fc6a23..acf540d23 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -164,140 +164,3 @@ Required: No ## Return Type Array<[acs\_entrance](./)> - -*** - -## Code Samples -### List entrances - -To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.entrances.list(); -``` - -#### Response - -```javascript -[ - { - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.entrances.list() -``` - -#### Response - -```python -[ - AcsEntrance( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="text", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.entrances.list() -``` - -#### Response - -```ruby -[ - { - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->entrances->list(); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs entrances list -``` - -#### Response - -```seam_cli -[ - { - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -func main() { - client.Acs.Entrances.List(context.Background()) -} -``` - -#### Response - -```go -[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 054919f21..6cd85a7bf 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -261,237 +261,3 @@ Required: No ## Return Type Array<[acs\_credential](./)> - -*** - -## Code Samples -### List credentials with access to an entrance - -Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.entrances.listCredentialsWithAccess({ - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -[ - { - "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "display_name": "text", - "code": "text", - "card_number": "text", - "is_issued": false, - "issued_at": "2024-10-15T12:54:04.155Z", - "access_method": "code", - "external_type": "pti_card", - "external_type_display_name": "text", - "created_at": "2024-10-15T12:54:04.155Z", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "starts_at": "text", - "ends_at": "text", - "is_multi_phone_sync_credential": false, - "is_latest_desired_state_synced_with_provider": false, - "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.entrances.list_credentials_with_access( - acs_entrance_id="123e4567-e89b-12d3-a456-426614174000" -) -``` - -#### Response - -```python -[ - AcsCredential( - acs_credential_id="123e4567-e89b-12d3-a456-426614174000", - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_credential_pool_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - parent_acs_credential_id="123e4567-e89b-12d3-a456-426614174000", - display_name="text", - code="text", - card_number="text", - is_issued=false, - issued_at="2024-10-15T12:54:04.155Z", - access_method="code", - external_type="pti_card", - external_type_display_name="text", - created_at="2024-10-15T12:54:04.155Z", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - starts_at="text", - ends_at="text", - is_multi_phone_sync_credential=false, - is_latest_desired_state_synced_with_provider=false, - latest_desired_state_synced_with_provider_at="2024-10-15T12:54:04.155Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.entrances.list_credentials_with_access( - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```ruby -[ - { - "acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", - "display_name" => "text", - "code" => "text", - "card_number" => "text", - "is_issued" => false, - "issued_at" => "2024-10-15T12:54:04.155Z", - "access_method" => "code", - "external_type" => "pti_card", - "external_type_display_name" => "text", - "created_at" => "2024-10-15T12:54:04.155Z", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "starts_at" => "text", - "ends_at" => "text", - "is_multi_phone_sync_credential" => false, - "is_latest_desired_state_synced_with_provider" => false, - "latest_desired_state_synced_with_provider_at" => "2024-10-15T12:54:04.155Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->entrances->list_credentials_with_access( - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", - "display_name" => "text", - "code" => "text", - "card_number" => "text", - "is_issued" => false, - "issued_at" => "2024-10-15T12:54:04.155Z", - "access_method" => "code", - "external_type" => "pti_card", - "external_type_display_name" => "text", - "created_at" => "2024-10-15T12:54:04.155Z", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "starts_at" => "text", - "ends_at" => "text", - "is_multi_phone_sync_credential" => false, - "is_latest_desired_state_synced_with_provider" => false, - "latest_desired_state_synced_with_provider_at" => - "2024-10-15T12:54:04.155Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -[ - { - "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "display_name": "text", - "code": "text", - "card_number": "text", - "is_issued": false, - "issued_at": "2024-10-15T12:54:04.155Z", - "access_method": "code", - "external_type": "pti_card", - "external_type_display_name": "text", - "created_at": "2024-10-15T12:54:04.155Z", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "starts_at": "text", - "ends_at": "text", - "is_multi_phone_sync_credential": false, - "is_latest_desired_state_synced_with_provider": false, - "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import entrances "github.com/seamapi/go/entrances" - -func main() { - client.Acs.Entrances.ListCredentialsWithAccess( - context.Background(), - entrances.EntrancesListCredentialsWithAccessRequest{ - AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index d450d72fd..a4c54c150 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -131,115 +131,3 @@ ID of the desired access control system. ## Return Type [acs\_system](./) - -*** - -## Code Samples -### Get a Specific ACS system - -Specify the `acs_system_id` of the ACS system that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.systems.get({ - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Response - -```php - "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import systems "github.com/seamapi/go/systems" - -func main() { - client.Acs.Systems.Get( - context.Background(), - systems.SystemsGetRequest{ - AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 8db999568..61766cfe3 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -136,117 +136,3 @@ ID of the connected account by which to filter the list of returned access contr ## Return Type Array<[acs\_system](./)> - -*** - -## Code Samples -### List ACS systems by connected account - -To filter the list of ACS systems, include a `connected_account_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.systems.list({ - connected_account_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```python -[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```ruby -[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->systems->list( - connected_account_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php - "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import systems "github.com/seamapi/go/systems" - -func main() { - client.Acs.Systems.List( - context.Background(), - systems.SystemsListRequest{ - ConnectedAccountId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index bb716ce5a..64204002a 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -139,121 +139,3 @@ ID of the ACS system for which you want to retrieve all compatible credential ma ## Return Type Array<[acs\_system](./)> - -*** - -## Code Samples -### List compatible credential manager ACS systems - -Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.systems.list_compatible_credential_manager_acs_systems( - acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33" -) -``` - -#### Response - -```python -[AcsSystem(acs_system_id="aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4")] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.systems.list_compatible_credential_manager_acs_systems( - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -) -``` - -#### Response - -```ruby -[{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->systems->list_compatible_credential_manager_acs_systems( - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -); -``` - -#### Response - -```php - "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"]]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import systems "github.com/seamapi/go/systems" - -func main() { - client.Acs.Systems.ListCompatibleCredentialManagerAcsSystems( - context.Background(), - systems.SystemsListCompatibleCredentialManagerAcsSystemsRequest{ - AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 9bcb241b1..220fea9d0 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -148,125 +148,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Add an ACS user to an access group - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.addToAccessGroup({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.add_to_access_group( - acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.add_to_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->add_to_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.AddToAccessGroup( - context.Background(), - users.UsersAddToAccessGroupRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 30a637157..01ba1da82 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -175,366 +175,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.create({ - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - access_schedule: { - starts_at: "2024-11-01T15:00:00.000Z", - ends_at: "2024-11-04T11:00:00.000Z", - }, -}); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.create( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", - access_schedule={ - "starts_at": "2024-11-01T15:00:00.000Z", - "ends_at": "2024-11-04T11:00:00.000Z", - }, -) -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - access_schedule: { - starts_at: "2024-11-01T15:00:00.000Z", - ends_at: "2024-11-04T11:00:00.000Z", - }, -) -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - access_schedule: [ - "starts_at" => "2024-11-01T15:00:00.000Z", - "ends_at" => "2024-11-04T11:00:00.000Z", - ] -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"} -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Create( - context.Background(), - users.UsersCreateRequest{ - AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FullName: api.String("Jane Doe"), - EmailAddress: api.String("jane@example.com"), - PhoneNumber: api.String("+15555550100"), - AccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String("2024-11-01T15:00:00.000Z"), EndsAt: api.String("2024-11-04T11:00:00.000Z")}, - }, - ) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.create({ - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], -}); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.create( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", - acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"], -) -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], -) -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", - acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"] -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"] -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Create( - context.Background(), - users.UsersCreateRequest{ - AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FullName: api.String("Jane Doe"), - EmailAddress: api.String("jane@example.com"), - PhoneNumber: api.String("+15555550100"), - AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")}, - }, - ) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - ## Authentication Methods - API key @@ -619,185 +259,7 @@ ID of the user identity with which to associate the new `acs_user`. [acs\_user](./) -*** - -## Code Samples -### Create a new ACS user - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.create({ - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", -}); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.create( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100", -) -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->create( - acs_system_id: "123e4567-e89b-12d3-a456-426614174000", - full_name: "Jane Doe", - email_address: "jane@example.com", - phone_number: "+15555550100" -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Create( - context.Background(), - users.UsersCreateRequest{ - AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FullName: api.String("Jane Doe"), - EmailAddress: api.String("jane@example.com"), - PhoneNumber: api.String("+15555550100"), - }, - ) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - -### Create a new ACS user - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. +## Additional Code Samples {% tabs %} {% tab title="JavaScript" %} @@ -984,11 +446,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - -### Create a new ACS user in an access group - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). - {% tabs %} {% tab title="JavaScript" %} #### Request @@ -1162,5 +619,3 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} - - diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 9917670cc..fcae60e5b 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -128,114 +128,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Delete an ACS user - -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.delete({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Delete( - context.Background(), - users.UsersDeleteRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 12ab83e39..997149da3 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -174,160 +174,3 @@ ID of the desired `acs_user`. ## Return Type [acs\_user](./) - -*** - -## Code Samples -### Get a specific ACS user - -Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.get({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Get( - context.Background(), - users.UsersGetRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 5e6693d69..b23c5a49e 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -228,150 +228,3 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s ## Return Type Array<[acs\_user](./)> - -*** - -## Code Samples -### List all ACS users - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.list(); -``` - -#### Response - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.list() -``` - -#### Response - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.list() -``` - -#### Response - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->list(); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users list -``` - -#### Response - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -func main() { - client.Acs.Users.List(context.Background()) -} -``` - -#### Response - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 7d977b4b6..c5c4ad636 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -27,8 +27,3 @@ ID of the desired `acs_user`. ## Return Type Array<[acs\_entrance](./)> - -*** - -## Code Samples - diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 364a86040..7a5808809 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -148,125 +148,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Remove an ACS user from an access group - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.removeFromAccessGroup({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.remove_from_access_group( - acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.remove_from_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->remove_from_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.RemoveFromAccessGroup( - context.Background(), - users.UsersRemoveFromAccessGroupRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 03f020b54..8a5357160 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -26,8 +26,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index e97251386..3e7988c69 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -128,114 +128,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Suspend an ACS user - -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.suspend({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Suspend( - context.Background(), - users.UsersSuspendRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 7e0adb646..e2f624dd0 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -130,116 +130,3 @@ ID of the desired `acs_user`. ## Return Type void - -*** - -## Code Samples -### Unsuspend an ACS user - -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.unsuspend({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->unsuspend( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Unsuspend( - context.Background(), - users.UsersUnsuspendRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 0bee5cc50..dccb7c8af 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -192,124 +192,3 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc ## Return Type void - -*** - -## Code Samples -### Update an ACS user - -Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.acs.users.update({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - phone_number: "+15555550222", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.acs.users.update( - acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", phone_number="+15555550222" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.acs.users.update( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - phone_number: "+15555550222", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -acs->users->update( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - phone_number: "+15555550222" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Update( - context.Background(), - users.UsersUpdateRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - PhoneNumber: api.String("+15555550222"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index ed1250399..00de709b3 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -27,8 +27,3 @@ Device ID of the desired phone. ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 48e060396..1c06ba47a 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -26,8 +26,3 @@ Device ID of the desired phone. ## Return Type [phone](./) - -*** - -## Code Samples - diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index bfab017d9..d0e79e40a 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,8 +35,3 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type Array<[phone](./)> - -*** - -## Code Samples - diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index ddff632a6..a1e393a65 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -53,8 +53,3 @@ Metadata to associate with the simulated phone. ## Return Type [phone](./) - -*** - -## Code Samples - diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 5c8997a42..2f654e1d3 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -199,144 +199,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Activate a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.activateClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", - "status": "pending", - "action_type": "ACTIVATE_CLIMATE_PRESET" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.activate_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="05de2295-d1dc-4748-aae3-9931658bde20", - status="pending", - action_type="ACTIVATE_CLIMATE_PRESET", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.activate_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20", - "status" => "pending", - "action_type" => "ACTIVATE_CLIMATE_PRESET", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->activate_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied" -); -``` - -#### Response - -```php - "05de2295-d1dc-4748-aae3-9931658bde20", - "status" => "pending", - "action_type" => "ACTIVATE_CLIMATE_PRESET", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", - "status": "pending", - "action_type": "ACTIVATE_CLIMATE_PRESET" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.ActivateClimatePreset( - context.Background(), - api.ThermostatsActivateClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 8c2eecb37..9794da83a 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -209,144 +209,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set to cool mode - -Specify the desired cooling set point in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.cool({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_COOL" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.cool( - device_id="123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius=25 -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_COOL", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_COOL", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25 -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_COOL", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_COOL" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.Cool( - context.Background(), - api.ThermostatsCoolRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - CoolingSetPointCelsius: api.Float64(25), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index b36396fb5..069c4b3c5 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -250,154 +250,3 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void - -*** - -## Code Samples -### Create a climate preset - -Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.createClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - name: "Occupied", - fan_mode_setting: "auto", - hvac_mode_setting: "heat_cool", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, - manual_override_allowed: true, -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.create_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", - climate_preset_key="occupied", - name="Occupied", - fan_mode_setting="auto", - hvac_mode_setting="heat_cool", - cooling_set_point_celsius=25, - heating_set_point_celsius=20, - manual_override_allowed=true, -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.create_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - name: "Occupied", - fan_mode_setting: "auto", - hvac_mode_setting: "heat_cool", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, - manual_override_allowed: true, -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->create_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - name: "Occupied", - fan_mode_setting: "auto", - hvac_mode_setting: "heat_cool", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, - manual_override_allowed: true -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.CreateClimatePreset( - context.Background(), - api.ThermostatsCreateClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - Name: api.String("Occupied"), - FanModeSetting: api.String("auto"), - HvacModeSetting: api.String("heat_cool"), - CoolingSetPointCelsius: api.Float64(25), - HeatingSetPointCelsius: api.Float64(20), - ManualOverrideAllowed: api.Bool(true), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index df31db85a..570123781 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -147,123 +147,3 @@ ID of the desired thermostat device. ## Return Type void - -*** - -## Code Samples -### Delete a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.deleteClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.delete_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.delete_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->delete_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.DeleteClimatePreset( - context.Background(), - api.ThermostatsDeleteClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index b11967e9d..bb1189645 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -209,144 +209,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set to heat mode - -Specify the desired heating set point in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.heat({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - heating_set_point_celsius: 20, -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.heat( - device_id="123e4567-e89b-12d3-a456-426614174000", heating_set_point_celsius=20 -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_HEAT", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.heat( - device_id: "123e4567-e89b-12d3-a456-426614174000", - heating_set_point_celsius: 20, -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->heat( - device_id: "123e4567-e89b-12d3-a456-426614174000", - heating_set_point_celsius: 20 -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20 -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.Heat( - context.Background(), - api.ThermostatsHeatRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - HeatingSetPointCelsius: api.Float64(20), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index b78365c3e..e29392489 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -233,150 +233,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set to heat-cool (auto) mode - -Specify the desired heating set point in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.heatCool({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT_COOL" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.heat_cool( - device_id="123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius=25, - heating_set_point_celsius=20, -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_HEAT_COOL", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.heat_cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT_COOL", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->heat_cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20 -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT_COOL", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT_COOL" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.HeatCool( - context.Background(), - api.ThermostatsHeatCoolRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - CoolingSetPointCelsius: api.Float64(25), - HeatingSetPointCelsius: api.Float64(20), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index cf3336306..f0adedbe6 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -330,225 +330,3 @@ Your own internal user ID for the user by which to filter devices. ## Return Type Array<[device](./)> - -*** - -## Code Samples -### List thermostats - -To filter the list of returned thermostats, specify the desired parameters. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.list(); -``` - -#### Response - -```javascript -[ - { - "device_id": "123e4567-e89b-12d3-a456-426614174000", - "device_type": "ecobee_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "name": "Entryway", - "online": "true,", - "relative_humidity": 0.36, - "temperature_farenheit": 70, - "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "cooling_set_point_farenheit": 75, - "heating_set_point_farenheit": 65, - "manual_override_allowed": false - }, - "location": null, - "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z" - } - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.list() -``` - -#### Response - -```python -[ - Device( - device_id="123e4567-e89b-12d3-a456-426614174000", - device_type="ecobee_thermostat", - capabilities_supported=["thermostat"], - properties={ - "name": "Entryway", - "online": "true,", - "relative_humidity": 0.36, - "temperature_farenheit": 70, - "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "cooling_set_point_farenheit": 75, - "heating_set_point_farenheit": 65, - "manual_override_allowed": false, - }, - "location": null, - "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - }, - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.list() -``` - -#### Response - -```ruby -[ - { - "device_id" => "123e4567-e89b-12d3-a456-426614174000", - "device_type" => "ecobee_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => { - name: "Entryway", - online: "true,", - relative_humidity: 0.36, - temperature_farenheit: 70, - available_hvac_mode_settings: %w[cool heat heat_cool off], - current_climate_setting: { - hvac_mode_setting: "heat_cool", - cooling_set_point_farenheit: 75, - heating_set_point_farenheit: 65, - manual_override_allowed: false, - }, - location: null, - connected_account_id: "123e4567-e89b-12d3-a456-426614174000", - workspace_id: "123e4567-e89b-12d3-a456-426614174000", - created_at: "2024-04-05T07:57:05.323Z", - }, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->list(); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "device_type" => "ecobee_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => [ - "name" => "Entryway", - "online" => "true,", - "relative_humidity" => 0.36, - "temperature_farenheit" => 70, - "available_hvac_mode_settings" => [ - "cool", - "heat", - "heat_cool", - "off", - ], - "current_climate_setting" => [ - "hvac_mode_setting" => "heat_cool", - "cooling_set_point_farenheit" => 75, - "heating_set_point_farenheit" => 65, - "manual_override_allowed" => false, - ], - "location" => null, - "connected_account_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - ], - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats list -``` - -#### Response - -```seam_cli -[ - { - "device_id": "123e4567-e89b-12d3-a456-426614174000", - "device_type": "ecobee_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "name": "Entryway", - "online": "true,", - "relative_humidity": 0.36, - "temperature_farenheit": 70, - "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "cooling_set_point_farenheit": 75, - "heating_set_point_farenheit": 65, - "manual_override_allowed": false - }, - "location": null, - "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z" - } - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -func main() { - client.Thermostats.List(context.Background()) -} -``` - -#### Response - -```go -[]api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 25108600a..0242bd842 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -181,134 +181,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set to off mode - -Specify the `device_id` of the thermostat that you want to set to off mode. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.off({ - device_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_THERMOSTAT_OFF" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_THERMOSTAT_OFF", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_THERMOSTAT_OFF", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_THERMOSTAT_OFF", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_THERMOSTAT_OFF" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.Off( - context.Background(), - api.ThermostatsOffRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 40cdd6e4f..834ad88a1 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -255,186 +255,3 @@ User-friendly name to identify the thermostat schedule. ## Return Type [thermostat\_schedule](./) - -*** - -## Code Samples -### Create a thermostat schedule - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.create({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - name: "Reservation 1", - climate_preset_key: "occupied", - starts_at: "2024-11-01T15:00:00Z", - ends_at: "2024-11-05T12:00:00Z", - max_override_period_minutes: 90, -}); -``` - -#### Response - -```javascript -{ - "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name": "Reservation 1", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-01T15:00:00.000Z", - "ends_at": "2024-11-05T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.create( - device_id="123e4567-e89b-12d3-a456-426614174000", - name="Reservation 1", - climate_preset_key="occupied", - starts_at="2024-11-01T15:00:00Z", - ends_at="2024-11-05T12:00:00Z", - max_override_period_minutes=90, -) -``` - -#### Response - -```python -ThermostatSchedule( - thermostat_schedule_id="56d29fcf-0674-4db5-8e03-b2370a77460a", - name="Reservation 1", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-01T15:00:00.000Z", - ends_at="2024-11-05T12:00:00.000Z", - max_override_period_minutes=90, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.create( - device_id: "123e4567-e89b-12d3-a456-426614174000", - name: "Reservation 1", - climate_preset_key: "occupied", - starts_at: "2024-11-01T15:00:00Z", - ends_at: "2024-11-05T12:00:00Z", - max_override_period_minutes: 90, -) -``` - -#### Response - -```ruby -{ - "thermostat_schedule_id" => "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name" => "Reservation 1", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-01T15:00:00.000Z", - "ends_at" => "2024-11-05T12:00:00.000Z", - "max_override_period_minutes" => 90, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->create( - device_id: "123e4567-e89b-12d3-a456-426614174000", - name: "Reservation 1", - climate_preset_key: "occupied", - starts_at: "2024-11-01T15:00:00Z", - ends_at: "2024-11-05T12:00:00Z", - max_override_period_minutes: 90 -); -``` - -#### Response - -```php - "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name" => "Reservation 1", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-01T15:00:00.000Z", - "ends_at" => "2024-11-05T12:00:00.000Z", - "max_override_period_minutes" => 90, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90 -``` - -#### Response - -```seam_cli -{ - "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name": "Reservation 1", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-01T15:00:00.000Z", - "ends_at": "2024-11-05T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Create( - context.Background(), - schedules.SchedulesCreateRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - Name: api.String("Reservation 1"), - ClimatePresetKey: api.String("occupied"), - StartsAt: api.String("2024-11-01T15:00:00Z"), - EndsAt: api.String("2024-11-05T12:00:00Z"), - MaxOverridePeriodMinutes: api.Float64(90), - }, - ) -} -``` - -#### Response - -```go -api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 52fa56149..ca4fc4575 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -133,118 +133,3 @@ ID of the desired thermostat schedule. ## Return Type void - -*** - -## Code Samples -### Delete a thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.delete({ - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.delete( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->delete( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Delete( - context.Background(), - schedules.SchedulesDeleteRequest{ - ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 1cb2eff7c..1534426d7 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -174,159 +174,3 @@ ID of the desired thermostat schedule. ## Return Type [thermostat\_schedule](./) - -*** - -## Code Samples -### Get a specific thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.get({ - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", -}); -``` - -#### Response - -```javascript -{ - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.get( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" -) -``` - -#### Response - -```python -ThermostatSchedule( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", - name="Reservation 2", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-10T15:00:00.000Z", - ends_at="2024-11-15T12:00:00.000Z", - max_override_period_minutes=90, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") -``` - -#### Response - -```ruby -{ - "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->get( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -); -``` - -#### Response - -```php - "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -``` - -#### Response - -```seam_cli -{ - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Get( - context.Background(), - schedules.SchedulesGetRequest{ - ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), - }, - ) -} -``` - -#### Response - -```go -api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 8bc2bd352..3ee8d7463 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -236,212 +236,3 @@ User identifier key by which to filter the list of returned thermostat schedules ## Return Type Array<[thermostat\_schedule](./)> - -*** - -## Code Samples -### List thermostat schedules for a thermostat - -Specify the `device_id` of the desired thermostat. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.list({ - device_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Response - -```javascript -[ - { - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 - }, - { - "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", - "name": "Reservation 3", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-16T15:00:00.000Z", - "ends_at": "2024-11-18T12:00:00.000Z", - "max_override_period_minutes": 90 - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```python -[ - ThermostatSchedule( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", - name="Reservation 2", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-10T15:00:00.000Z", - ends_at="2024-11-15T12:00:00.000Z", - max_override_period_minutes=90, - ), - ThermostatSchedule( - thermostat_schedule_id="665553d1-94f9-4e92-9739-06ac6362c959", - name="Reservation 3", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-16T15:00:00.000Z", - ends_at="2024-11-18T12:00:00.000Z", - max_override_period_minutes=90, - ), -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Response - -```ruby -[ - { - "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, - }, - { - "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", - "name" => "Reservation 3", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-16T15:00:00.000Z", - "ends_at" => "2024-11-18T12:00:00.000Z", - "max_override_period_minutes" => 90, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->list( - device_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Response - -```php - "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, - ], - [ - "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", - "name" => "Reservation 3", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-16T15:00:00.000Z", - "ends_at" => "2024-11-18T12:00:00.000Z", - "max_override_period_minutes" => 90, - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Response - -```seam_cli -[ - { - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 - }, - { - "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", - "name": "Reservation 3", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-16T15:00:00.000Z", - "ends_at": "2024-11-18T12:00:00.000Z", - "max_override_period_minutes": 90 - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.List( - context.Background(), - schedules.SchedulesListRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Response - -```go -[]api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 71697435e..3c72f533a 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -194,125 +194,3 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www ## Return Type void - -*** - -## Code Samples -### Update a thermostat schedule - -Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.schedules.update({ - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at: "2024-11-15T15:00:00Z", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.schedules.update( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at="2024-11-15T15:00:00Z", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.schedules.update( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at: "2024-11-15T15:00:00Z", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->schedules->update( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at: "2024-11-15T15:00:00Z" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Update( - context.Background(), - schedules.SchedulesUpdateRequest{ - ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), - EndsAt: api.String("2024-11-15T15:00:00Z"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 780307793..2cbfe3e09 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -146,123 +146,3 @@ ID of the desired thermostat device. ## Return Type void - -*** - -## Code Samples -### Set the fallback climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.setFallbackClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "eco", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.set_fallback_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="eco" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.set_fallback_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "eco", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->set_fallback_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "eco" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetFallbackClimatePreset( - context.Background(), - api.ThermostatsSetFallbackClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("eco"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index c5fc81c86..8f42e6633 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -209,144 +209,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set fan mode setting - -Specify the desired fan mode setting. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.setFanMode({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - fan_mode_setting: "auto", -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_FAN_MODE" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.set_fan_mode( - device_id="123e4567-e89b-12d3-a456-426614174000", fan_mode_setting="auto" -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_FAN_MODE", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.set_fan_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - fan_mode_setting: "auto", -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_FAN_MODE", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->set_fan_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - fan_mode_setting: "auto" -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_FAN_MODE", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto" -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_FAN_MODE" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetFanMode( - context.Background(), - api.ThermostatsSetFanModeRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FanModeSetting: api.String("auto"), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 0e102e92e..05e2f4bb8 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -247,155 +247,3 @@ Possible enum values: --- - -*** - -## Code Samples -### Set HVAC mode - -Specify the desired heating and cooling set points in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.setHvacMode({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting: "heat_cool", - heating_set_point_celsius: 20, - cooling_set_point_celsius: 25, -}); -``` - -#### Response - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "success", - "action_type": "SET_HVAC_MODE" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.set_hvac_mode( - device_id="123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting="heat_cool", - heating_set_point_celsius=20, - cooling_set_point_celsius=25, -) -``` - -#### Response - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="success", - action_type="SET_HVAC_MODE", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.set_hvac_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting: "heat_cool", - heating_set_point_celsius: 20, - cooling_set_point_celsius: 25, -) -``` - -#### Response - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "success", - "action_type" => "SET_HVAC_MODE", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->set_hvac_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting: "heat_cool", - heating_set_point_celsius: 20, - cooling_set_point_celsius: 25 -); -``` - -#### Response - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "success", - "action_type" => "SET_HVAC_MODE", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25 -``` - -#### Response - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "success", - "action_type": "SET_HVAC_MODE" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetHvacMode( - context.Background(), - api.ThermostatsSetHvacModeRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - HvacModeSetting: api.String("heat_cool"), - HeatingSetPointCelsius: api.Float64(20), - CoolingSetPointCelsius: api.Float64(25), - }, - ) -} -``` - -#### Response - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 0590a0ba1..ca66a4ecc 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -179,129 +179,3 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i ## Return Type void - -*** - -## Code Samples -### Set a temperature threshold - -Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.setTemperatureThreshold({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius: 4, - upper_limit_celsius: 30, -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.set_temperature_threshold( - device_id="123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius=4, - upper_limit_celsius=30, -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.set_temperature_threshold( - device_id: "123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius: 4, - upper_limit_celsius: 30, -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->set_temperature_threshold( - device_id: "123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius: 4, - upper_limit_celsius: 30 -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30 -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetTemperatureThreshold( - context.Background(), - api.ThermostatsSetTemperatureThresholdRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - LowerLimitCelsius: api.Float64(4), - UpperLimitCelsius: api.Float64(30), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 5d17e66bc..490f7e8a4 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -71,8 +71,3 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 0176847da..467b35d50 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -44,8 +44,3 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` ## Return Type void - -*** - -## Code Samples - diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index b00c2bf55..777f9bc9e 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -230,134 +230,3 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void - -*** - -## Code Samples -### Update a climate preset - -Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.thermostats.updateClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - cooling_set_point_celsius: 24, - manual_override_allowed: true, -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.thermostats.update_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", - climate_preset_key="occupied", - cooling_set_point_celsius=24, - manual_override_allowed=true, -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.thermostats.update_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - cooling_set_point_celsius: 24, - manual_override_allowed: true, -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -thermostats->update_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - cooling_set_point_celsius: 24, - manual_override_allowed: true -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.UpdateClimatePreset( - context.Background(), - api.ThermostatsUpdateClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - CoolingSetPointCelsius: api.Float64(24), - ManualOverrideAllowed: api.Bool(true), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 299d79f08..af928ae44 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -147,124 +147,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Add an ACS user to a user identity - -Specify the desired `acs_user_id` and `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.addAcsUser({ - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.add_acs_user( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.add_acs_user( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->add_acs_user( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.AddAcsUser( - context.Background(), - api.UserIdentitiesAddAcsUserRequest{ - UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), - AcsUserId: api.String("4d223973-0874-4831-8630-bfcb29e6bce0"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 8d95a69a3..817473e5c 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -221,180 +221,3 @@ Unique key for the user identity. ## Return Type [user\_identity](./) - -*** - -## Code Samples -### Create a user identity - -Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.create({ - user_identity_key: "jean_doe", - email_address: "jean@example.com", - phone_number: "+15555550110", - full_name: "Jean Doe", -}); -``` - -#### Response - -```javascript -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.create( - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - full_name="Jean Doe", -) -``` - -#### Response - -```python -UserIdentity( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - display_name="Jean Doe", - full_name="Jean Doe", - created_at="2024-01-11T05:37:50.264Z", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.create( - user_identity_key: "jean_doe", - email_address: "jean@example.com", - phone_number: "+15555550110", - full_name: "Jean Doe", -) -``` - -#### Response - -```ruby -{ - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->create( - user_identity_key: "jean_doe", - email_address: "jean@example.com", - phone_number: "+15555550110", - full_name: "Jean Doe" -); -``` - -#### Response - -```php - "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe" -``` - -#### Response - -```seam_cli -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.Create( - context.Background(), - api.UserIdentitiesCreateRequest{ - UserIdentityKey: api.String("jean_doe"), - EmailAddress: api.String("jean@example.com"), - PhoneNumber: api.String("+15555550110"), - FullName: api.String("Jean Doe"), - }, - ) -} -``` - -#### Response - -```go -api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 5cd1d2ae6..2bdc55ac5 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -129,115 +129,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Delete a user identity - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.delete({ - user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135") -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135") -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->delete( - user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.Delete( - context.Background(), - api.UserIdentitiesDeleteRequest{ - UserIdentityId: api.String("44d48b20-0dbe-419d-91ca-ab8bceecd135"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 0fa34d659..2e1962b93 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -134,120 +134,3 @@ ID of the desired enrollment automation. ## Return Type void - -*** - -## Code Samples -### Delete an enrollment automation - -Specify the desired `enrollment_automation_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.enrollmentAutomations.delete({ - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.enrollment_automations.delete( - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.enrollment_automations.delete( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->enrollment_automations->delete( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.Delete( - context.Background(), - enrollmentautomations.EnrollmentAutomationsDeleteRequest{ - EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index e1ca50c85..b53917f31 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -178,163 +178,3 @@ ID of the desired enrollment automation. ## Return Type [enrollment\_automation](./) - -*** - -## Code Samples -### Get an enrollment automation - -Specify the desired `enrollment_automation_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.enrollmentAutomations.get({ - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -}); -``` - -#### Response - -```javascript -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.enrollment_automations.get( - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" -) -``` - -#### Response - -```python -EnrollmentAutomation( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", - acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - is_running=true, - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-09T05:45:33.068Z", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.enrollment_automations.get( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -) -``` - -#### Response - -```ruby -{ - "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->enrollment_automations->get( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" -); -``` - -#### Response - -```php - "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => - "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => - "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" -``` - -#### Response - -```seam_cli -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.Get( - context.Background(), - enrollmentautomations.EnrollmentAutomationsGetRequest{ - EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), - }, - ) -} -``` - -#### Response - -```go -api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 694ceec93..5dc340903 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -228,178 +228,3 @@ ID of the associated ACS user within the credential manager. If you specify a `c ## Return Type [unknown](./) - -*** - -## Code Samples -### Launch an enrollment automation - -Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.enrollmentAutomations.launch({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user: true, -}); -``` - -#### Response - -```javascript -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.enrollment_automations.launch( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id="3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user=true, -) -``` - -#### Response - -```python -Unknown( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", - acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - is_running=true, - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-09T05:45:33.068Z", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.enrollment_automations.launch( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user: true, -) -``` - -#### Response - -```ruby -{ - "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->enrollment_automations->launch( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user: true -); -``` - -#### Response - -```php - "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => - "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => - "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true -``` - -#### Response - -```seam_cli -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.Launch( - context.Background(), - enrollmentautomations.EnrollmentAutomationsLaunchRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - CredentialManagerAcsSystemId: api.String("6737e186-8d54-48ce-a7da-a0be4d252172"), - AcsCredentialPoolId: api.String("3fa85f64-5717-4562-b3fc-2c963f66afa6"), - CreateCredentialManagerUser: api.Bool(true), - }, - ) -} -``` - -#### Response - -```go -api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 24f3a00cc..8ed1a89c7 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -188,173 +188,3 @@ ID of the user identity for which you want to retrieve all enrollment automation ## Return Type Array<[enrollment\_automation](./)> - -*** - -## Code Samples -### List enrollment automations - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.enrollmentAutomations.list({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", -}); -``` - -#### Response - -```javascript -[ - { - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.enrollment_automations.list( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" -) -``` - -#### Response - -```python -[ - EnrollmentAutomation( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", - acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - is_running=true, - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-09T05:45:33.068Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.enrollment_automations.list( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", -) -``` - -#### Response - -```ruby -[ - { - "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->enrollment_automations->list( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -); -``` - -#### Response - -```php - "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => - "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => - "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -``` - -#### Response - -```seam_cli -[ - { - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.List( - context.Background(), - enrollmentautomations.EnrollmentAutomationsListRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - }, - ) -} -``` - -#### Response - -```go -[]api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 6a167fe05..a76dbf454 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -184,161 +184,3 @@ Required: No ## Return Type [user\_identity](./) - -*** - -## Code Samples -### Get a user identity - -Specify the `user_identity_id` of the user identity that you want to retrieve. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.get({ - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", -}); -``` - -#### Response - -```javascript -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") -``` - -#### Response - -```python -UserIdentity( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - display_name="Jean Doe", - full_name="Jean Doe", - created_at="2024-01-11T05:37:50.264Z", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") -``` - -#### Response - -```ruby -{ - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->get( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -); -``` - -#### Response - -```php - "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -``` - -#### Response - -```seam_cli -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.Get( - context.Background(), - api.UserIdentitiesGetRequest{ - UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), - }, - ) -} -``` - -#### Response - -```go -api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index a9d9be01e..b5121cc74 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -147,124 +147,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Grant a user identity access to a device - -Specify the desired `user_identity_id` and `device_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.grantAccessToDevice({ - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.grant_access_to_device( - user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id="054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.grant_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->grant_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.GrantAccessToDevice( - context.Background(), - api.UserIdentitiesGrantAccessToDeviceRequest{ - UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), - DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index f6c16069d..7044c7aaa 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -175,160 +175,3 @@ Required: No ## Return Type Array<[user\_identity](./)> - -*** - -## Code Samples -### List user identities - -To filter the list of user identities, specify the desired `credential_manager_acs_system_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.list(); -``` - -#### Response - -```javascript -[ - { - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.list() -``` - -#### Response - -```python -[ - UserIdentity( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - display_name="Jean Doe", - full_name="Jean Doe", - created_at="2024-01-11T05:37:50.264Z", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.list() -``` - -#### Response - -```ruby -[ - { - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->list(); -``` - -#### Response - -```php - "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities list -``` - -#### Response - -```seam_cli -[ - { - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -func main() { - client.UserIdentities.List(context.Background()) -} -``` - -#### Response - -```go -[]api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 25ab353ef..e84acbefb 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -405,391 +405,3 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Return Type Array<[device](./)> - -*** - -## Code Samples -### List accessible devices for a user identity - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.listAccessibleDevices({ - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", -}); -``` - -#### Response - -```javascript -[ - { - "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname": "", - "display_name": "Seam Thermostat", - "device_type": "nest_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "online": true, - "is_cooling": false, - "is_heating": false, - "manufacturer": "nest", - "nest_metadata": { - "custom_name": "", - "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" - }, - "is_fan_running": false, - "has_direct_power": true, - "relative_humidity": 0.46, - "temperature_celsius": 24.64, - "temperature_fahrenheit": 76.352, - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "manual_override_allowed": true, - "cooling_set_point_celsius": 21.5, - "heating_set_point_celsius": 20, - "cooling_set_point_fahrenheit": 70.7, - "heating_set_point_fahrenheit": 68 - }, - "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], - "is_temporary_manual_override_active": false, - "name": "", - "appearance": { "name": "" }, - "model": { - "display_name": "Thermostat", - "manufacturer_display_name": "Nest", - "accessory_keypad_supported": false - }, - "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text": "Placeholder Lock Image", - "is_climate_setting_schedule_active": false - }, - "location": null, - "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-02-29T21:57:33.397Z", - "errors": [], - "warnings": [], - "is_managed": true, - "custom_metadata": {} - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.list_accessible_devices( - user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf" -) -``` - -#### Response - -```python -[ - Device( - device_id="054765c8-a2fc-4599-b486-14c19f462c45", - nickname="", - display_name="Seam Thermostat", - device_type="nest_thermostat", - capabilities_supported=["thermostat"], - properties={ - "online": true, - "is_cooling": false, - "is_heating": false, - "manufacturer": "nest", - "nest_metadata": { - "custom_name": "", - "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a", - }, - "is_fan_running": false, - "has_direct_power": true, - "relative_humidity": 0.46, - "temperature_celsius": 24.64, - "temperature_fahrenheit": 76.352, - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "manual_override_allowed": true, - "cooling_set_point_celsius": 21.5, - "heating_set_point_celsius": 20, - "cooling_set_point_fahrenheit": 70.7, - "heating_set_point_fahrenheit": 68, - }, - "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], - "is_temporary_manual_override_active": false, - "name": "", - "appearance": {"name": ""}, - "model": { - "display_name": "Thermostat", - "manufacturer_display_name": "Nest", - "accessory_keypad_supported": false, - }, - "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text": "Placeholder Lock Image", - "is_climate_setting_schedule_active": false, - }, - location=None, - connected_account_id="44284499-a50b-4947-86c1-58264f014be5", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-02-29T21:57:33.397Z", - errors=[], - warnings=[], - is_managed=true, - custom_metadata={}, - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.list_accessible_devices( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", -) -``` - -#### Response - -```ruby -[ - { - "device_id" => "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname" => "", - "display_name" => "Seam Thermostat", - "device_type" => "nest_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => { - online: true, - is_cooling: false, - is_heating: false, - manufacturer: "nest", - nest_metadata: { - custom_name: "", - device_name: - "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - nest_device_id: "bcca8c5f-1854-4906-9911-c877d513e00a", - }, - is_fan_running: false, - has_direct_power: true, - relative_humidity: 0.46, - temperature_celsius: 24.64, - temperature_fahrenheit: 76.352, - current_climate_setting: { - hvac_mode_setting: "heat_cool", - manual_override_allowed: true, - cooling_set_point_celsius: 21.5, - heating_set_point_celsius: 20, - cooling_set_point_fahrenheit: 70.7, - heating_set_point_fahrenheit: 68, - }, - available_hvac_mode_settings: %w[heat cool heat_cool off], - is_temporary_manual_override_active: false, - name: "", - appearance: { - name: "", - }, - model: { - display_name: "Thermostat", - manufacturer_display_name: "Nest", - accessory_keypad_supported: false, - }, - image_url: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - image_alt_text: "Placeholder Lock Image", - is_climate_setting_schedule_active: false, - }, - "location" => nil, - "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-02-29T21:57:33.397Z", - "errors" => [], - "warnings" => [], - "is_managed" => true, - "custom_metadata" => { - }, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->list_accessible_devices( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf" -); -``` - -#### Response - -```php - "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname" => "", - "display_name" => "Seam Thermostat", - "device_type" => "nest_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => [ - "online" => true, - "is_cooling" => false, - "is_heating" => false, - "manufacturer" => "nest", - "nest_metadata" => [ - "custom_name" => "", - "device_name" => - "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id" => "bcca8c5f-1854-4906-9911-c877d513e00a", - ], - "is_fan_running" => false, - "has_direct_power" => true, - "relative_humidity" => 0.46, - "temperature_celsius" => 24.64, - "temperature_fahrenheit" => 76.352, - "current_climate_setting" => [ - "hvac_mode_setting" => "heat_cool", - "manual_override_allowed" => true, - "cooling_set_point_celsius" => 21.5, - "heating_set_point_celsius" => 20, - "cooling_set_point_fahrenheit" => 70.7, - "heating_set_point_fahrenheit" => 68, - ], - "available_hvac_mode_settings" => [ - "heat", - "cool", - "heat_cool", - "off", - ], - "is_temporary_manual_override_active" => false, - "name" => "", - "appearance" => ["name" => ""], - "model" => [ - "display_name" => "Thermostat", - "manufacturer_display_name" => "Nest", - "accessory_keypad_supported" => false, - ], - "image_url" => - "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text" => "Placeholder Lock Image", - "is_climate_setting_schedule_active" => false, - ], - "location" => null, - "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-02-29T21:57:33.397Z", - "errors" => [], - "warnings" => [], - "is_managed" => true, - "custom_metadata" => [], - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" -``` - -#### Response - -```seam_cli -[ - { - "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname": "", - "display_name": "Seam Thermostat", - "device_type": "nest_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "online": true, - "is_cooling": false, - "is_heating": false, - "manufacturer": "nest", - "nest_metadata": { - "custom_name": "", - "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" - }, - "is_fan_running": false, - "has_direct_power": true, - "relative_humidity": 0.46, - "temperature_celsius": 24.64, - "temperature_fahrenheit": 76.352, - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "manual_override_allowed": true, - "cooling_set_point_celsius": 21.5, - "heating_set_point_celsius": 20, - "cooling_set_point_fahrenheit": 70.7, - "heating_set_point_fahrenheit": 68 - }, - "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], - "is_temporary_manual_override_active": false, - "name": "", - "appearance": { "name": "" }, - "model": { - "display_name": "Thermostat", - "manufacturer_display_name": "Nest", - "accessory_keypad_supported": false - }, - "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text": "Placeholder Lock Image", - "is_climate_setting_schedule_active": false - }, - "location": null, - "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-02-29T21:57:33.397Z", - "errors": [], - "warnings": [], - "is_managed": true, - "custom_metadata": {} - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.ListAccessibleDevices( - context.Background(), - api.UserIdentitiesListAccessibleDevicesRequest{ - UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), - }, - ) -} -``` - -#### Response - -```go -[]api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index ab7e02076..27b7403e1 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -193,178 +193,3 @@ ID of the user identity for which you want to retrieve all access control system ## Return Type Array<[acs\_system](./)> - -*** - -## Code Samples -### List ACS systems associated with a user identity - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.listAcsSystems({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", -}); -``` - -#### Response - -```javascript -[ - { - "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "name": "Assa Abloy Credential Service", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-05T07:16:51.971Z", - "system_type": "assa_abloy_credential_service", - "system_type_display_name": "Assa Abloy Credential Service", - "external_type": "assa_abloy_credential_service", - "external_type_display_name": "Assa Abloy Credential Service", - "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.list_acs_systems( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" -) -``` - -#### Response - -```python -[ - AcsSystem( - acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - name="Assa Abloy Credential Service", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-05T07:16:51.971Z", - system_type="assa_abloy_credential_service", - system_type_display_name="Assa Abloy Credential Service", - external_type="assa_abloy_credential_service", - external_type_display_name="Assa Abloy Credential Service", - connected_account_ids=["dc08066f-d9b8-42f0-9c4b-c781cd900153"], - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f") -``` - -#### Response - -```ruby -[ - { - "acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "name" => "Assa Abloy Credential Service", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-05T07:16:51.971Z", - "system_type" => "assa_abloy_credential_service", - "system_type_display_name" => "Assa Abloy Credential Service", - "external_type" => "assa_abloy_credential_service", - "external_type_display_name" => "Assa Abloy Credential Service", - "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->list_acs_systems( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -); -``` - -#### Response - -```php - "6737e186-8d54-48ce-a7da-a0be4d252172", - "name" => "Assa Abloy Credential Service", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-05T07:16:51.971Z", - "system_type" => "assa_abloy_credential_service", - "system_type_display_name" => "Assa Abloy Credential Service", - "external_type" => "assa_abloy_credential_service", - "external_type_display_name" => "Assa Abloy Credential Service", - "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -``` - -#### Response - -```seam_cli -[ - { - "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "name": "Assa Abloy Credential Service", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-05T07:16:51.971Z", - "system_type": "assa_abloy_credential_service", - "system_type_display_name": "Assa Abloy Credential Service", - "external_type": "assa_abloy_credential_service", - "external_type_display_name": "Assa Abloy Credential Service", - "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.ListAcsSystems( - context.Background(), - api.UserIdentitiesListAcsSystemsRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index aedc13092..d585f3090 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -202,188 +202,3 @@ ID of the user identity for which you want to retrieve all ACS users. ## Return Type Array<[acs\_user](./)> - -*** - -## Code Samples -### List ACS users for a user identity - -Specify the desired `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.listAcsUsers({ - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", -}); -``` - -#### Response - -```javascript -[ - { - "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "email_address": "jean@example.com", - "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-11T05:45:41.349Z", - "is_suspended": false, - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address": "jean@example.com", - "user_identity_phone_number": "+15555550110" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.list_acs_users( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -) -``` - -#### Response - -```python -[ - AcsUser( - acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", - display_name="Jean Doe", - full_name="Jean Doe", - email_address="jean@example.com", - acs_system_id="8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-11T05:45:41.349Z", - is_suspended=false, - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_email_address="jean@example.com", - user_identity_phone_number="+15555550110", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") -``` - -#### Response - -```ruby -[ - { - "acs_user_id" => "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "email_address" => "jean@example.com", - "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-11T05:45:41.349Z", - "is_suspended" => false, - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address" => "jean@example.com", - "user_identity_phone_number" => "+15555550110", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->list_acs_users( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -); -``` - -#### Response - -```php - "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "email_address" => "jean@example.com", - "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-11T05:45:41.349Z", - "is_suspended" => false, - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address" => "jean@example.com", - "user_identity_phone_number" => "+15555550110", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -``` - -#### Response - -```seam_cli -[ - { - "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "email_address": "jean@example.com", - "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-11T05:45:41.349Z", - "is_suspended": false, - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address": "jean@example.com", - "user_identity_phone_number": "+15555550110" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.ListAcsUsers( - context.Background(), - api.UserIdentitiesListAcsUsersRequest{ - UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), - }, - ) -} -``` - -#### Response - -```go -[]api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}} -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e395588e7..9ddac01d2 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -147,124 +147,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Remove an ACS user from a user identity - -Specify the desired `acs_user_id` and `user_identity_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.removeAcsUser({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.remove_acs_user( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id="c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.remove_acs_user( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->remove_acs_user( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.RemoveAcsUser( - context.Background(), - api.UserIdentitiesRemoveAcsUserRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - AcsUserId: api.String("c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 0ef025d83..bf09b47be 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -147,124 +147,3 @@ ID of the desired user identity. ## Return Type void - -*** - -## Code Samples -### Revoke access to a device from a user identity - -Specify the desired `user_identity_id` and `device_id`. - -{% tabs %} -{% tab title="JavaScript" %} -#### Request - -```javascript -await seam.userIdentities.revokeAccessToDevice({ - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -}); -``` - -#### Response - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Request - -```python -seam.user_identities.revoke_access_to_device( - user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id="054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Response - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Request - -```ruby -seam.user_identities.revoke_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Response - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Request - -```php -user_identities->revoke_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45" -); -``` - -#### Response - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Request - -```seam_cli -seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" -``` - -#### Response - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Request - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.RevokeAccessToDevice( - context.Background(), - api.UserIdentitiesRevokeAccessToDeviceRequest{ - UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), - DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), - }, - ) -} -``` - -#### Response - -```go -nil -``` -{% endtab %} - -{% endtabs %} - - diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 619573a92..d5deb5c99 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -62,8 +62,3 @@ Unique key for the user identity. ## Return Type void - -*** - -## Code Samples - From 056f4b725b1647c48bc8490e79f0195a6873946d Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 15:56:32 -0400 Subject: [PATCH 028/233] Update code-sample.hbs --- src/layouts/partials/code-sample.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/code-sample.hbs b/src/layouts/partials/code-sample.hbs index 73ef267e6..5302b5f86 100644 --- a/src/layouts/partials/code-sample.hbs +++ b/src/layouts/partials/code-sample.hbs @@ -1,13 +1,13 @@ {% tabs %} {{#each this.code}} {% tab title="{{this.title}}" %} -#### Request +#### Code ```{{@key}} {{this.request}} ``` -#### Response +#### Output ```{{@key}} {{this.response}} From db4a4c353e6782c1b78912f7c3a9388615c2740e Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 19:57:40 +0000 Subject: [PATCH 029/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 24 +++---- docs/api/acs/access_groups/get.md | 24 +++---- docs/api/acs/access_groups/list.md | 24 +++---- .../list_accessible_entrances.md | 24 +++---- docs/api/acs/access_groups/list_users.md | 24 +++---- docs/api/acs/access_groups/remove_user.md | 24 +++---- docs/api/acs/credentials/assign.md | 24 +++---- docs/api/acs/credentials/create.md | 24 +++---- docs/api/acs/credentials/delete.md | 24 +++---- docs/api/acs/credentials/get.md | 24 +++---- docs/api/acs/credentials/list.md | 24 +++---- .../credentials/list_accessible_entrances.md | 24 +++---- docs/api/acs/credentials/unassign.md | 24 +++---- docs/api/acs/credentials/update.md | 24 +++---- docs/api/acs/entrances/get.md | 24 +++---- docs/api/acs/entrances/list.md | 24 +++---- .../entrances/list_credentials_with_access.md | 24 +++---- docs/api/acs/systems/get.md | 24 +++---- docs/api/acs/systems/list.md | 24 +++---- ...mpatible_credential_manager_acs_systems.md | 24 +++---- docs/api/acs/users/add_to_access_group.md | 24 +++---- docs/api/acs/users/create.md | 72 +++++++++---------- docs/api/acs/users/delete.md | 24 +++---- docs/api/acs/users/get.md | 24 +++---- docs/api/acs/users/list.md | 24 +++---- .../api/acs/users/remove_from_access_group.md | 24 +++---- docs/api/acs/users/suspend.md | 24 +++---- docs/api/acs/users/unsuspend.md | 24 +++---- docs/api/acs/users/update.md | 24 +++---- .../thermostats/activate_climate_preset.md | 24 +++---- docs/api/thermostats/cool.md | 24 +++---- docs/api/thermostats/create_climate_preset.md | 24 +++---- docs/api/thermostats/delete_climate_preset.md | 24 +++---- docs/api/thermostats/heat.md | 24 +++---- docs/api/thermostats/heat_cool.md | 24 +++---- docs/api/thermostats/list.md | 24 +++---- docs/api/thermostats/off.md | 24 +++---- docs/api/thermostats/schedules/create.md | 24 +++---- docs/api/thermostats/schedules/delete.md | 24 +++---- docs/api/thermostats/schedules/get.md | 24 +++---- docs/api/thermostats/schedules/list.md | 24 +++---- docs/api/thermostats/schedules/update.md | 24 +++---- .../set_fallback_climate_preset.md | 24 +++---- docs/api/thermostats/set_fan_mode.md | 24 +++---- docs/api/thermostats/set_hvac_mode.md | 24 +++---- .../thermostats/set_temperature_threshold.md | 24 +++---- docs/api/thermostats/update_climate_preset.md | 24 +++---- docs/api/user_identities/add_acs_user.md | 24 +++---- docs/api/user_identities/create.md | 24 +++---- docs/api/user_identities/delete.md | 24 +++---- .../enrollment_automations/delete.md | 24 +++---- .../enrollment_automations/get.md | 24 +++---- .../enrollment_automations/launch.md | 24 +++---- .../enrollment_automations/list.md | 24 +++---- docs/api/user_identities/get.md | 24 +++---- .../user_identities/grant_access_to_device.md | 24 +++---- docs/api/user_identities/list.md | 24 +++---- .../list_accessible_devices.md | 24 +++---- docs/api/user_identities/list_acs_systems.md | 24 +++---- docs/api/user_identities/list_acs_users.md | 24 +++---- docs/api/user_identities/remove_acs_user.md | 24 +++---- .../revoke_access_to_device.md | 24 +++---- 62 files changed, 768 insertions(+), 768 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 983d05410..cb3a6ea88 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -8,7 +8,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.addUser({ @@ -17,7 +17,7 @@ await seam.acs.accessGroups.addUser({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.accessGroups.addUser({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.add_user( @@ -34,7 +34,7 @@ seam.acs.access_groups.add_user( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.add_user( @@ -51,7 +51,7 @@ seam.acs.access_groups.add_user( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->add_user( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-4 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index e33a8cb19..2d145f3fe 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -8,7 +8,7 @@ Returns a specified [access group](https://docs.seam.co/latest/capability-guides {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.get({ @@ -16,7 +16,7 @@ await seam.acs.accessGroups.get({ }); ``` -#### Response +#### Output ```javascript { @@ -35,13 +35,13 @@ await seam.acs.accessGroups.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444") ``` -#### Response +#### Output ```python AcsAccessGroup( @@ -60,13 +60,13 @@ AcsAccessGroup( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444") ``` -#### Response +#### Output ```ruby { @@ -85,7 +85,7 @@ seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-4444444 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->get( ); ``` -#### Response +#### Output ```php acs->access_groups->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444" ``` -#### Response +#### Output ```seam_cli { @@ -139,7 +139,7 @@ seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -157,7 +157,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"} diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 103b790ba..ac95b40bc 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -8,7 +8,7 @@ Returns a list of all [access groups](https://docs.seam.co/latest/capability-gui {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.list({ @@ -17,7 +17,7 @@ await seam.acs.accessGroups.list({ }); ``` -#### Response +#### Output ```javascript [ @@ -38,7 +38,7 @@ await seam.acs.accessGroups.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.list( @@ -47,7 +47,7 @@ seam.acs.access_groups.list( ) ``` -#### Response +#### Output ```python [ @@ -68,7 +68,7 @@ seam.acs.access_groups.list( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.list( @@ -77,7 +77,7 @@ seam.acs.access_groups.list( ) ``` -#### Response +#### Output ```ruby [ @@ -98,7 +98,7 @@ seam.acs.access_groups.list( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->list( ); ``` -#### Response +#### Output ```php acs->access_groups->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333" ``` -#### Response +#### Output ```seam_cli [ @@ -157,7 +157,7 @@ seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-11111111111 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -176,7 +176,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}} diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 265ab76d3..22b221a49 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -8,7 +8,7 @@ Returns a list of all accessible entrances for a specified [access group](https: {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.listAccessibleEntrances({ @@ -16,7 +16,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({ }); ``` -#### Response +#### Output ```javascript [ @@ -33,7 +33,7 @@ await seam.acs.accessGroups.listAccessibleEntrances({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.list_accessible_entrances( @@ -41,7 +41,7 @@ seam.acs.access_groups.list_accessible_entrances( ) ``` -#### Response +#### Output ```python [ @@ -58,7 +58,7 @@ seam.acs.access_groups.list_accessible_entrances( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.list_accessible_entrances( @@ -66,7 +66,7 @@ seam.acs.access_groups.list_accessible_entrances( ) ``` -#### Response +#### Output ```ruby [ @@ -83,7 +83,7 @@ seam.acs.access_groups.list_accessible_entrances( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->list_accessible_entrances( ); ``` -#### Response +#### Output ```php acs->access_groups->list_accessible_entrances( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444" ``` -#### Response +#### Output ```seam_cli [ @@ -133,7 +133,7 @@ seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -151,7 +151,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}} diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index c366a94a6..e783e3e1c 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -8,7 +8,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.listUsers({ @@ -16,7 +16,7 @@ await seam.acs.accessGroups.listUsers({ }); ``` -#### Response +#### Output ```javascript [ @@ -45,7 +45,7 @@ await seam.acs.accessGroups.listUsers({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.list_users( @@ -53,7 +53,7 @@ seam.acs.access_groups.list_users( ) ``` -#### Response +#### Output ```python [ @@ -82,13 +82,13 @@ seam.acs.access_groups.list_users( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444") ``` -#### Response +#### Output ```ruby [ @@ -117,7 +117,7 @@ seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444- {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->list_users( ); ``` -#### Response +#### Output ```php acs->access_groups->list_users( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444" ``` -#### Response +#### Output ```seam_cli [ @@ -191,7 +191,7 @@ seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -209,7 +209,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}} diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 6902f8394..4f3cbd632 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -8,7 +8,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.accessGroups.removeUser({ @@ -17,7 +17,7 @@ await seam.acs.accessGroups.removeUser({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.accessGroups.removeUser({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.access_groups.remove_user( @@ -34,7 +34,7 @@ seam.acs.access_groups.remove_user( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.access_groups.remove_user( @@ -51,7 +51,7 @@ seam.acs.access_groups.remove_user( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->access_groups->remove_user( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-444 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index e1cae31f5..4c8d29656 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -8,7 +8,7 @@ Assigns a specified [credential](../../../capability-guides/access-systems/manag {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.assign({ @@ -17,7 +17,7 @@ await seam.acs.credentials.assign({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.credentials.assign({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.assign( @@ -34,7 +34,7 @@ seam.acs.credentials.assign( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.assign( @@ -51,7 +51,7 @@ seam.acs.credentials.assign( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->assign( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index af1e25bfe..5af2ab77c 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -8,7 +8,7 @@ Creates a new [credential](../../../capability-guides/access-systems/managing-cr {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.create({ @@ -25,7 +25,7 @@ await seam.acs.credentials.create({ }); ``` -#### Response +#### Output ```javascript { @@ -43,7 +43,7 @@ await seam.acs.credentials.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.create( @@ -60,7 +60,7 @@ seam.acs.credentials.create( ) ``` -#### Response +#### Output ```python AcsCredential( @@ -78,7 +78,7 @@ AcsCredential( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.create( @@ -95,7 +95,7 @@ seam.acs.credentials.create( ) ``` -#### Response +#### Output ```ruby { @@ -113,7 +113,7 @@ seam.acs.credentials.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->create( ); ``` -#### Response +#### Output ```php acs->credentials->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z" ``` -#### Response +#### Output ```seam_cli { @@ -174,7 +174,7 @@ seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -198,7 +198,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 9a0fee13f..4b88ad5e6 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -8,7 +8,7 @@ Deletes a specified [credential](../../../capability-guides/access-systems/manag {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.delete({ @@ -16,7 +16,7 @@ await seam.acs.credentials.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.acs.credentials.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666") ``` -#### Response +#### Output ```ruby nil @@ -52,7 +52,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->delete( ); ``` -#### Response +#### Output ```php null @@ -69,13 +69,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli {} @@ -83,7 +83,7 @@ seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-6666666 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -101,7 +101,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 649794cee..7ebf1d496 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -8,7 +8,7 @@ Returns a specified [credential](../../../capability-guides/access-systems/manag {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.get({ @@ -16,7 +16,7 @@ await seam.acs.credentials.get({ }); ``` -#### Response +#### Output ```javascript { @@ -34,13 +34,13 @@ await seam.acs.credentials.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666") ``` -#### Response +#### Output ```python AcsCredential( @@ -58,13 +58,13 @@ AcsCredential( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666") ``` -#### Response +#### Output ```ruby { @@ -82,7 +82,7 @@ seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-66666666666 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->get( ); ``` -#### Response +#### Output ```php acs->credentials->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli { @@ -134,7 +134,7 @@ seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-6666666666 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -152,7 +152,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 2f656b113..989d3912e 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -8,7 +8,7 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/ma {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.list({ @@ -19,7 +19,7 @@ await seam.acs.credentials.list({ }); ``` -#### Response +#### Output ```javascript [ @@ -39,7 +39,7 @@ await seam.acs.credentials.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.list( @@ -50,7 +50,7 @@ seam.acs.credentials.list( ) ``` -#### Response +#### Output ```python [ @@ -70,7 +70,7 @@ seam.acs.credentials.list( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.list( @@ -81,7 +81,7 @@ seam.acs.credentials.list( ) ``` -#### Response +#### Output ```ruby [ @@ -101,7 +101,7 @@ seam.acs.credentials.list( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->list( ); ``` -#### Response +#### Output ```php acs->credentials->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true ``` -#### Response +#### Output ```seam_cli [ @@ -160,7 +160,7 @@ seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" - {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -181,7 +181,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}} diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3dddcd871..3356f1227 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -8,7 +8,7 @@ Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.listAccessibleEntrances({ @@ -16,7 +16,7 @@ await seam.acs.credentials.listAccessibleEntrances({ }); ``` -#### Response +#### Output ```javascript [ @@ -43,7 +43,7 @@ await seam.acs.credentials.listAccessibleEntrances({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.list_accessible_entrances( @@ -51,7 +51,7 @@ seam.acs.credentials.list_accessible_entrances( ) ``` -#### Response +#### Output ```python [ @@ -78,7 +78,7 @@ seam.acs.credentials.list_accessible_entrances( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.list_accessible_entrances( @@ -86,7 +86,7 @@ seam.acs.credentials.list_accessible_entrances( ) ``` -#### Response +#### Output ```ruby [ @@ -108,7 +108,7 @@ seam.acs.credentials.list_accessible_entrances( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->list_accessible_entrances( ); ``` -#### Response +#### Output ```php acs->credentials->list_accessible_entrances( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli [ @@ -178,7 +178,7 @@ seam acs credentials list-accessible-entrances --acs_credential_id "66666666-666 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -196,7 +196,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}} diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 187a30eb3..4be027357 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -8,7 +8,7 @@ Unassigns a specified [credential](../../../capability-guides/access-systems/man {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.unassign({ @@ -17,7 +17,7 @@ await seam.acs.credentials.unassign({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.credentials.unassign({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.unassign( @@ -34,7 +34,7 @@ seam.acs.credentials.unassign( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.unassign( @@ -51,7 +51,7 @@ seam.acs.credentials.unassign( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->unassign( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-33333333333 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 549c4a2b5..75b3370d3 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -8,7 +8,7 @@ Updates the code and ends at date and time for a specified [credential](../../.. {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.credentials.update({ @@ -17,7 +17,7 @@ await seam.acs.credentials.update({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.credentials.update({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.credentials.update( @@ -33,7 +33,7 @@ seam.acs.credentials.update( ) ``` -#### Response +#### Output ```python None @@ -41,13 +41,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890") ``` -#### Response +#### Output ```ruby nil @@ -55,7 +55,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->credentials->update( ); ``` -#### Response +#### Output ```php null @@ -73,13 +73,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890" ``` -#### Response +#### Output ```seam_cli {} @@ -87,7 +87,7 @@ seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-6666666 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -106,7 +106,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index b4bbbbdf4..8780c5597 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -8,7 +8,7 @@ Returns a specified [ACS entrance](../../../capability-guides/access-systems/ret {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.entrances.get({ @@ -16,7 +16,7 @@ await seam.acs.entrances.get({ }); ``` -#### Response +#### Output ```javascript { @@ -29,13 +29,13 @@ await seam.acs.entrances.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```python AcsEntrance( @@ -48,13 +48,13 @@ AcsEntrance( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```ruby { @@ -67,7 +67,7 @@ seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->entrances->get( ); ``` -#### Response +#### Output ```php acs->entrances->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli { @@ -109,7 +109,7 @@ seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -127,7 +127,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"} diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index acf540d23..9e8696981 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -8,13 +8,13 @@ Returns a list of all [ACS entrances](../../../capability-guides/access-systems/ {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.entrances.list(); ``` -#### Response +#### Output ```javascript [ @@ -29,13 +29,13 @@ await seam.acs.entrances.list(); {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.entrances.list() ``` -#### Response +#### Output ```python [ @@ -50,13 +50,13 @@ seam.acs.entrances.list() {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.entrances.list() ``` -#### Response +#### Output ```ruby [ @@ -71,14 +71,14 @@ seam.acs.entrances.list() {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->entrances->list(); ``` -#### Response +#### Output ```php acs->entrances->list(); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs entrances list ``` -#### Response +#### Output ```seam_cli [ @@ -115,7 +115,7 @@ seam acs entrances list {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -125,7 +125,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}} diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6cd85a7bf..f8d4dc4e1 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -8,7 +8,7 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/ma {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.entrances.listCredentialsWithAccess({ @@ -16,7 +16,7 @@ await seam.acs.entrances.listCredentialsWithAccess({ }); ``` -#### Response +#### Output ```javascript [ @@ -47,7 +47,7 @@ await seam.acs.entrances.listCredentialsWithAccess({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.entrances.list_credentials_with_access( @@ -55,7 +55,7 @@ seam.acs.entrances.list_credentials_with_access( ) ``` -#### Response +#### Output ```python [ @@ -86,7 +86,7 @@ seam.acs.entrances.list_credentials_with_access( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.entrances.list_credentials_with_access( @@ -94,7 +94,7 @@ seam.acs.entrances.list_credentials_with_access( ) ``` -#### Response +#### Output ```ruby [ @@ -125,7 +125,7 @@ seam.acs.entrances.list_credentials_with_access( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->entrances->list_credentials_with_access( ); ``` -#### Response +#### Output ```php acs->entrances->list_credentials_with_access( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli [ @@ -204,7 +204,7 @@ seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -222,7 +222,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}} diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index a4c54c150..c0eb0551f 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -10,7 +10,7 @@ Specify the desired access control system by including the corresponding `acs_sy {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.systems.get({ @@ -18,7 +18,7 @@ await seam.acs.systems.get({ }); ``` -#### Response +#### Output ```javascript [{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -26,13 +26,13 @@ await seam.acs.systems.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python [AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] @@ -40,13 +40,13 @@ seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby [{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -54,14 +54,14 @@ seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` -#### Response +#### Output ```php acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli [{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -84,7 +84,7 @@ seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -102,7 +102,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 61766cfe3..05a22b0e9 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -12,7 +12,7 @@ response includes all access control systems connected to your workspace. {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.systems.list({ @@ -20,7 +20,7 @@ await seam.acs.systems.list({ }); ``` -#### Response +#### Output ```javascript [{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -28,13 +28,13 @@ await seam.acs.systems.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```python [AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] @@ -42,13 +42,13 @@ seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000 {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```ruby [{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -56,7 +56,7 @@ seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-42661417400 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->systems->list( ); ``` -#### Response +#### Output ```php acs->systems->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli [{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] @@ -88,7 +88,7 @@ seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-4266141740 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -106,7 +106,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 64204002a..9338af5c1 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -12,7 +12,7 @@ systems by including the corresponding `acs_system_id` in the request body. {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ @@ -20,7 +20,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ }); ``` -#### Response +#### Output ```javascript [{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] @@ -28,7 +28,7 @@ await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.systems.list_compatible_credential_manager_acs_systems( @@ -36,7 +36,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ) ``` -#### Response +#### Output ```python [AcsSystem(acs_system_id="aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4")] @@ -44,7 +44,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.systems.list_compatible_credential_manager_acs_systems( @@ -52,7 +52,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( ) ``` -#### Response +#### Output ```ruby [{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] @@ -60,7 +60,7 @@ seam.acs.systems.list_compatible_credential_manager_acs_systems( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->systems->list_compatible_credential_manager_acs_systems( ); ``` -#### Response +#### Output ```php acs->systems->list_compatible_credential_manager_acs_systems( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli [{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] @@ -92,7 +92,7 @@ seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}} diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 220fea9d0..c1da3c7fd 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -8,7 +8,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.addToAccessGroup({ @@ -17,7 +17,7 @@ await seam.acs.users.addToAccessGroup({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.users.addToAccessGroup({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.add_to_access_group( @@ -34,7 +34,7 @@ seam.acs.users.add_to_access_group( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.add_to_access_group( @@ -51,7 +51,7 @@ seam.acs.users.add_to_access_group( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->add_to_access_group( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 01ba1da82..f7028e637 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -8,7 +8,7 @@ Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-sy {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.create({ @@ -19,7 +19,7 @@ await seam.acs.users.create({ }); ``` -#### Response +#### Output ```javascript { @@ -36,7 +36,7 @@ await seam.acs.users.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.create( @@ -47,7 +47,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```python AcsUser( @@ -64,7 +64,7 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.create( @@ -75,7 +75,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```ruby { @@ -92,7 +92,7 @@ seam.acs.users.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->create( ); ``` -#### Response +#### Output ```php acs->users->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" ``` -#### Response +#### Output ```seam_cli { @@ -145,7 +145,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -166,7 +166,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} @@ -263,7 +263,7 @@ ID of the user identity with which to associate the new `acs_user`. {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.create({ @@ -278,7 +278,7 @@ await seam.acs.users.create({ }); ``` -#### Response +#### Output ```javascript { @@ -295,7 +295,7 @@ await seam.acs.users.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.create( @@ -310,7 +310,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```python AcsUser( @@ -327,7 +327,7 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.create( @@ -342,7 +342,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```ruby { @@ -359,7 +359,7 @@ seam.acs.users.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->create( ); ``` -#### Response +#### Output ```php acs->users->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"} ``` -#### Response +#### Output ```seam_cli { @@ -416,7 +416,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -438,7 +438,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} @@ -448,7 +448,7 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.create({ @@ -460,7 +460,7 @@ await seam.acs.users.create({ }); ``` -#### Response +#### Output ```javascript { @@ -477,7 +477,7 @@ await seam.acs.users.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.create( @@ -489,7 +489,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```python AcsUser( @@ -506,7 +506,7 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.create( @@ -518,7 +518,7 @@ seam.acs.users.create( ) ``` -#### Response +#### Output ```ruby { @@ -535,7 +535,7 @@ seam.acs.users.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->create( ); ``` -#### Response +#### Output ```php acs->users->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"] ``` -#### Response +#### Output ```seam_cli { @@ -589,7 +589,7 @@ seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --f {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -611,7 +611,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index fcae60e5b..a4a6e7537 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -8,7 +8,7 @@ Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.delete({ @@ -16,7 +16,7 @@ await seam.acs.users.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.acs.users.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby nil @@ -52,14 +52,14 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` -#### Response +#### Output ```php null @@ -67,13 +67,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli {} @@ -81,7 +81,7 @@ seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -99,7 +99,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 997149da3..08df27f88 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -8,7 +8,7 @@ Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.get({ @@ -16,7 +16,7 @@ await seam.acs.users.get({ }); ``` -#### Response +#### Output ```javascript { @@ -33,13 +33,13 @@ await seam.acs.users.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python AcsUser( @@ -56,13 +56,13 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby { @@ -79,14 +79,14 @@ seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` -#### Response +#### Output ```php acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli { @@ -127,7 +127,7 @@ seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -145,7 +145,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index b23c5a49e..630c4557b 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -8,13 +8,13 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.list(); ``` -#### Response +#### Output ```javascript { @@ -31,13 +31,13 @@ await seam.acs.users.list(); {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.list() ``` -#### Response +#### Output ```python AcsUser( @@ -54,13 +54,13 @@ AcsUser( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.list() ``` -#### Response +#### Output ```ruby { @@ -77,14 +77,14 @@ seam.acs.users.list() {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->list(); ``` -#### Response +#### Output ```php acs->users->list(); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users list ``` -#### Response +#### Output ```seam_cli { @@ -125,7 +125,7 @@ seam acs users list {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -135,7 +135,7 @@ func main() { } ``` -#### Response +#### Output ```go api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 7a5808809..7e1b25f13 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -8,7 +8,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.removeFromAccessGroup({ @@ -17,7 +17,7 @@ await seam.acs.users.removeFromAccessGroup({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.users.removeFromAccessGroup({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.remove_from_access_group( @@ -34,7 +34,7 @@ seam.acs.users.remove_from_access_group( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.remove_from_access_group( @@ -51,7 +51,7 @@ seam.acs.users.remove_from_access_group( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->remove_from_access_group( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 3e7988c69..bdb5eec73 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -8,7 +8,7 @@ POST /acs/users/suspend ⇒ void {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.suspend({ @@ -16,7 +16,7 @@ await seam.acs.users.suspend({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.acs.users.suspend({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby nil @@ -52,14 +52,14 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); ``` -#### Response +#### Output ```php null @@ -67,13 +67,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli {} @@ -81,7 +81,7 @@ seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -99,7 +99,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index e2f624dd0..eed957e5c 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -8,7 +8,7 @@ POST /acs/users/unsuspend ⇒ void {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.unsuspend({ @@ -16,7 +16,7 @@ await seam.acs.users.unsuspend({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.acs.users.unsuspend({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") ``` -#### Response +#### Output ```ruby nil @@ -52,7 +52,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->unsuspend( ); ``` -#### Response +#### Output ```php null @@ -69,13 +69,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" ``` -#### Response +#### Output ```seam_cli {} @@ -83,7 +83,7 @@ seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -101,7 +101,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index dccb7c8af..a9a5d70aa 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -8,7 +8,7 @@ Updates the properties of a specified [ACS user](https://docs.seam.co/latest/cap {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.update({ @@ -17,7 +17,7 @@ await seam.acs.users.update({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.acs.users.update({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.acs.users.update( @@ -33,7 +33,7 @@ seam.acs.users.update( ) ``` -#### Response +#### Output ```python None @@ -41,7 +41,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.acs.users.update( @@ -50,7 +50,7 @@ seam.acs.users.update( ) ``` -#### Response +#### Output ```ruby nil @@ -58,7 +58,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php acs->users->update( ); ``` -#### Response +#### Output ```php null @@ -76,13 +76,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222" ``` -#### Response +#### Output ```seam_cli {} @@ -90,7 +90,7 @@ seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --pho {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 2f654e1d3..0286eaca8 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -8,7 +8,7 @@ Activates a specified [climate preset](../../capability-guides/thermostats/creat {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.activateClimatePreset({ @@ -17,7 +17,7 @@ await seam.thermostats.activateClimatePreset({ }); ``` -#### Response +#### Output ```javascript { @@ -29,7 +29,7 @@ await seam.thermostats.activateClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.activate_climate_preset( @@ -37,7 +37,7 @@ seam.thermostats.activate_climate_preset( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -49,7 +49,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.activate_climate_preset( @@ -58,7 +58,7 @@ seam.thermostats.activate_climate_preset( ) ``` -#### Response +#### Output ```ruby { @@ -70,7 +70,7 @@ seam.thermostats.activate_climate_preset( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->activate_climate_preset( ); ``` -#### Response +#### Output ```php thermostats->activate_climate_preset( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" ``` -#### Response +#### Output ```seam_cli { @@ -111,7 +111,7 @@ seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-42 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -129,7 +129,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"} diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 9794da83a..fd3f585c4 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -8,7 +8,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.cool({ @@ -17,7 +17,7 @@ await seam.thermostats.cool({ }); ``` -#### Response +#### Output ```javascript { @@ -29,7 +29,7 @@ await seam.thermostats.cool({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.cool( @@ -37,7 +37,7 @@ seam.thermostats.cool( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -49,7 +49,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.cool( @@ -58,7 +58,7 @@ seam.thermostats.cool( ) ``` -#### Response +#### Output ```ruby { @@ -70,7 +70,7 @@ seam.thermostats.cool( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->cool( ); ``` -#### Response +#### Output ```php thermostats->cool( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 ``` -#### Response +#### Output ```seam_cli { @@ -111,7 +111,7 @@ seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooli {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -129,7 +129,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"} diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 069c4b3c5..68f7aea65 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -8,7 +8,7 @@ Creates a [climate preset](../../capability-guides/thermostats/creating-and-mana {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.createClimatePreset({ @@ -23,7 +23,7 @@ await seam.thermostats.createClimatePreset({ }); ``` -#### Response +#### Output ```javascript // void @@ -31,7 +31,7 @@ await seam.thermostats.createClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.create_climate_preset( @@ -46,7 +46,7 @@ seam.thermostats.create_climate_preset( ) ``` -#### Response +#### Output ```python None @@ -54,7 +54,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.create_climate_preset( @@ -69,7 +69,7 @@ seam.thermostats.create_climate_preset( ) ``` -#### Response +#### Output ```ruby nil @@ -77,7 +77,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->create_climate_preset( ); ``` -#### Response +#### Output ```php null @@ -101,13 +101,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true ``` -#### Response +#### Output ```seam_cli {} @@ -115,7 +115,7 @@ seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -139,7 +139,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 570123781..1e11bfedd 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -8,7 +8,7 @@ Deletes a specified [climate preset](../../capability-guides/thermostats/creatin {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.deleteClimatePreset({ @@ -17,7 +17,7 @@ await seam.thermostats.deleteClimatePreset({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.thermostats.deleteClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.delete_climate_preset( @@ -33,7 +33,7 @@ seam.thermostats.delete_climate_preset( ) ``` -#### Response +#### Output ```python None @@ -41,7 +41,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.delete_climate_preset( @@ -50,7 +50,7 @@ seam.thermostats.delete_climate_preset( ) ``` -#### Response +#### Output ```ruby nil @@ -58,7 +58,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->delete_climate_preset( ); ``` -#### Response +#### Output ```php null @@ -76,13 +76,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" ``` -#### Response +#### Output ```seam_cli {} @@ -90,7 +90,7 @@ seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -108,7 +108,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index bb1189645..99d237be9 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -8,7 +8,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.heat({ @@ -17,7 +17,7 @@ await seam.thermostats.heat({ }); ``` -#### Response +#### Output ```javascript { @@ -29,7 +29,7 @@ await seam.thermostats.heat({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.heat( @@ -37,7 +37,7 @@ seam.thermostats.heat( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -49,7 +49,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.heat( @@ -58,7 +58,7 @@ seam.thermostats.heat( ) ``` -#### Response +#### Output ```ruby { @@ -70,7 +70,7 @@ seam.thermostats.heat( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->heat( ); ``` -#### Response +#### Output ```php thermostats->heat( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20 ``` -#### Response +#### Output ```seam_cli { @@ -111,7 +111,7 @@ seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heati {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -129,7 +129,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"} diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index e29392489..7dd3535c7 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -8,7 +8,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.heatCool({ @@ -18,7 +18,7 @@ await seam.thermostats.heatCool({ }); ``` -#### Response +#### Output ```javascript { @@ -30,7 +30,7 @@ await seam.thermostats.heatCool({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.heat_cool( @@ -40,7 +40,7 @@ seam.thermostats.heat_cool( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -52,7 +52,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.heat_cool( @@ -62,7 +62,7 @@ seam.thermostats.heat_cool( ) ``` -#### Response +#### Output ```ruby { @@ -74,7 +74,7 @@ seam.thermostats.heat_cool( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->heat_cool( ); ``` -#### Response +#### Output ```php thermostats->heat_cool( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 ``` -#### Response +#### Output ```seam_cli { @@ -116,7 +116,7 @@ seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" -- {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -135,7 +135,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"} diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index f0adedbe6..97e1d86ee 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -8,13 +8,13 @@ Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guide {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.list(); ``` -#### Response +#### Output ```javascript [ @@ -45,13 +45,13 @@ await seam.thermostats.list(); {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.list() ``` -#### Response +#### Output ```python [ @@ -82,13 +82,13 @@ seam.thermostats.list() {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.list() ``` -#### Response +#### Output ```ruby [ @@ -119,14 +119,14 @@ seam.thermostats.list() {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->list(); ``` -#### Response +#### Output ```php thermostats->list(); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats list ``` -#### Response +#### Output ```seam_cli [ @@ -200,7 +200,7 @@ seam thermostats list {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -210,7 +210,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 0242bd842..cdcf5f277 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -8,7 +8,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.off({ @@ -16,7 +16,7 @@ await seam.thermostats.off({ }); ``` -#### Response +#### Output ```javascript { @@ -28,13 +28,13 @@ await seam.thermostats.off({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```python ActionAttempt( @@ -46,13 +46,13 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```ruby { @@ -64,14 +64,14 @@ seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); ``` -#### Response +#### Output ```php thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli { @@ -102,7 +102,7 @@ seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -119,7 +119,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"} diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 834ad88a1..b3a65ad48 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -8,7 +8,7 @@ Creates a [thermostat schedule](../../../capability-guides/thermostats/creating- {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.create({ @@ -21,7 +21,7 @@ await seam.thermostats.schedules.create({ }); ``` -#### Response +#### Output ```javascript { @@ -37,7 +37,7 @@ await seam.thermostats.schedules.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.create( @@ -50,7 +50,7 @@ seam.thermostats.schedules.create( ) ``` -#### Response +#### Output ```python ThermostatSchedule( @@ -66,7 +66,7 @@ ThermostatSchedule( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.create( @@ -79,7 +79,7 @@ seam.thermostats.schedules.create( ) ``` -#### Response +#### Output ```ruby { @@ -95,7 +95,7 @@ seam.thermostats.schedules.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->create( ); ``` -#### Response +#### Output ```php thermostats->schedules->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90 ``` -#### Response +#### Output ```seam_cli { @@ -148,7 +148,7 @@ seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -171,7 +171,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90} diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index ca4fc4575..caba8dcec 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -8,7 +8,7 @@ Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating- {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.delete({ @@ -16,7 +16,7 @@ await seam.thermostats.schedules.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,7 +24,7 @@ await seam.thermostats.schedules.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.delete( @@ -32,7 +32,7 @@ seam.thermostats.schedules.delete( ) ``` -#### Response +#### Output ```python None @@ -40,13 +40,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") ``` -#### Response +#### Output ```ruby nil @@ -54,7 +54,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->delete( ); ``` -#### Response +#### Output ```php null @@ -71,13 +71,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" ``` -#### Response +#### Output ```seam_cli {} @@ -85,7 +85,7 @@ seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -103,7 +103,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 1534426d7..ea58299fc 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -8,7 +8,7 @@ Returns a specified [thermostat schedule](../../../capability-guides/thermostats {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.get({ @@ -16,7 +16,7 @@ await seam.thermostats.schedules.get({ }); ``` -#### Response +#### Output ```javascript { @@ -32,7 +32,7 @@ await seam.thermostats.schedules.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.get( @@ -40,7 +40,7 @@ seam.thermostats.schedules.get( ) ``` -#### Response +#### Output ```python ThermostatSchedule( @@ -56,13 +56,13 @@ ThermostatSchedule( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") ``` -#### Response +#### Output ```ruby { @@ -78,7 +78,7 @@ seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b- {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->get( ); ``` -#### Response +#### Output ```php thermostats->schedules->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" ``` -#### Response +#### Output ```seam_cli { @@ -126,7 +126,7 @@ seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -144,7 +144,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90} diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 3ee8d7463..eb7144bfe 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -8,7 +8,7 @@ Returns a list of all [thermostat schedules](../../../capability-guides/thermost {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.list({ @@ -16,7 +16,7 @@ await seam.thermostats.schedules.list({ }); ``` -#### Response +#### Output ```javascript [ @@ -43,13 +43,13 @@ await seam.thermostats.schedules.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```python [ @@ -76,13 +76,13 @@ seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000" {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000") ``` -#### Response +#### Output ```ruby [ @@ -109,7 +109,7 @@ seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->list( ); ``` -#### Response +#### Output ```php thermostats->schedules->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000" ``` -#### Response +#### Output ```seam_cli [ @@ -179,7 +179,7 @@ seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-42661417400 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -197,7 +197,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}} diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 3c72f533a..2e3ed380d 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -8,7 +8,7 @@ Updates a specified [thermostat schedule](../../../capability-guides/thermostats {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.schedules.update({ @@ -17,7 +17,7 @@ await seam.thermostats.schedules.update({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.thermostats.schedules.update({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.schedules.update( @@ -34,7 +34,7 @@ seam.thermostats.schedules.update( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.schedules.update( @@ -51,7 +51,7 @@ seam.thermostats.schedules.update( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->schedules->update( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -110,7 +110,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 2cbfe3e09..7d005b9e8 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -8,7 +8,7 @@ Sets a specified [climate preset](../../capability-guides/thermostats/creating-a {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.setFallbackClimatePreset({ @@ -17,7 +17,7 @@ await seam.thermostats.setFallbackClimatePreset({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.thermostats.setFallbackClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.set_fallback_climate_preset( @@ -33,7 +33,7 @@ seam.thermostats.set_fallback_climate_preset( ) ``` -#### Response +#### Output ```python None @@ -41,7 +41,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.set_fallback_climate_preset( @@ -50,7 +50,7 @@ seam.thermostats.set_fallback_climate_preset( ) ``` -#### Response +#### Output ```ruby nil @@ -58,7 +58,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->set_fallback_climate_preset( ); ``` -#### Response +#### Output ```php null @@ -76,13 +76,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco" ``` -#### Response +#### Output ```seam_cli {} @@ -90,7 +90,7 @@ seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a45 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -108,7 +108,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 8f42e6633..f168bf8d3 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -8,7 +8,7 @@ Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermo {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.setFanMode({ @@ -17,7 +17,7 @@ await seam.thermostats.setFanMode({ }); ``` -#### Response +#### Output ```javascript { @@ -29,7 +29,7 @@ await seam.thermostats.setFanMode({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.set_fan_mode( @@ -37,7 +37,7 @@ seam.thermostats.set_fan_mode( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -49,7 +49,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.set_fan_mode( @@ -58,7 +58,7 @@ seam.thermostats.set_fan_mode( ) ``` -#### Response +#### Output ```ruby { @@ -70,7 +70,7 @@ seam.thermostats.set_fan_mode( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->set_fan_mode( ); ``` -#### Response +#### Output ```php thermostats->set_fan_mode( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto" ``` -#### Response +#### Output ```seam_cli { @@ -111,7 +111,7 @@ seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -129,7 +129,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"} diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 05e2f4bb8..4284c60a7 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -8,7 +8,7 @@ Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/c {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.setHvacMode({ @@ -19,7 +19,7 @@ await seam.thermostats.setHvacMode({ }); ``` -#### Response +#### Output ```javascript { @@ -31,7 +31,7 @@ await seam.thermostats.setHvacMode({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.set_hvac_mode( @@ -42,7 +42,7 @@ seam.thermostats.set_hvac_mode( ) ``` -#### Response +#### Output ```python ActionAttempt( @@ -54,7 +54,7 @@ ActionAttempt( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.set_hvac_mode( @@ -65,7 +65,7 @@ seam.thermostats.set_hvac_mode( ) ``` -#### Response +#### Output ```ruby { @@ -77,7 +77,7 @@ seam.thermostats.set_hvac_mode( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->set_hvac_mode( ); ``` -#### Response +#### Output ```php thermostats->set_hvac_mode( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25 ``` -#### Response +#### Output ```seam_cli { @@ -120,7 +120,7 @@ seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -140,7 +140,7 @@ func main() { } ``` -#### Response +#### Output ```go api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"} diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index ca66a4ecc..739e33b13 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -8,7 +8,7 @@ Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-m {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.setTemperatureThreshold({ @@ -18,7 +18,7 @@ await seam.thermostats.setTemperatureThreshold({ }); ``` -#### Response +#### Output ```javascript // void @@ -26,7 +26,7 @@ await seam.thermostats.setTemperatureThreshold({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.set_temperature_threshold( @@ -36,7 +36,7 @@ seam.thermostats.set_temperature_threshold( ) ``` -#### Response +#### Output ```python None @@ -44,7 +44,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.set_temperature_threshold( @@ -54,7 +54,7 @@ seam.thermostats.set_temperature_threshold( ) ``` -#### Response +#### Output ```ruby nil @@ -62,7 +62,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->set_temperature_threshold( ); ``` -#### Response +#### Output ```php null @@ -81,13 +81,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30 ``` -#### Response +#### Output ```seam_cli {} @@ -95,7 +95,7 @@ seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456- {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -114,7 +114,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 777f9bc9e..3c19b84de 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -8,7 +8,7 @@ Updates a specified [climate preset](../../capability-guides/thermostats/creatin {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.thermostats.updateClimatePreset({ @@ -19,7 +19,7 @@ await seam.thermostats.updateClimatePreset({ }); ``` -#### Response +#### Output ```javascript // void @@ -27,7 +27,7 @@ await seam.thermostats.updateClimatePreset({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.thermostats.update_climate_preset( @@ -38,7 +38,7 @@ seam.thermostats.update_climate_preset( ) ``` -#### Response +#### Output ```python None @@ -46,7 +46,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.thermostats.update_climate_preset( @@ -57,7 +57,7 @@ seam.thermostats.update_climate_preset( ) ``` -#### Response +#### Output ```ruby nil @@ -65,7 +65,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php thermostats->update_climate_preset( ); ``` -#### Response +#### Output ```php null @@ -85,13 +85,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true ``` -#### Response +#### Output ```seam_cli {} @@ -99,7 +99,7 @@ seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-4266 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -119,7 +119,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index af928ae44..bd5301b5d 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -8,7 +8,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.addAcsUser({ @@ -17,7 +17,7 @@ await seam.userIdentities.addAcsUser({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.userIdentities.addAcsUser({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.add_acs_user( @@ -34,7 +34,7 @@ seam.user_identities.add_acs_user( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.add_acs_user( @@ -51,7 +51,7 @@ seam.user_identities.add_acs_user( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->add_acs_user( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0b {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 817473e5c..51ea9a19d 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -8,7 +8,7 @@ Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobi {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.create({ @@ -19,7 +19,7 @@ await seam.userIdentities.create({ }); ``` -#### Response +#### Output ```javascript { @@ -36,7 +36,7 @@ await seam.userIdentities.create({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.create( @@ -47,7 +47,7 @@ seam.user_identities.create( ) ``` -#### Response +#### Output ```python UserIdentity( @@ -64,7 +64,7 @@ UserIdentity( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.create( @@ -75,7 +75,7 @@ seam.user_identities.create( ) ``` -#### Response +#### Output ```ruby { @@ -92,7 +92,7 @@ seam.user_identities.create( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->create( ); ``` -#### Response +#### Output ```php user_identities->create( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe" ``` -#### Response +#### Output ```seam_cli { @@ -145,7 +145,7 @@ seam user-identities create --user_identity_key "jean_doe" --email_address "jean {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -165,7 +165,7 @@ func main() { } ``` -#### Response +#### Output ```go api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 2bdc55ac5..87696af33 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -8,7 +8,7 @@ Deletes a specified [user identity](https://docs.seam.co/latest/capability-guide {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.delete({ @@ -16,7 +16,7 @@ await seam.userIdentities.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,13 +24,13 @@ await seam.userIdentities.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135") ``` -#### Response +#### Output ```python None @@ -38,13 +38,13 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135") ``` -#### Response +#### Output ```ruby nil @@ -52,7 +52,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->delete( ); ``` -#### Response +#### Output ```php null @@ -69,13 +69,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135" ``` -#### Response +#### Output ```seam_cli {} @@ -83,7 +83,7 @@ seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceec {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -100,7 +100,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 2e1962b93..775789e14 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -8,7 +8,7 @@ Deletes a specified [enrollment automation](https://docs.seam.co/latest/capabili {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.enrollmentAutomations.delete({ @@ -16,7 +16,7 @@ await seam.userIdentities.enrollmentAutomations.delete({ }); ``` -#### Response +#### Output ```javascript // void @@ -24,7 +24,7 @@ await seam.userIdentities.enrollmentAutomations.delete({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.enrollment_automations.delete( @@ -32,7 +32,7 @@ seam.user_identities.enrollment_automations.delete( ) ``` -#### Response +#### Output ```python None @@ -40,7 +40,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.enrollment_automations.delete( @@ -48,7 +48,7 @@ seam.user_identities.enrollment_automations.delete( ) ``` -#### Response +#### Output ```ruby nil @@ -56,7 +56,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->enrollment_automations->delete( ); ``` -#### Response +#### Output ```php null @@ -73,13 +73,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" ``` -#### Response +#### Output ```seam_cli {} @@ -87,7 +87,7 @@ seam user-identities enrollment-automations delete --enrollment_automation_id "0 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -105,7 +105,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index b53917f31..6d5c1bd19 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -8,7 +8,7 @@ Returns a specified [enrollment automation](https://docs.seam.co/latest/capabili {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.enrollmentAutomations.get({ @@ -16,7 +16,7 @@ await seam.userIdentities.enrollmentAutomations.get({ }); ``` -#### Response +#### Output ```javascript { @@ -32,7 +32,7 @@ await seam.userIdentities.enrollmentAutomations.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.enrollment_automations.get( @@ -40,7 +40,7 @@ seam.user_identities.enrollment_automations.get( ) ``` -#### Response +#### Output ```python EnrollmentAutomation( @@ -56,7 +56,7 @@ EnrollmentAutomation( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.enrollment_automations.get( @@ -64,7 +64,7 @@ seam.user_identities.enrollment_automations.get( ) ``` -#### Response +#### Output ```ruby { @@ -80,7 +80,7 @@ seam.user_identities.enrollment_automations.get( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->enrollment_automations->get( ); ``` -#### Response +#### Output ```php user_identities->enrollment_automations->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" ``` -#### Response +#### Output ```seam_cli { @@ -130,7 +130,7 @@ seam user-identities enrollment-automations get --enrollment_automation_id "0550 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -148,7 +148,7 @@ func main() { } ``` -#### Response +#### Output ```go api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 5dc340903..2f8592bb8 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -8,7 +8,7 @@ Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-gui {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.enrollmentAutomations.launch({ @@ -19,7 +19,7 @@ await seam.userIdentities.enrollmentAutomations.launch({ }); ``` -#### Response +#### Output ```javascript { @@ -35,7 +35,7 @@ await seam.userIdentities.enrollmentAutomations.launch({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.enrollment_automations.launch( @@ -46,7 +46,7 @@ seam.user_identities.enrollment_automations.launch( ) ``` -#### Response +#### Output ```python Unknown( @@ -62,7 +62,7 @@ Unknown( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.enrollment_automations.launch( @@ -73,7 +73,7 @@ seam.user_identities.enrollment_automations.launch( ) ``` -#### Response +#### Output ```ruby { @@ -89,7 +89,7 @@ seam.user_identities.enrollment_automations.launch( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->enrollment_automations->launch( ); ``` -#### Response +#### Output ```php user_identities->enrollment_automations->launch( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true ``` -#### Response +#### Output ```seam_cli { @@ -142,7 +142,7 @@ seam user-identities enrollment-automations launch --user_identity_id "5c945ab5- {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -163,7 +163,7 @@ func main() { } ``` -#### Response +#### Output ```go api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 8ed1a89c7..a8714b3dc 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -8,7 +8,7 @@ Returns a list of all [enrollment automations](https://docs.seam.co/latest/capab {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.enrollmentAutomations.list({ @@ -16,7 +16,7 @@ await seam.userIdentities.enrollmentAutomations.list({ }); ``` -#### Response +#### Output ```javascript [ @@ -34,7 +34,7 @@ await seam.userIdentities.enrollmentAutomations.list({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.enrollment_automations.list( @@ -42,7 +42,7 @@ seam.user_identities.enrollment_automations.list( ) ``` -#### Response +#### Output ```python [ @@ -60,7 +60,7 @@ seam.user_identities.enrollment_automations.list( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.enrollment_automations.list( @@ -68,7 +68,7 @@ seam.user_identities.enrollment_automations.list( ) ``` -#### Response +#### Output ```ruby [ @@ -86,7 +86,7 @@ seam.user_identities.enrollment_automations.list( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->enrollment_automations->list( ); ``` -#### Response +#### Output ```php user_identities->enrollment_automations->list( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" ``` -#### Response +#### Output ```seam_cli [ @@ -140,7 +140,7 @@ seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c7 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -158,7 +158,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}} diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index a76dbf454..886a1925c 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -8,7 +8,7 @@ Returns a specified [user identity](https://docs.seam.co/latest/capability-guide {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.get({ @@ -16,7 +16,7 @@ await seam.userIdentities.get({ }); ``` -#### Response +#### Output ```javascript { @@ -33,13 +33,13 @@ await seam.userIdentities.get({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") ``` -#### Response +#### Output ```python UserIdentity( @@ -56,13 +56,13 @@ UserIdentity( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") ``` -#### Response +#### Output ```ruby { @@ -79,7 +79,7 @@ seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->get( ); ``` -#### Response +#### Output ```php user_identities->get( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" ``` -#### Response +#### Output ```seam_cli { @@ -129,7 +129,7 @@ seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -146,7 +146,7 @@ func main() { } ``` -#### Response +#### Output ```go api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index b5121cc74..2e2471478 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -8,7 +8,7 @@ Grants a specified [user identity](https://docs.seam.co/latest/capability-guides {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.grantAccessToDevice({ @@ -17,7 +17,7 @@ await seam.userIdentities.grantAccessToDevice({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.userIdentities.grantAccessToDevice({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.grant_access_to_device( @@ -34,7 +34,7 @@ seam.user_identities.grant_access_to_device( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.grant_access_to_device( @@ -51,7 +51,7 @@ seam.user_identities.grant_access_to_device( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->grant_access_to_device( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-43 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 7044c7aaa..1c778e2c0 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -8,13 +8,13 @@ Returns a list of all [user identities](https://docs.seam.co/latest/capability-g {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.list(); ``` -#### Response +#### Output ```javascript [ @@ -33,13 +33,13 @@ await seam.userIdentities.list(); {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.list() ``` -#### Response +#### Output ```python [ @@ -58,13 +58,13 @@ seam.user_identities.list() {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.list() ``` -#### Response +#### Output ```ruby [ @@ -83,14 +83,14 @@ seam.user_identities.list() {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->list(); ``` -#### Response +#### Output ```php user_identities->list(); {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities list ``` -#### Response +#### Output ```seam_cli [ @@ -135,7 +135,7 @@ seam user-identities list {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -145,7 +145,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}} diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index e84acbefb..a2a0cde8e 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -8,7 +8,7 @@ Returns a list of all [devices](../../core-concepts/devices/README.md) associate {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.listAccessibleDevices({ @@ -16,7 +16,7 @@ await seam.userIdentities.listAccessibleDevices({ }); ``` -#### Response +#### Output ```javascript [ @@ -76,7 +76,7 @@ await seam.userIdentities.listAccessibleDevices({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.list_accessible_devices( @@ -84,7 +84,7 @@ seam.user_identities.list_accessible_devices( ) ``` -#### Response +#### Output ```python [ @@ -144,7 +144,7 @@ seam.user_identities.list_accessible_devices( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.list_accessible_devices( @@ -152,7 +152,7 @@ seam.user_identities.list_accessible_devices( ) ``` -#### Response +#### Output ```ruby [ @@ -216,7 +216,7 @@ seam.user_identities.list_accessible_devices( {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->list_accessible_devices( ); ``` -#### Response +#### Output ```php user_identities->list_accessible_devices( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" ``` -#### Response +#### Output ```seam_cli [ @@ -359,7 +359,7 @@ seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -376,7 +376,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}} diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 27b7403e1..04df25910 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -8,7 +8,7 @@ Returns a list of all [access control systems](https://docs.seam.co/latest/capab {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.listAcsSystems({ @@ -16,7 +16,7 @@ await seam.userIdentities.listAcsSystems({ }); ``` -#### Response +#### Output ```javascript [ @@ -36,7 +36,7 @@ await seam.userIdentities.listAcsSystems({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.list_acs_systems( @@ -44,7 +44,7 @@ seam.user_identities.list_acs_systems( ) ``` -#### Response +#### Output ```python [ @@ -64,13 +64,13 @@ seam.user_identities.list_acs_systems( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f") ``` -#### Response +#### Output ```ruby [ @@ -90,7 +90,7 @@ seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->list_acs_systems( ); ``` -#### Response +#### Output ```php user_identities->list_acs_systems( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" ``` -#### Response +#### Output ```seam_cli [ @@ -146,7 +146,7 @@ seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -163,7 +163,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}} diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index d585f3090..1c0d08db1 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -8,7 +8,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.listAcsUsers({ @@ -16,7 +16,7 @@ await seam.userIdentities.listAcsUsers({ }); ``` -#### Response +#### Output ```javascript [ @@ -38,7 +38,7 @@ await seam.userIdentities.listAcsUsers({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.list_acs_users( @@ -46,7 +46,7 @@ seam.user_identities.list_acs_users( ) ``` -#### Response +#### Output ```python [ @@ -68,13 +68,13 @@ seam.user_identities.list_acs_users( {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") ``` -#### Response +#### Output ```ruby [ @@ -96,7 +96,7 @@ seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0 {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->list_acs_users( ); ``` -#### Response +#### Output ```php user_identities->list_acs_users( {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" ``` -#### Response +#### Output ```seam_cli [ @@ -156,7 +156,7 @@ seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5- {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -173,7 +173,7 @@ func main() { } ``` -#### Response +#### Output ```go []api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}} diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 9ddac01d2..e5583c1a2 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -8,7 +8,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.removeAcsUser({ @@ -17,7 +17,7 @@ await seam.userIdentities.removeAcsUser({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.userIdentities.removeAcsUser({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.remove_acs_user( @@ -34,7 +34,7 @@ seam.user_identities.remove_acs_user( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.remove_acs_user( @@ -51,7 +51,7 @@ seam.user_identities.remove_acs_user( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->remove_acs_user( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index bf09b47be..8613ef686 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -8,7 +8,7 @@ Revokes access to a specified [device](../../core-concepts/devices/README.md) fr {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.userIdentities.revokeAccessToDevice({ @@ -17,7 +17,7 @@ await seam.userIdentities.revokeAccessToDevice({ }); ``` -#### Response +#### Output ```javascript // void @@ -25,7 +25,7 @@ await seam.userIdentities.revokeAccessToDevice({ {% endtab %} {% tab title="Python" %} -#### Request +#### Code ```python seam.user_identities.revoke_access_to_device( @@ -34,7 +34,7 @@ seam.user_identities.revoke_access_to_device( ) ``` -#### Response +#### Output ```python None @@ -42,7 +42,7 @@ None {% endtab %} {% tab title="Ruby" %} -#### Request +#### Code ```ruby seam.user_identities.revoke_access_to_device( @@ -51,7 +51,7 @@ seam.user_identities.revoke_access_to_device( ) ``` -#### Response +#### Output ```ruby nil @@ -59,7 +59,7 @@ nil {% endtab %} {% tab title="PHP" %} -#### Request +#### Code ```php user_identities->revoke_access_to_device( ); ``` -#### Response +#### Output ```php null @@ -77,13 +77,13 @@ null {% endtab %} {% tab title="Seam CLI" %} -#### Request +#### Code ```seam_cli seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" ``` -#### Response +#### Output ```seam_cli {} @@ -91,7 +91,7 @@ seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4 {% endtab %} {% tab title="Go" %} -#### Request +#### Code ```go package main @@ -109,7 +109,7 @@ func main() { } ``` -#### Response +#### Output ```go nil From 5bd81dd5236f2c3be82e42d5b9783bf9fcc2251b Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 15:59:14 -0400 Subject: [PATCH 030/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 1d65fc9ad..5feafed62 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -20,7 +20,9 @@ {{/if}} {{/each}} +--- {{/if}} + ## Request Parameters {{#if request.parameters.length}} @@ -32,13 +34,16 @@ Required: {{#if this.required}}Yes{{else}}No{{/if}} {{this.description}} -*** +--- {{/each}} {{else}} None {{/if}} + +--- + ## Return Type {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} @@ -48,9 +53,11 @@ None {{/with}} {{#if addtionalCodeSamples.length}} -## Additional Code Samples +--- + +## Code Samples {{#each addtionalCodeSamples}} {{> code-sample }} {{/each}} -{{/if}} \ No newline at end of file +{{/if}} From fd2abcec0eec4f8e52457820d16f247e496a8be0 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 15:59:52 -0400 Subject: [PATCH 031/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 5feafed62..b0385100a 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -58,6 +58,10 @@ None ## Code Samples {{#each addtionalCodeSamples}} +### {{this.title}} + +{{this.description}} + {{> code-sample }} {{/each}} {{/if}} From d718e19e6b7654c5f8c4e3cbb3f68304d4a25e32 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 20:00:57 +0000 Subject: [PATCH 032/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 9 +++-- docs/api/acs/access_groups/get.md | 7 +++- docs/api/acs/access_groups/list.md | 9 +++-- .../list_accessible_entrances.md | 7 +++- docs/api/acs/access_groups/list_users.md | 7 +++- docs/api/acs/access_groups/remove_user.md | 9 +++-- docs/api/acs/credentials/assign.md | 9 +++-- docs/api/acs/credentials/create.md | 27 ++++++++------- docs/api/acs/credentials/delete.md | 7 +++- docs/api/acs/credentials/get.md | 7 +++- docs/api/acs/credentials/list.md | 17 ++++++---- .../credentials/list_accessible_entrances.md | 7 +++- docs/api/acs/credentials/unassign.md | 9 +++-- docs/api/acs/credentials/update.md | 11 +++++-- docs/api/acs/encoders/encode_credential.md | 9 +++-- docs/api/acs/encoders/list.md | 13 +++++--- docs/api/acs/encoders/scan_credential.md | 7 +++- .../next_credential_encode_will_fail.md | 11 +++++-- .../next_credential_encode_will_succeed.md | 9 +++-- .../next_credential_scan_will_fail.md | 11 +++++-- .../next_credential_scan_will_succeed.md | 11 +++++-- docs/api/acs/entrances/get.md | 7 +++- docs/api/acs/entrances/grant_access.md | 9 +++-- docs/api/acs/entrances/list.md | 9 +++-- .../entrances/list_credentials_with_access.md | 9 +++-- docs/api/acs/systems/get.md | 7 +++- docs/api/acs/systems/list.md | 7 +++- ...mpatible_credential_manager_acs_systems.md | 7 +++- docs/api/acs/users/add_to_access_group.md | 9 +++-- docs/api/acs/users/create.md | 33 ++++++++++++++----- docs/api/acs/users/delete.md | 7 +++- docs/api/acs/users/get.md | 7 +++- docs/api/acs/users/list.md | 21 +++++++----- .../acs/users/list_accessible_entrances.md | 7 +++- .../api/acs/users/remove_from_access_group.md | 9 +++-- .../users/revoke_access_to_all_entrances.md | 7 +++- docs/api/acs/users/suspend.md | 7 +++- docs/api/acs/users/unsuspend.md | 7 +++- docs/api/acs/users/update.md | 19 +++++++---- docs/api/phones/deactivate.md | 7 +++- docs/api/phones/get.md | 7 +++- docs/api/phones/list.md | 9 +++-- .../phones/simulate/create_sandbox_phone.md | 13 +++++--- .../thermostats/activate_climate_preset.md | 9 +++-- docs/api/thermostats/cool.md | 11 +++++-- docs/api/thermostats/create_climate_preset.md | 25 ++++++++------ docs/api/thermostats/delete_climate_preset.md | 9 +++-- docs/api/thermostats/heat.md | 11 +++++-- docs/api/thermostats/heat_cool.md | 15 ++++++--- docs/api/thermostats/list.md | 27 ++++++++------- docs/api/thermostats/off.md | 7 +++- docs/api/thermostats/schedules/create.md | 19 +++++++---- docs/api/thermostats/schedules/delete.md | 7 +++- docs/api/thermostats/schedules/get.md | 7 +++- docs/api/thermostats/schedules/list.md | 9 +++-- docs/api/thermostats/schedules/update.md | 19 +++++++---- .../set_fallback_climate_preset.md | 9 +++-- docs/api/thermostats/set_fan_mode.md | 11 +++++-- docs/api/thermostats/set_hvac_mode.md | 17 ++++++---- .../thermostats/set_temperature_threshold.md | 15 ++++++--- .../simulate/hvac_mode_adjusted.md | 17 ++++++---- .../simulate/temperature_reached.md | 11 +++++-- docs/api/thermostats/update_climate_preset.md | 25 ++++++++------ docs/api/user_identities/add_acs_user.md | 9 +++-- docs/api/user_identities/create.md | 13 +++++--- docs/api/user_identities/delete.md | 7 +++- .../enrollment_automations/delete.md | 7 +++- .../enrollment_automations/get.md | 7 +++- .../enrollment_automations/launch.md | 15 ++++++--- .../enrollment_automations/list.md | 7 +++- docs/api/user_identities/get.md | 9 +++-- .../user_identities/grant_access_to_device.md | 9 +++-- docs/api/user_identities/list.md | 7 +++- .../list_accessible_devices.md | 7 +++- docs/api/user_identities/list_acs_systems.md | 7 +++- docs/api/user_identities/list_acs_users.md | 7 +++- docs/api/user_identities/remove_acs_user.md | 9 +++-- .../revoke_access_to_device.md | 9 +++-- docs/api/user_identities/update.md | 15 ++++++--- 79 files changed, 633 insertions(+), 228 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index cb3a6ea88..64b7cf53b 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired access group. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired user. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 2d145f3fe..61eafdcc4 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -172,6 +172,8 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -181,7 +183,10 @@ Required: Yes ID of the desired access group. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index ac95b40bc..8e5d846b6 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -191,6 +191,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -200,7 +202,7 @@ Required: No ID of the access control system for which you want to retrieve all access groups. -*** +--- ### `acs_user_id` @@ -209,7 +211,10 @@ Required: No ID of the user for which you want to retrieve all access groups. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 22b221a49..7c8e0ea1e 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -166,6 +166,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -175,7 +177,10 @@ Required: Yes ID of the access group for which you want to retrieve all accessible entrances. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index e783e3e1c..be8fbb3fb 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -224,6 +224,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -233,7 +235,10 @@ Required: Yes ID of the access group for which you want to retrieve all users. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 4f3cbd632..20a359563 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired access group. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired user. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 4c8d29656..cff78cef3 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired credential. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired user. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 5af2ab77c..e8f14d461 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -213,6 +213,8 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `access_method` @@ -222,7 +224,7 @@ Required: Yes Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. -*** +--- ### `acs_user_id` @@ -231,7 +233,7 @@ Required: Yes ID of the ACS user to whom the new credential belongs. -*** +--- ### `allowed_acs_entrance_ids` @@ -240,7 +242,7 @@ Required: No Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. -*** +--- ### `assa_abloy_vostio_metadata` @@ -249,7 +251,7 @@ Required: No Vostio-specific metadata for the new credential. -*** +--- ### `code` @@ -258,7 +260,7 @@ Required: No Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). -*** +--- ### `credential_manager_acs_system_id` @@ -267,7 +269,7 @@ Required: No ACS system ID of the credential manager for the new credential. -*** +--- ### `ends_at` @@ -276,7 +278,7 @@ Required: No Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. -*** +--- ### `is_multi_phone_sync_credential` @@ -285,7 +287,7 @@ Required: No Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). -*** +--- ### `salto_space_metadata` @@ -294,7 +296,7 @@ Required: No Salto Space-specific metadata for the new credential. -*** +--- ### `starts_at` @@ -303,7 +305,7 @@ Required: No Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- ### `visionline_metadata` @@ -312,7 +314,10 @@ Required: No Visionline-specific metadata for the new credential. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 4b88ad5e6..21871a698 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -116,6 +116,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -125,7 +127,10 @@ Required: Yes ID of the desired credential. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 7ebf1d496..cf4fcb86d 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -167,6 +167,8 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -176,7 +178,10 @@ Required: Yes ID of the desired credential. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 989d3912e..e2648b4c4 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -197,6 +197,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -206,7 +208,7 @@ Required: No ID of the access control system for which you want to retrieve all credentials. -*** +--- ### `acs_user_id` @@ -215,7 +217,7 @@ Required: No ID of the ACS user for which you want to retrieve all credentials. -*** +--- ### `created_before` @@ -224,7 +226,7 @@ Required: No Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. -*** +--- ### `is_multi_phone_sync_credential` @@ -233,7 +235,7 @@ Required: No Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. -*** +--- ### `limit` @@ -242,7 +244,7 @@ Required: No Number of credentials to return. -*** +--- ### `user_identity_id` @@ -251,7 +253,10 @@ Required: No ID of the user identity for which you want to retrieve all credentials. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3356f1227..040f8bc77 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -211,6 +211,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -220,7 +222,10 @@ Required: Yes ID of the credential for which you want to retrieve all entrances to which this credential grants access. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 4be027357..8f47b4362 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired credential. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired user. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 75b3370d3..32c3ba597 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -121,6 +121,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -130,7 +132,7 @@ Required: Yes ID of the desired credential. -*** +--- ### `code` @@ -139,7 +141,7 @@ Required: No Replacement access (PIN) code for the credential. -*** +--- ### `ends_at` @@ -148,7 +150,10 @@ Required: No Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 5a6a6b23a..27b5cda02 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -12,6 +12,8 @@ Encodes an existing [credential](../../../capability-guides/access-systems/manag - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_credential` to encode onto a card. -*** +--- ### `acs_encoder_id` @@ -30,7 +32,10 @@ Required: Yes ID of the `acs_encoder` to use to encode the `acs_credential`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 5705eee18..cc1cdc891 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -12,6 +12,8 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/worki - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_ids` @@ -21,7 +23,7 @@ Required: No IDs of the `acs_encoder`s that you want to retrieve. -*** +--- ### `acs_system_id` @@ -30,7 +32,7 @@ Required: No ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. -*** +--- ### `acs_system_ids` @@ -39,7 +41,7 @@ Required: No IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. -*** +--- ### `limit` @@ -48,7 +50,10 @@ Required: No Number of `acs_encoders` to return. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index b84d478c2..95f13b6b2 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -12,6 +12,8 @@ Scans an encoded [acs_credential](../../../capability-guides/access-systems/mana - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,10 @@ Required: Yes ID of the `acs_encoder` to use for the scan. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 5f919c365..74ab12327 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -12,6 +12,8 @@ Simulates that the next attempt to encode a [credential](../../../../capability- - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. -*** +--- ### `acs_credential_id` @@ -30,7 +32,7 @@ Required: No ID of the `acs_credential` that will fail to be encoded onto a card in the next request. -*** +--- ### `error_code` @@ -39,7 +41,10 @@ Required: No Code of the error to simulate. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index dd3a7fbee..475332155 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -12,6 +12,8 @@ Simulates that the next attempt to encode a [credential](../../../../capability- - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. -*** +--- ### `scenario` @@ -30,7 +32,10 @@ Required: No Scenario to simulate. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 8a3333506..94c742b1b 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -12,6 +12,8 @@ Simulates that the next attempt to scan a [credential](../../../../capability-gu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. -*** +--- ### `acs_credential_id_on_seam` @@ -30,7 +32,7 @@ Required: No -*** +--- ### `error_code` @@ -39,7 +41,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 92f05df53..89ed40f74 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -12,6 +12,8 @@ Simulates that the next attempt to scan a [credential](../../../../capability-gu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_encoder_id` @@ -21,7 +23,7 @@ Required: Yes ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. -*** +--- ### `acs_credential_id_on_seam` @@ -30,7 +32,7 @@ Required: No ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. -*** +--- ### `scenario` @@ -39,7 +41,10 @@ Required: No Scenario to simulate. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 8780c5597..3af47f2f2 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -141,6 +141,8 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance - API key - Client session token +--- + ## Request Parameters ### `acs_entrance_id` @@ -150,7 +152,10 @@ Required: Yes -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 8ea04aa67..dd1c409a3 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -12,6 +12,8 @@ POST /acs/entrances/grant_access ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_entrance_id` @@ -21,7 +23,7 @@ Required: Yes -*** +--- ### `acs_user_id` @@ -30,7 +32,10 @@ Required: Yes -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 9e8696981..55d7b2890 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -141,6 +141,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -150,7 +152,7 @@ Required: No -*** +--- ### `acs_system_id` @@ -159,7 +161,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index f8d4dc4e1..dbe668d23 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -238,6 +238,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_entrance_id` @@ -247,7 +249,7 @@ Required: Yes -*** +--- ### `include_if` @@ -256,7 +258,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index c0eb0551f..7312d1729 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -117,6 +117,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -126,7 +128,10 @@ Required: Yes ID of the desired access control system. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 05a22b0e9..f9e1ae559 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -122,6 +122,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `connected_account_id` @@ -131,7 +133,10 @@ Required: No ID of the connected account by which to filter the list of returned access control systems. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 9338af5c1..aac19e202 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -125,6 +125,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -134,7 +136,10 @@ Required: Yes ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index c1da3c7fd..fa3bfe620 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired access group. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index f7028e637..bd8dafe61 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -181,6 +181,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -190,7 +192,7 @@ Required: Yes ID of the `acs_system` to which to add the new `acs_user`. -*** +--- ### `full_name` @@ -199,7 +201,7 @@ Required: Yes Full name of the new `acs_user`. -*** +--- ### `access_schedule` @@ -208,7 +210,7 @@ Required: No `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. -*** +--- ### `acs_access_group_ids` @@ -217,7 +219,7 @@ Required: No Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. -*** +--- ### `email` @@ -226,7 +228,7 @@ Required: No -*** +--- ### `email_address` @@ -235,7 +237,7 @@ Required: No Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -*** +--- ### `phone_number` @@ -244,7 +246,7 @@ Required: No Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). -*** +--- ### `user_identity_id` @@ -253,13 +255,22 @@ Required: No ID of the user identity with which to associate the new `acs_user`. -*** +--- + + +--- ## Return Type [acs\_user](./) -## Additional Code Samples +--- + +## Code Samples + +### Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. {% tabs %} {% tab title="JavaScript" %} @@ -446,6 +457,10 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtab %} {% endtabs %} +### Create a new ACS user in an access group + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). + {% tabs %} {% tab title="JavaScript" %} #### Code diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index a4a6e7537..613c0cb44 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -114,6 +114,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -123,7 +125,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 08df27f88..992a2a826 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -160,6 +160,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -169,7 +171,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 630c4557b..0c6795b05 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -151,6 +151,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -160,7 +162,7 @@ Required: No ID of the `acs_system` for which you want to retrieve all `acs_user`s. -*** +--- ### `created_before` @@ -169,7 +171,7 @@ Required: No -*** +--- ### `limit` @@ -178,7 +180,7 @@ Required: No Maximum number of records to return per page. -*** +--- ### `page_cursor` @@ -187,7 +189,7 @@ Required: No Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. -*** +--- ### `search` @@ -196,7 +198,7 @@ Required: No String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, or `email_address`. -*** +--- ### `user_identity_email_address` @@ -205,7 +207,7 @@ Required: No Email address of the user identity for which you want to retrieve all `acs_user`s. -*** +--- ### `user_identity_id` @@ -214,7 +216,7 @@ Required: No ID of the user identity for which you want to retrieve all `acs_user`s. -*** +--- ### `user_identity_phone_number` @@ -223,7 +225,10 @@ Required: No Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index c5c4ad636..83b601fb4 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -13,6 +13,8 @@ Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -22,7 +24,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 7e1b25f13..ea02c3db1 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -125,6 +125,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_access_group_id` @@ -134,7 +136,7 @@ Required: Yes ID of the desired access group. -*** +--- ### `acs_user_id` @@ -143,7 +145,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 8a5357160..0792a2f91 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -12,6 +12,8 @@ Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -21,7 +23,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index bdb5eec73..82dd5a41d 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -114,6 +114,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -123,7 +125,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index eed957e5c..610f93d29 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -116,6 +116,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -125,7 +127,10 @@ Required: Yes ID of the desired `acs_user`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index a9a5d70aa..e6feb1172 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -133,7 +135,7 @@ Required: Yes ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -*** +--- ### `access_schedule` @@ -142,7 +144,7 @@ Required: No `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. -*** +--- ### `email` @@ -151,7 +153,7 @@ Required: No -*** +--- ### `email_address` @@ -160,7 +162,7 @@ Required: No Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -*** +--- ### `full_name` @@ -169,7 +171,7 @@ Required: No Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -*** +--- ### `hid_acs_system_id` @@ -178,7 +180,7 @@ Required: No -*** +--- ### `phone_number` @@ -187,7 +189,10 @@ Required: No Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). -*** +--- + + +--- ## Return Type diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 00de709b3..ca23f0976 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -13,6 +13,8 @@ Deactivates a phone, which is useful, for example, if a user has lost their phon - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -22,7 +24,10 @@ Required: Yes Device ID of the desired phone. -*** +--- + + +--- ## Return Type diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 1c06ba47a..ea2963010 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -12,6 +12,8 @@ Returns a single phone entry matching the provided `device_id`. - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -21,7 +23,10 @@ Required: Yes Device ID of the desired phone. -*** +--- + + +--- ## Return Type diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index d0e79e40a..4c8f0ba27 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -12,6 +12,8 @@ Returns a list of all phones. To filter the list of returned phones by a specifi - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_credential_id` @@ -21,7 +23,7 @@ Required: No ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. -*** +--- ### `owner_user_identity_id` @@ -30,7 +32,10 @@ Required: No ID of the user identity that represents the owner by which to filter the list of returned phones. -*** +--- + + +--- ## Return Type diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index a1e393a65..69fb8abbb 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -12,6 +12,8 @@ Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/wo - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -21,7 +23,7 @@ Required: Yes ID of the user identity to associate with the simulated phone. -*** +--- ### `assa_abloy_metadata` @@ -30,7 +32,7 @@ Required: No ASSA ABLOY metadata to associate with the simulated phone. -*** +--- ### `custom_sdk_installation_id` @@ -39,7 +41,7 @@ Required: No ID of the custom SDK installation to use for the simulated phone. -*** +--- ### `phone_metadata` @@ -48,7 +50,10 @@ Required: No Metadata to associate with the simulated phone. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 0286eaca8..a2fcb370a 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -144,6 +144,8 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -153,7 +155,7 @@ Required: Yes Climate preset key of the desired climate preset. -*** +--- ### `device_id` @@ -162,7 +164,10 @@ Required: Yes ID of the desired thermostat device. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index fd3f585c4..0ff1295c3 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -145,6 +145,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -154,7 +156,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `cooling_set_point_celsius` @@ -163,7 +165,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. -*** +--- ### `cooling_set_point_fahrenheit` @@ -172,7 +174,10 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 68f7aea65..919726dfb 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -155,6 +155,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -164,7 +166,7 @@ Required: Yes Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). -*** +--- ### `device_id` @@ -173,7 +175,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `cooling_set_point_celsius` @@ -182,7 +184,7 @@ Required: No 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` @@ -191,7 +193,7 @@ Required: No Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `fan_mode_setting` @@ -200,7 +202,7 @@ Required: No 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`. -*** +--- ### `heating_set_point_celsius` @@ -209,7 +211,7 @@ Required: No 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` @@ -218,7 +220,7 @@ Required: No 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` @@ -227,7 +229,7 @@ Required: No Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. -*** +--- ### `manual_override_allowed` @@ -236,7 +238,7 @@ Required: No Indicates whether a person at the thermostat or using the API can change the thermostat's settings. -*** +--- ### `name` @@ -245,7 +247,10 @@ Required: No User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 1e11bfedd..6fbc71b8d 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -133,7 +135,7 @@ Required: Yes Climate preset key of the desired climate preset. -*** +--- ### `device_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired thermostat device. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 99d237be9..1c54b3347 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -145,6 +145,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -154,7 +156,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `heating_set_point_celsius` @@ -163,7 +165,7 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. -*** +--- ### `heating_set_point_fahrenheit` @@ -172,7 +174,10 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 7dd3535c7..5700f752e 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -151,6 +151,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -160,7 +162,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `cooling_set_point_celsius` @@ -169,7 +171,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. -*** +--- ### `cooling_set_point_fahrenheit` @@ -178,7 +180,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. -*** +--- ### `heating_set_point_celsius` @@ -187,7 +189,7 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. -*** +--- ### `heating_set_point_fahrenheit` @@ -196,7 +198,10 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 97e1d86ee..337639018 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -226,6 +226,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `connect_webview_id` @@ -235,7 +237,7 @@ Required: No ID of the Connect Webview by which to filter devices. -*** +--- ### `connected_account_id` @@ -244,7 +246,7 @@ Required: No ID of the connected account by which to filter. -*** +--- ### `connected_account_ids` @@ -253,7 +255,7 @@ Required: No Array of IDs of the connected accounts by which to filter devices. -*** +--- ### `created_before` @@ -262,7 +264,7 @@ Required: No Date threshold for devices to return. If specified, returns only devices created before the specified date. -*** +--- ### `custom_metadata_has` @@ -271,7 +273,7 @@ Required: No Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. -*** +--- ### `device_ids` @@ -280,7 +282,7 @@ Required: No Array of device IDs by which to filter devices. -*** +--- ### `device_type` @@ -289,7 +291,7 @@ Required: No Device type by which to filter devices. -*** +--- ### `device_types` @@ -298,7 +300,7 @@ Required: No Array of device types by which to filter devices. -*** +--- ### `limit` @@ -307,7 +309,7 @@ Required: No Numerical limit on the number of devices to return. -*** +--- ### `manufacturer` @@ -316,7 +318,7 @@ Required: No Manufacturer by which to filter devices. -*** +--- ### `user_identifier_key` @@ -325,7 +327,10 @@ Required: No Your own internal user ID for the user by which to filter devices. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index cdcf5f277..ab72399e6 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -135,6 +135,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -144,7 +146,10 @@ Required: Yes ID of the desired thermostat device. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index b3a65ad48..01bb6825b 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -187,6 +187,8 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746 - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -196,7 +198,7 @@ Required: Yes Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. -*** +--- ### `device_id` @@ -205,7 +207,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `ends_at` @@ -214,7 +216,7 @@ Required: Yes Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- ### `starts_at` @@ -223,7 +225,7 @@ Required: Yes Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- ### `is_override_allowed` @@ -232,7 +234,7 @@ Required: No Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `max_override_period_minutes` @@ -241,7 +243,7 @@ Required: No Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `name` @@ -250,7 +252,10 @@ Required: No User-friendly name to identify the thermostat schedule. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index caba8dcec..6ab820dd6 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -119,6 +119,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `thermostat_schedule_id` @@ -128,7 +130,10 @@ Required: Yes ID of the desired thermostat schedule. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index ea58299fc..8f57ca677 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -160,6 +160,8 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `thermostat_schedule_id` @@ -169,7 +171,10 @@ Required: Yes ID of the desired thermostat schedule. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index eb7144bfe..fa858f60b 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -213,6 +213,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -222,7 +224,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `user_identifier_key` @@ -231,7 +233,10 @@ Required: No User identifier key by which to filter the list of returned thermostat schedules. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 2e3ed380d..856591728 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -126,6 +126,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `thermostat_schedule_id` @@ -135,7 +137,7 @@ Required: Yes ID of the desired thermostat schedule. -*** +--- ### `climate_preset_key` @@ -144,7 +146,7 @@ Required: No Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. -*** +--- ### `ends_at` @@ -153,7 +155,7 @@ Required: No Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- ### `is_override_allowed` @@ -162,7 +164,7 @@ Required: No Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `max_override_period_minutes` @@ -171,7 +173,7 @@ Required: No Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `name` @@ -180,7 +182,7 @@ Required: No User-friendly name to identify the thermostat schedule. -*** +--- ### `starts_at` @@ -189,7 +191,10 @@ Required: No Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 7d005b9e8..fd61a735b 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -123,6 +123,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -132,7 +134,7 @@ Required: Yes Climate preset key of the desired climate preset. -*** +--- ### `device_id` @@ -141,7 +143,10 @@ Required: Yes ID of the desired thermostat device. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index f168bf8d3..9a38e83c1 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -145,6 +145,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -154,7 +156,7 @@ Required: Yes -*** +--- ### `fan_mode` @@ -163,7 +165,7 @@ Required: No -*** +--- ### `fan_mode_setting` @@ -172,7 +174,10 @@ Required: No Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 4284c60a7..2da2a5f8e 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -156,6 +156,8 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -165,7 +167,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `hvac_mode_setting` @@ -174,7 +176,7 @@ Required: Yes -*** +--- ### `cooling_set_point_celsius` @@ -183,7 +185,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. -*** +--- ### `cooling_set_point_fahrenheit` @@ -192,7 +194,7 @@ Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. -*** +--- ### `heating_set_point_celsius` @@ -201,7 +203,7 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. -*** +--- ### `heating_set_point_fahrenheit` @@ -210,7 +212,10 @@ Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 739e33b13..5528dd9e6 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -129,6 +129,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -138,7 +140,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `lower_limit_celsius` @@ -147,7 +149,7 @@ Required: No Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. -*** +--- ### `lower_limit_fahrenheit` @@ -156,7 +158,7 @@ Required: No Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. -*** +--- ### `upper_limit_celsius` @@ -165,7 +167,7 @@ Required: No Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. -*** +--- ### `upper_limit_fahrenheit` @@ -174,7 +176,10 @@ Required: No Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 490f7e8a4..40cdbec07 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -12,6 +12,8 @@ Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -21,7 +23,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `hvac_mode` @@ -30,7 +32,7 @@ Required: Yes Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate. -*** +--- ### `cooling_set_point_celsius` @@ -39,7 +41,7 @@ Required: No Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. -*** +--- ### `cooling_set_point_fahrenheit` @@ -48,7 +50,7 @@ Required: No Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. -*** +--- ### `heating_set_point_celsius` @@ -57,7 +59,7 @@ Required: No Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. -*** +--- ### `heating_set_point_fahrenheit` @@ -66,7 +68,10 @@ Required: No Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 467b35d50..0a8e4f423 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -12,6 +12,8 @@ Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermosta - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -21,7 +23,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `temperature_celsius` @@ -30,7 +32,7 @@ Required: No Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. -*** +--- ### `temperature_fahrenheit` @@ -39,7 +41,10 @@ Required: No Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 3c19b84de..25d0a289f 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -135,6 +135,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `climate_preset_key` @@ -144,7 +146,7 @@ Required: Yes Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). -*** +--- ### `device_id` @@ -153,7 +155,7 @@ Required: Yes ID of the desired thermostat device. -*** +--- ### `manual_override_allowed` @@ -162,7 +164,7 @@ Required: Yes Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). -*** +--- ### `cooling_set_point_celsius` @@ -171,7 +173,7 @@ Required: No 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` @@ -180,7 +182,7 @@ Required: No Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). -*** +--- ### `fan_mode_setting` @@ -189,7 +191,7 @@ Required: No 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`. -*** +--- ### `heating_set_point_celsius` @@ -198,7 +200,7 @@ Required: No 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` @@ -207,7 +209,7 @@ Required: No 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` @@ -216,7 +218,7 @@ Required: No Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. -*** +--- ### `name` @@ -225,7 +227,10 @@ Required: No User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index bd5301b5d..b297e03b5 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -133,7 +135,7 @@ Required: Yes ID of the desired ACS user. -*** +--- ### `user_identity_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 51ea9a19d..0e4072c77 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -180,6 +180,8 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `email_address` @@ -189,7 +191,7 @@ Required: No Unique email address for the user identity. -*** +--- ### `full_name` @@ -198,7 +200,7 @@ Required: No Full name of the user associated with the user identity. -*** +--- ### `phone_number` @@ -207,7 +209,7 @@ Required: No Unique phone number for the user identity in E.164 format (for example, +15555550100). -*** +--- ### `user_identity_key` @@ -216,7 +218,10 @@ Required: No Unique key for the user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 87696af33..ae0a623a9 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -115,6 +115,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -124,7 +126,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 775789e14..20f26b195 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -120,6 +120,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `enrollment_automation_id` @@ -129,7 +131,10 @@ Required: Yes ID of the desired enrollment automation. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 6d5c1bd19..04482654c 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -164,6 +164,8 @@ api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `enrollment_automation_id` @@ -173,7 +175,10 @@ Required: Yes ID of the desired enrollment automation. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 2f8592bb8..d1a3e342f 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -178,6 +178,8 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `credential_manager_acs_system_id` @@ -187,7 +189,7 @@ Required: Yes ID of the desired ACS system that serves as the credential manager. -*** +--- ### `user_identity_id` @@ -196,7 +198,7 @@ Required: Yes ID of the desired user identity. -*** +--- ### `acs_credential_pool_id` @@ -205,7 +207,7 @@ Required: No ID of the ACS credential pool from which to obtain credentials for the user identity. -*** +--- ### `create_credential_manager_user` @@ -214,7 +216,7 @@ Required: No Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. -*** +--- ### `credential_manager_acs_user_id` @@ -223,7 +225,10 @@ Required: No ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index a8714b3dc..0d01afedc 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -174,6 +174,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -183,7 +185,10 @@ Required: Yes ID of the user identity for which you want to retrieve all enrollment automations. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 886a1925c..1e8d19f93 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -161,6 +161,8 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -170,7 +172,7 @@ Required: No ID of the desired user identity. -*** +--- ### `user_identity_key` @@ -179,7 +181,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 2e2471478..32e8a5851 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -133,7 +135,7 @@ Required: Yes ID of the desired managed device. -*** +--- ### `user_identity_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 1c778e2c0..345e7edfd 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -161,6 +161,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `credential_manager_acs_system_id` @@ -170,7 +172,10 @@ Required: No -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index a2a0cde8e..ba49e3469 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -391,6 +391,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -400,7 +402,10 @@ Required: Yes ID of the user identity for which you want to retrieve all accessible devices. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 04df25910..c8c2d2247 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -179,6 +179,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -188,7 +190,10 @@ Required: Yes ID of the user identity for which you want to retrieve all access control systems. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 1c0d08db1..029a3bfdf 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -188,6 +188,8 @@ func main() { - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -197,7 +199,10 @@ Required: Yes ID of the user identity for which you want to retrieve all ACS users. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e5583c1a2..372bdd303 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_user_id` @@ -133,7 +135,7 @@ Required: Yes ID of the ACS user. -*** +--- ### `user_identity_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 8613ef686..0b3266fbc 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -124,6 +124,8 @@ nil - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `device_id` @@ -133,7 +135,7 @@ Required: Yes ID of the desired managed device. -*** +--- ### `user_identity_id` @@ -142,7 +144,10 @@ Required: Yes ID of the desired user identity. -*** +--- + + +--- ## Return Type diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index d5deb5c99..06e734511 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -12,6 +12,8 @@ PATCH /user_identities/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `user_identity_id` @@ -21,7 +23,7 @@ Required: Yes ID of the user identity. -*** +--- ### `email_address` @@ -30,7 +32,7 @@ Required: No Unique email address for the user identity. -*** +--- ### `full_name` @@ -39,7 +41,7 @@ Required: No -*** +--- ### `phone_number` @@ -48,7 +50,7 @@ Required: No Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). -*** +--- ### `user_identity_key` @@ -57,7 +59,10 @@ Required: No Unique key for the user identity. -*** +--- + + +--- ## Return Type From 6bcd338d06b2782bd38b8454201c012622f40834 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 17:46:31 -0400 Subject: [PATCH 033/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index b0385100a..8b3ef2d1d 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -42,8 +42,6 @@ None {{/if}} ---- - ## Return Type {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} From 2133a41b0ce7c609939b5250267236996a01beb2 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 21:47:34 +0000 Subject: [PATCH 034/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 2 -- docs/api/acs/access_groups/get.md | 2 -- docs/api/acs/access_groups/list.md | 2 -- docs/api/acs/access_groups/list_accessible_entrances.md | 2 -- docs/api/acs/access_groups/list_users.md | 2 -- docs/api/acs/access_groups/remove_user.md | 2 -- docs/api/acs/credentials/assign.md | 2 -- docs/api/acs/credentials/create.md | 2 -- docs/api/acs/credentials/delete.md | 2 -- docs/api/acs/credentials/get.md | 2 -- docs/api/acs/credentials/list.md | 2 -- docs/api/acs/credentials/list_accessible_entrances.md | 2 -- docs/api/acs/credentials/unassign.md | 2 -- docs/api/acs/credentials/update.md | 2 -- docs/api/acs/encoders/encode_credential.md | 2 -- docs/api/acs/encoders/list.md | 2 -- docs/api/acs/encoders/scan_credential.md | 2 -- .../acs/encoders/simulate/next_credential_encode_will_fail.md | 2 -- .../encoders/simulate/next_credential_encode_will_succeed.md | 2 -- .../api/acs/encoders/simulate/next_credential_scan_will_fail.md | 2 -- .../acs/encoders/simulate/next_credential_scan_will_succeed.md | 2 -- docs/api/acs/entrances/get.md | 2 -- docs/api/acs/entrances/grant_access.md | 2 -- docs/api/acs/entrances/list.md | 2 -- docs/api/acs/entrances/list_credentials_with_access.md | 2 -- docs/api/acs/systems/get.md | 2 -- docs/api/acs/systems/list.md | 2 -- .../systems/list_compatible_credential_manager_acs_systems.md | 2 -- docs/api/acs/users/add_to_access_group.md | 2 -- docs/api/acs/users/create.md | 2 -- docs/api/acs/users/delete.md | 2 -- docs/api/acs/users/get.md | 2 -- docs/api/acs/users/list.md | 2 -- docs/api/acs/users/list_accessible_entrances.md | 2 -- docs/api/acs/users/remove_from_access_group.md | 2 -- docs/api/acs/users/revoke_access_to_all_entrances.md | 2 -- docs/api/acs/users/suspend.md | 2 -- docs/api/acs/users/unsuspend.md | 2 -- docs/api/acs/users/update.md | 2 -- docs/api/phones/deactivate.md | 2 -- docs/api/phones/get.md | 2 -- docs/api/phones/list.md | 2 -- docs/api/phones/simulate/create_sandbox_phone.md | 2 -- docs/api/thermostats/activate_climate_preset.md | 2 -- docs/api/thermostats/cool.md | 2 -- docs/api/thermostats/create_climate_preset.md | 2 -- docs/api/thermostats/delete_climate_preset.md | 2 -- docs/api/thermostats/heat.md | 2 -- docs/api/thermostats/heat_cool.md | 2 -- docs/api/thermostats/list.md | 2 -- docs/api/thermostats/off.md | 2 -- docs/api/thermostats/schedules/create.md | 2 -- docs/api/thermostats/schedules/delete.md | 2 -- docs/api/thermostats/schedules/get.md | 2 -- docs/api/thermostats/schedules/list.md | 2 -- docs/api/thermostats/schedules/update.md | 2 -- docs/api/thermostats/set_fallback_climate_preset.md | 2 -- docs/api/thermostats/set_fan_mode.md | 2 -- docs/api/thermostats/set_hvac_mode.md | 2 -- docs/api/thermostats/set_temperature_threshold.md | 2 -- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 2 -- docs/api/thermostats/simulate/temperature_reached.md | 2 -- docs/api/thermostats/update_climate_preset.md | 2 -- docs/api/user_identities/add_acs_user.md | 2 -- docs/api/user_identities/create.md | 2 -- docs/api/user_identities/delete.md | 2 -- docs/api/user_identities/enrollment_automations/delete.md | 2 -- docs/api/user_identities/enrollment_automations/get.md | 2 -- docs/api/user_identities/enrollment_automations/launch.md | 2 -- docs/api/user_identities/enrollment_automations/list.md | 2 -- docs/api/user_identities/get.md | 2 -- docs/api/user_identities/grant_access_to_device.md | 2 -- docs/api/user_identities/list.md | 2 -- docs/api/user_identities/list_accessible_devices.md | 2 -- docs/api/user_identities/list_acs_systems.md | 2 -- docs/api/user_identities/list_acs_users.md | 2 -- docs/api/user_identities/remove_acs_user.md | 2 -- docs/api/user_identities/revoke_access_to_device.md | 2 -- docs/api/user_identities/update.md | 2 -- 79 files changed, 158 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 64b7cf53b..d280444f8 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -148,8 +148,6 @@ ID of the desired user. --- ---- - ## Return Type void diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 61eafdcc4..2cc9f6028 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -186,8 +186,6 @@ ID of the desired access group. --- ---- - ## Return Type [acs\_access\_group](./) diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 8e5d846b6..e4b00a263 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -214,8 +214,6 @@ ID of the user for which you want to retrieve all access groups. --- ---- - ## Return Type Array<[acs\_access\_group](./)> diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 7c8e0ea1e..e7614ea60 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -180,8 +180,6 @@ ID of the access group for which you want to retrieve all accessible entrances. --- ---- - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index be8fbb3fb..b75ca142d 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -238,8 +238,6 @@ ID of the access group for which you want to retrieve all users. --- ---- - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 20a359563..269906344 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -148,8 +148,6 @@ ID of the desired user. --- ---- - ## Return Type void diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index cff78cef3..80ce54802 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -148,8 +148,6 @@ ID of the desired user. --- ---- - ## Return Type void diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index e8f14d461..f7ee73c9e 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -317,8 +317,6 @@ Visionline-specific metadata for the new credential. --- ---- - ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 21871a698..893f332d3 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -130,8 +130,6 @@ ID of the desired credential. --- ---- - ## Return Type void diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index cf4fcb86d..a03363f2b 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -181,8 +181,6 @@ ID of the desired credential. --- ---- - ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index e2648b4c4..5e4d7fd59 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -256,8 +256,6 @@ ID of the user identity for which you want to retrieve all credentials. --- ---- - ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 040f8bc77..78f717d88 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -225,8 +225,6 @@ ID of the credential for which you want to retrieve all entrances to which this --- ---- - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 8f47b4362..2836e6c0e 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -148,8 +148,6 @@ ID of the desired user. --- ---- - ## Return Type void diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 32c3ba597..a0317d2f4 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -153,8 +153,6 @@ Replacement date and time at which the validity of the credential ends, in [ISO --- ---- - ## Return Type void diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 27b5cda02..ed011b840 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -35,8 +35,6 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index cc1cdc891..7d79694f7 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -53,8 +53,6 @@ Number of `acs_encoders` to return. --- ---- - ## Return Type Array<[acs\_encoder](./)> diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 95f13b6b2..a8f523438 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -26,8 +26,6 @@ ID of the `acs_encoder` to use for the scan. --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 74ab12327..f754ff663 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -44,8 +44,6 @@ Code of the error to simulate. --- ---- - ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 475332155..ff43764bf 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -35,8 +35,6 @@ Scenario to simulate. --- ---- - ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 94c742b1b..28489b42e 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -44,8 +44,6 @@ Required: No --- ---- - ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 89ed40f74..3e2eb3bc3 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -44,8 +44,6 @@ Scenario to simulate. --- ---- - ## Return Type void diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 3af47f2f2..9c06b62fe 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -155,8 +155,6 @@ Required: Yes --- ---- - ## Return Type [acs\_entrance](./) diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index dd1c409a3..86f7acef7 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -35,8 +35,6 @@ Required: Yes --- ---- - ## Return Type void diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 55d7b2890..0c7d45151 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -164,8 +164,6 @@ Required: No --- ---- - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index dbe668d23..faab439d2 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -261,8 +261,6 @@ Required: No --- ---- - ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 7312d1729..d5bb5f40d 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -131,8 +131,6 @@ ID of the desired access control system. --- ---- - ## Return Type [acs\_system](./) diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index f9e1ae559..801c08d5f 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -136,8 +136,6 @@ ID of the connected account by which to filter the list of returned access contr --- ---- - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index aac19e202..054e53f4c 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -139,8 +139,6 @@ ID of the ACS system for which you want to retrieve all compatible credential ma --- ---- - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index fa3bfe620..0740c2a68 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -148,8 +148,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index bd8dafe61..5adddb825 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -258,8 +258,6 @@ ID of the user identity with which to associate the new `acs_user`. --- ---- - ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 613c0cb44..a1fbaf153 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -128,8 +128,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 992a2a826..6fb9a9103 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -174,8 +174,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 0c6795b05..c83996f19 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -228,8 +228,6 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s --- ---- - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 83b601fb4..e67a8abea 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -27,8 +27,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index ea02c3db1..007c9bec9 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -148,8 +148,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 0792a2f91..583a2532b 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -26,8 +26,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 82dd5a41d..c84182810 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -128,8 +128,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 610f93d29..00064209a 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -130,8 +130,6 @@ ID of the desired `acs_user`. --- ---- - ## Return Type void diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index e6feb1172..4e2866bcd 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -192,8 +192,6 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- ---- - ## Return Type void diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index ca23f0976..f160a5fdb 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -27,8 +27,6 @@ Device ID of the desired phone. --- ---- - ## Return Type void diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index ea2963010..8d1166c18 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -26,8 +26,6 @@ Device ID of the desired phone. --- ---- - ## Return Type [phone](./) diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 4c8f0ba27..e85c3aba1 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,8 +35,6 @@ ID of the user identity that represents the owner by which to filter the list of --- ---- - ## Return Type Array<[phone](./)> diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 69fb8abbb..c6ef24d60 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -53,8 +53,6 @@ Metadata to associate with the simulated phone. --- ---- - ## Return Type [phone](./) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index a2fcb370a..4a76e9bf7 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -167,8 +167,6 @@ ID of the desired thermostat device. --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 0ff1295c3..834cec24c 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -177,8 +177,6 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 919726dfb..0d93d5898 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -250,8 +250,6 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- ---- - ## Return Type void diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 6fbc71b8d..13dd99c46 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -147,8 +147,6 @@ ID of the desired thermostat device. --- ---- - ## Return Type void diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 1c54b3347..0ee93ebd8 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -177,8 +177,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 5700f752e..acf0ee0fa 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -201,8 +201,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 337639018..ed07f77cc 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -330,8 +330,6 @@ Your own internal user ID for the user by which to filter devices. --- ---- - ## Return Type Array<[device](./)> diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index ab72399e6..07e778ab1 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -149,8 +149,6 @@ ID of the desired thermostat device. --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 01bb6825b..2749a96e8 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -255,8 +255,6 @@ User-friendly name to identify the thermostat schedule. --- ---- - ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 6ab820dd6..6b64d3d23 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -133,8 +133,6 @@ ID of the desired thermostat schedule. --- ---- - ## Return Type void diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 8f57ca677..102f9e1ef 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -174,8 +174,6 @@ ID of the desired thermostat schedule. --- ---- - ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index fa858f60b..dddd3fafa 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -236,8 +236,6 @@ User identifier key by which to filter the list of returned thermostat schedules --- ---- - ## Return Type Array<[thermostat\_schedule](./)> diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 856591728..2b7c2af5a 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -194,8 +194,6 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www --- ---- - ## Return Type void diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index fd61a735b..362676b36 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -146,8 +146,6 @@ ID of the desired thermostat device. --- ---- - ## Return Type void diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 9a38e83c1..5a88879c2 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -177,8 +177,6 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 2da2a5f8e..82dbc09dd 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -215,8 +215,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- ---- - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 5528dd9e6..b7b4d24ac 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -179,8 +179,6 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i --- ---- - ## Return Type void diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 40cdbec07..11b27a62d 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -71,8 +71,6 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und --- ---- - ## Return Type void diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 0a8e4f423..66a10e442 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -44,8 +44,6 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` --- ---- - ## Return Type void diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 25d0a289f..3e56936f9 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -230,8 +230,6 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- ---- - ## Return Type void diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index b297e03b5..52ed3a60d 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -147,8 +147,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 0e4072c77..07eda4a0a 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -221,8 +221,6 @@ Unique key for the user identity. --- ---- - ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index ae0a623a9..2f56d236e 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -129,8 +129,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 20f26b195..e914ebc3e 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -134,8 +134,6 @@ ID of the desired enrollment automation. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 04482654c..ee922cf72 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -178,8 +178,6 @@ ID of the desired enrollment automation. --- ---- - ## Return Type [enrollment\_automation](./) diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index d1a3e342f..8ca8fb9d4 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -228,8 +228,6 @@ ID of the associated ACS user within the credential manager. If you specify a `c --- ---- - ## Return Type [unknown](./) diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 0d01afedc..7e8901f8f 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -188,8 +188,6 @@ ID of the user identity for which you want to retrieve all enrollment automation --- ---- - ## Return Type Array<[enrollment\_automation](./)> diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 1e8d19f93..e5af4532e 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -184,8 +184,6 @@ Required: No --- ---- - ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 32e8a5851..c7fea2e76 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -147,8 +147,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 345e7edfd..68bd99c01 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -175,8 +175,6 @@ Required: No --- ---- - ## Return Type Array<[user\_identity](./)> diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index ba49e3469..2b9f6c65c 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -405,8 +405,6 @@ ID of the user identity for which you want to retrieve all accessible devices. --- ---- - ## Return Type Array<[device](./)> diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index c8c2d2247..ed32673e6 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -193,8 +193,6 @@ ID of the user identity for which you want to retrieve all access control system --- ---- - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 029a3bfdf..fc84f52bc 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -202,8 +202,6 @@ ID of the user identity for which you want to retrieve all ACS users. --- ---- - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 372bdd303..663270462 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -147,8 +147,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 0b3266fbc..0d8590456 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -147,8 +147,6 @@ ID of the desired user identity. --- ---- - ## Return Type void diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 06e734511..742e986f3 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -62,8 +62,6 @@ Unique key for the user identity. --- ---- - ## Return Type void From 3c9bfdcf4b3ed22ae7599cb3bb89c1fef4a663bc Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 17:51:06 -0400 Subject: [PATCH 035/233] Add access codes to gen --- src/lib/reference.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/lib/reference.ts b/src/lib/reference.ts index b6da756fa..0ebf2e09a 100644 --- a/src/lib/reference.ts +++ b/src/lib/reference.ts @@ -56,7 +56,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('/access_codes') ) { continue } From 49a69123f322c3dd032c11a3b6b561910c9cf822 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 17:53:52 -0400 Subject: [PATCH 036/233] Add access codes to gen --- src/data/paths.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 4b9238aaa..94caa45c4 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -80,3 +80,8 @@ title: Enrollment Automations resources: - enrollment_automation + +/access_codes: + title: Access Codes + resources: + - access_code From d9f3c175435ee516339397ea055c95df6c418eba Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 21:54:49 +0000 Subject: [PATCH 037/233] ci: Generate docs --- docs/api/_report.md | 1 - docs/api/access_codes/README.md | 1690 +++++++++++++++++++++++++++++++ 2 files changed, 1690 insertions(+), 1 deletion(-) create mode 100644 docs/api/access_codes/README.md diff --git a/docs/api/_report.md b/docs/api/_report.md index 937adb7e7..840dcc6c7 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -4,7 +4,6 @@ ### Routes -- `/access_codes` - `/access_codes/simulate` - `/access_codes/unmanaged` - `/action_attempts` diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md new file mode 100644 index 000000000..34a356bf0 --- /dev/null +++ b/docs/api/access_codes/README.md @@ -0,0 +1,1690 @@ +# Access Codes + +The Access Codes route contains the following resources: + +## The `access_code` Resource + +## Properties + +### `access_code_id` + +Format: `UUID` + +Unique identifier for the access code. + +--- + +### `code` + +Format: `String` + +Code used for access. Typically, a numeric or alphanumeric string. + +--- + +### `common_code_key` + +Format: `String` + +Unique identifier for a group of access codes that share the same code. + +--- + +### `created_at` + +Format: `Datetime` + +Date and time at which the access code was created. + +--- + +### `device_id` + +Format: `UUID` + +Unique identifier for the device associated with the access code. + +--- + +### `ends_at` + +Format: `Datetime` + +Date and time after which the time-bound access code becomes inactive. + +--- + +### [`errors`](./#errors-1) + +Format: `List` + +Item format: `Object` + +Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. + +--- + +### `is_backup` + +Format: `Boolean` + +Indicates whether the access code is a backup code. + +--- + +### `is_backup_access_code_available` + +Format: `Boolean` + +Indicates whether a backup access code is available for use if the primary access code is lost or compromised. + +--- + +### `is_external_modification_allowed` + +Format: `Boolean` + +Indicates whether changes to the access code from external sources are permitted. + +--- + +### `is_managed` + +Format: `Boolean` + +Indicates whether Seam manages the access code. + +--- + +### `is_offline_access_code` + +Format: `Boolean` + +Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. + +--- + +### `is_one_time_use` + +Format: `Boolean` + +Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. + +--- + +### `is_scheduled_on_device` + +Format: `Boolean` + +Indicates whether the code is set on the device according to a preconfigured schedule. + +--- + +### `is_waiting_for_code_assignment` + +Format: `Boolean` + +Indicates whether the access code is waiting for a code assignment. + +--- + +### `name` + +Format: `String` + +Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + +--- + +### `pulled_backup_access_code_id` + +Format: `UUID` + +Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. + +--- + +### `starts_at` + +Format: `Datetime` + +Date and time at which the time-bound access code becomes active. + +--- + +### `status` + +Format: `Enum` + + + 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. + + +Possible enum values: +- `setting` +- `set` +- `unset` +- `removing` +- `unknown` + +--- + +### `type` + +Format: `Enum` + +Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. + +Possible enum values: +- `time_bound` +- `ongoing` + +--- + +### [`warnings`](./#warnings-1) + +Format: `List` + +Item format: `Object` + +Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. + +--- + +## Errors + +### `smartthings_failed_to_set_access_code` + +Failed to set code on Smart Things device. + +--- + +### `smartthings_failed_to_set_after_multiple_retries` + +Failed to set code after multiple retries. + +--- + +### `smartthings_no_free_slots_available` + +No free slots available on the device. + +--- + +### `failed_to_set_on_device` + +Failed to set code on device. + +--- + +### `failed_to_remove_from_device` + +Failed to remove code from device. + +--- + +### `duplicate_code_on_device` + +Duplicate access code detected on device. + +--- + +### `duplicate_code_attempt_prevented` + +An attempt to modify this access code was prevented. + +--- + +### `igloohome_bridge_too_many_pending_jobs` + +Igloohome bridge has too many pending jobs in the queue. + +--- + +### `igloohome_bridge_offline` + +Igloohome bridge is offline. + +--- + +### `igloohome_offline_access_code_no_variance_available` + +Lock as reached max amount of codes. + +--- + +### `kwikset_unable_to_confirm_code` + +Unable to confirm the access code is set on Kwikset device. + +--- + +### `kwikset_unable_to_confirm_deletion` + +Unable to confirm the deletion of the access code on Kwikset device. + +--- + +### `code_modified_external_to_seam` + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +### `august_lock_invalid_code_length` + +Invalid code length for August lock. + +--- + +### `august_device_programming_delay` + +Access code has not yet been fully moved to the device. + +--- + +### `august_device_slots_full` + +All access code slots on the device are full. + +--- + +### `august_lock_missing_keypad` + +August lock is missing a keypad. + +--- + +### `august_lock_temporarily_offline` + +August lock is temporarily offline. + +--- + +### `salto_ks_user_not_subscribed` + +Salto site user is not subscribed. + +--- + +### `hubitat_device_programming_delay` + +Access code has not yet been fully moved to the device. + +--- + +### `hubitat_no_free_positions_available` + +No free positions available on the device. + +--- + +### `wyze_duplicate_code_name` + +Duplicate access code name detected. + +--- + +### `wyze_potential_duplicate_code` + +Potential duplicate access code detected. + +--- + +### `dormakaba_oracode_no_valid_user_level` + +No valid user level for Oracode. + +--- + +### `account_disconnected` + +Account is disconnected + +--- + +### `salto_ks_subscription_limit_exceeded` + +Salto site user limit reached. + +--- + +### `device_offline` + +Device is offline + +--- + +### `device_removed` + +Device has been removed + +--- + +### `hub_disconnected` + +Hub is disconnected + +--- + +### `device_disconnected` + +Device is disconnected + +--- + +### `empty_backup_access_code_pool` + +The backup access code pool is empty. + +--- + +### `august_lock_not_authorized` + +User is not authorized to use the August Lock. + +--- + +### `august_lock_missing_bridge` + +Lock is not connected to the Seam Bridge. + +--- + +### `ttlock_lock_not_paired_to_gateway` + +Lock is not paired with a Gateway. + +--- + +### `missing_device_credentials` + +Missing device credentials. + +--- + +### `auxiliary_heat_running` + +The auxiliary heat is running. + +--- + +### `subscription_required` + +Subscription required to connect. + +--- + +### `invalid_credentials` + +Credentials provided were invalid. + +--- + +## Warnings + +### `smartthings_failed_to_set_access_code` + +Failed to set code on Smart Things device. + +--- + +### `schlage_detected_duplicate` + +Duplicate access code detected. + +--- + +### `schlage_creation_outage` + +Received an error when attempting to create this code. + +--- + +### `code_modified_external_to_seam` + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +### `delay_in_setting_on_device` + +Delay in setting code on device. + +--- + +### `delay_in_removing_from_device` + +Delay in removing code from device. + +--- + +### `third_party_integration_detected` + +Third party integration detected that may cause access codes to fail. + +--- + +### `august_device_programming_delay` + +Access code has not yet been fully moved to the device. + +--- + +### `august_lock_temporarily_offline` + +August lock is temporarily offline. + +--- + +### `igloo_algopin_must_be_used_within_24_hours` + +Algopins must be used within 24 hours. + +--- + +### `management_transferred` + +Management was transferred to another workspace. + +--- + +### `kwikset_unable_to_confirm_code` + +Unable to confirm the access code is set on Kwikset device. + +--- + +## Endpoints + + +--- + +## Events + +### `access_code.created` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.changed` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.scheduled_on_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +code Format: String + +Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.set_on_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +code Format: String + +Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.removed_from_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.delay_in_setting_on_device` + +There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.failed_to_set_on_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.deleted` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +code Format: String + +Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.delay_in_removing_from_device` + +There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.failed_to_remove_from_device` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.modified_external_to_seam` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.deleted_external_to_seam` + +An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.backup_access_code_pulled` + +A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +backup_access_code_id Format: String + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.unmanaged.converted_to_managed` + +An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.unmanaged.failed_to_convert_to_managed` + +An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.unmanaged.created` + +An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + +### `access_code.unmanaged.removed` + +An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device. + +
+ +access_code_id Format: UUID + +ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +
+ +
+ +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. + +
+ +
+ +device_id Format: UUID + +ID of the [device](../../core-concepts/devices/README.md). + +
+ +
+ +event_id Format: UUID + +ID of the event. + +
+ +
+ +event_type Format: String + +
+ +
+ +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). + +
+ +--- + From 4d1969175b8d1349ae4173931e510913cbf2d1c0 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 18:40:49 -0400 Subject: [PATCH 038/233] Alphabetize SUMMARY.md --- docs/SUMMARY.md | 82 ++++++++++++++++++++++++------------------------- 1 file changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 6b56272d6..e0b72de26 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -126,36 +126,6 @@ * [Overview](api-clients/overview.md) * [Installation](api-clients/installation.md) * [Authentication](api-clients/authentication.md) -* [Workspaces](api-clients/workspaces/README.md) - * [Get Workspace](api-clients/workspaces/get.md) - * [Reset Workspace](api-clients/workspaces/reset_sandbox.md) -* [Client Sessions](api-clients/client_sessions/README.md) - * [Create a Client Session](api-clients/client_sessions/create.md) - * [Get or Create a Client Session](api-clients/client_sessions/get_or_create.md) - * [List Client Sessions](api-clients/client_sessions/list.md) - * [Get a Client Session](api-clients/client_sessions/get.md) - * [Grant Access to a Client Session](api-clients/client_sessions/grant_access.md) - * [Delete a Client Session](api-clients/client_sessions/delete.md) -* [Connect Webviews](api-clients/connect_webviews/README.md) - * [Create a Connect Webview](api-clients/connect_webviews/create.md) - * [List Connect Webviews](api-clients/connect_webviews/list.md) - * [Get a Connect Webview](api-clients/connect_webviews/get.md) - * [Delete a Connect Webview](api-clients/connect_webviews/delete.md) -* [Connected Accounts](api-clients/connected_accounts/README.md) - * [Get a Connected Account](api-clients/connected_accounts/get.md) - * [List Connected Accounts](api-clients/connected_accounts/list.md) - * [Update a Connected Account](api-clients/connected_accounts/update.md) - * [Delete a Connected Account](api-clients/connected_accounts/delete.md) -* [Devices](api-clients/devices/README.md) - * [List Devices](api-clients/devices/list.md) - * [List Device Providers](api-clients/devices/list_device_providers.md) - * [Device Provider Metadata](reference/device-provider-metadata.md) - * [Get a Device](api-clients/devices/get.md) - * [Update a Device](api-clients/devices/update.md) - * [Unmanaged Devices](api-clients/devices/unmanaged/README.md) - * [Update an Unmanaged Device](api-clients/devices/unmanaged/update.md) - * [List Unmanaged Devices](api-clients/devices/unmanaged/list.md) - * [Get an Unmanaged Device](api-clients/devices/unmanaged/get.md) * [Access Codes](api-clients/access_codes/README.md) * [Create an Access Code](api-clients/access_codes/create.md) * [Create Multiple Linked Access Codes](api-clients/access_codes/create_multiple.md) @@ -169,12 +139,7 @@ * [List Unmanaged Access Codes](api-clients/access_codes/unmanaged/list.md) * [Convert an Unmanaged Access Code](api-clients/access_codes/unmanaged/convert_to_managed.md) * [Delete an Unmanaged Access Code](api-clients/access_codes/unmanaged/delete.md) -* [Locks](api-clients/locks/README.md) - * [Get Lock](api-clients/locks/get.md) - * [Lock a Lock](api-clients/locks/lock_door.md) - * [Unlock a Lock](api-clients/locks/unlock_door.md) - * [List Locks](api-clients/locks/list.md) -* [Access Control Systems](api/acs/README.md) +* [Access Control Systems (ACS)](api/acs/README.md) * [Systems](api/acs/systems/README.md) * [List ACS Systems](api/acs/systems/list.md) * [Get an ACS System](api/acs/systems/get.md) @@ -217,6 +182,43 @@ * [Simulate that the Next Credential Encoding Will Succeed](api/acs/encoders/simulate/next_credential_encode_will_succeed.md) * [Simulate that the Next Credential Scan Will Fail](api/acs/encoders/simulate/next_credential_scan_will_fail.md) * [Simulate that the Next Credential Scan Will Succeed](api/acs/encoders/simulate/next_credential_scan_will_succeed.md) +* [Action Attempts](api-clients/action_attempts/README.md) + * [Get Action Attempt](api-clients/action_attempts/get.md) +* [Client Sessions](api-clients/client_sessions/README.md) + * [Create a Client Session](api-clients/client_sessions/create.md) + * [Get or Create a Client Session](api-clients/client_sessions/get_or_create.md) + * [List Client Sessions](api-clients/client_sessions/list.md) + * [Get a Client Session](api-clients/client_sessions/get.md) + * [Grant Access to a Client Session](api-clients/client_sessions/grant_access.md) + * [Delete a Client Session](api-clients/client_sessions/delete.md) +* [Connect Webviews](api-clients/connect_webviews/README.md) + * [Create a Connect Webview](api-clients/connect_webviews/create.md) + * [List Connect Webviews](api-clients/connect_webviews/list.md) + * [Get a Connect Webview](api-clients/connect_webviews/get.md) + * [Delete a Connect Webview](api-clients/connect_webviews/delete.md) +* [Connected Accounts](api-clients/connected_accounts/README.md) + * [Get a Connected Account](api-clients/connected_accounts/get.md) + * [List Connected Accounts](api-clients/connected_accounts/list.md) + * [Update a Connected Account](api-clients/connected_accounts/update.md) + * [Delete a Connected Account](api-clients/connected_accounts/delete.md) +* [Devices](api-clients/devices/README.md) + * [List Devices](api-clients/devices/list.md) + * [List Device Providers](api-clients/devices/list_device_providers.md) + * [Device Provider Metadata](reference/device-provider-metadata.md) + * [Get a Device](api-clients/devices/get.md) + * [Update a Device](api-clients/devices/update.md) + * [Unmanaged Devices](api-clients/devices/unmanaged/README.md) + * [Update an Unmanaged Device](api-clients/devices/unmanaged/update.md) + * [List Unmanaged Devices](api-clients/devices/unmanaged/list.md) + * [Get an Unmanaged Device](api-clients/devices/unmanaged/get.md) +* [Events](api-clients/events/README.md) + * [List Events](api-clients/events/list.md) + * [Get an Event](api-clients/events/get.md) +* [Locks](api-clients/locks/README.md) + * [Get Lock](api-clients/locks/get.md) + * [Lock a Lock](api-clients/locks/lock_door.md) + * [Unlock a Lock](api-clients/locks/unlock_door.md) + * [List Locks](api-clients/locks/list.md) * [Noise Sensors](api-clients/noise_sensors/README.md) * [Noise Thresholds](api-clients/noise_sensors/noise_thresholds/README.md) * [Create Noise Thresholds](api-clients/noise_sensors/noise_thresholds/create.md) @@ -270,11 +272,9 @@ * [List Enrollment Automations](api/user_identities/enrollment_automations/list.md) * [Get an Enrollment Automation](api/user_identities/enrollment_automations/get.md) * [Delete an Enrollment Automation](api/user_identities/enrollment_automations/delete.md) -* [Action Attempts](api-clients/action_attempts/README.md) - * [Get Action Attempt](api-clients/action_attempts/get.md) -* [Events](api-clients/events/README.md) - * [List Events](api-clients/events/list.md) - * [Get an Event](api-clients/events/get.md) +* [Workspaces](api-clients/workspaces/README.md) + * [Get Workspace](api-clients/workspaces/get.md) + * [Reset Workspace](api-clients/workspaces/reset_sandbox.md) ## 🛠️ Developer Tools From 1d386346fbd84bdb978dc783a6f3b450fe3c5faf Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 18:43:04 -0400 Subject: [PATCH 039/233] Update paths.yaml --- src/data/paths.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 94caa45c4..59ffc89a8 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -1,6 +1,6 @@ --- /acs: - title: Access Control Systems + title: Access Control Systems (ACS) description: Systems for managing and monitoring access to physical spaces overview: | Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: From 4d0a5429a939efa14ea3e6edfa6f709253d1f0ca Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 22:44:13 +0000 Subject: [PATCH 040/233] ci: Generate docs --- docs/api/acs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index b6244626e..78c99bd4b 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# Access Control Systems +# Access Control Systems (ACS) Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: @@ -21,7 +21,7 @@ To grant access using the Seam access control system API, use the following basi ## Resources -The Access Control Systems namespace contains the following resources: +The Access Control Systems (ACS) namespace contains the following resources: ### [`acs_system`](./systems/README.md#acs_system) Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). From bd2a0adf40488c4590b263f92060eee92ef64767 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 19:21:21 -0400 Subject: [PATCH 041/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 8b3ef2d1d..114b48fb7 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -1,8 +1,12 @@ # {{title}} +{% tabs %} +{% tab title="Signature" %} ``` {{request.preferredMethod}} {{path}} ⇒ {{#if response.responseKey}}{{#if (eq response.responseType "resource_list")}}{ {{response.responseKey}}: [{{response.resourceType}}, …] }{{else}}{ {{response.responseKey}} }{{/if}}{{else}}void{{/if}} ``` +{% endtab %} +{% endtabs %} {{{description}}} From 5bf47d6fa170f83f1d4da944669cc8fce31e838c Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 23:22:19 +0000 Subject: [PATCH 042/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 4 ++++ docs/api/acs/access_groups/get.md | 4 ++++ docs/api/acs/access_groups/list.md | 4 ++++ docs/api/acs/access_groups/list_accessible_entrances.md | 4 ++++ docs/api/acs/access_groups/list_users.md | 4 ++++ docs/api/acs/access_groups/remove_user.md | 4 ++++ docs/api/acs/credentials/assign.md | 4 ++++ docs/api/acs/credentials/create.md | 4 ++++ docs/api/acs/credentials/delete.md | 4 ++++ docs/api/acs/credentials/get.md | 4 ++++ docs/api/acs/credentials/list.md | 4 ++++ docs/api/acs/credentials/list_accessible_entrances.md | 4 ++++ docs/api/acs/credentials/unassign.md | 4 ++++ docs/api/acs/credentials/update.md | 4 ++++ docs/api/acs/encoders/encode_credential.md | 4 ++++ docs/api/acs/encoders/list.md | 4 ++++ docs/api/acs/encoders/scan_credential.md | 4 ++++ .../acs/encoders/simulate/next_credential_encode_will_fail.md | 4 ++++ .../encoders/simulate/next_credential_encode_will_succeed.md | 4 ++++ .../acs/encoders/simulate/next_credential_scan_will_fail.md | 4 ++++ .../encoders/simulate/next_credential_scan_will_succeed.md | 4 ++++ docs/api/acs/entrances/get.md | 4 ++++ docs/api/acs/entrances/grant_access.md | 4 ++++ docs/api/acs/entrances/list.md | 4 ++++ docs/api/acs/entrances/list_credentials_with_access.md | 4 ++++ docs/api/acs/systems/get.md | 4 ++++ docs/api/acs/systems/list.md | 4 ++++ .../systems/list_compatible_credential_manager_acs_systems.md | 4 ++++ docs/api/acs/users/add_to_access_group.md | 4 ++++ docs/api/acs/users/create.md | 4 ++++ docs/api/acs/users/delete.md | 4 ++++ docs/api/acs/users/get.md | 4 ++++ docs/api/acs/users/list.md | 4 ++++ docs/api/acs/users/list_accessible_entrances.md | 4 ++++ docs/api/acs/users/remove_from_access_group.md | 4 ++++ docs/api/acs/users/revoke_access_to_all_entrances.md | 4 ++++ docs/api/acs/users/suspend.md | 4 ++++ docs/api/acs/users/unsuspend.md | 4 ++++ docs/api/acs/users/update.md | 4 ++++ docs/api/phones/deactivate.md | 4 ++++ docs/api/phones/get.md | 4 ++++ docs/api/phones/list.md | 4 ++++ docs/api/phones/simulate/create_sandbox_phone.md | 4 ++++ docs/api/thermostats/activate_climate_preset.md | 4 ++++ docs/api/thermostats/cool.md | 4 ++++ docs/api/thermostats/create_climate_preset.md | 4 ++++ docs/api/thermostats/delete_climate_preset.md | 4 ++++ docs/api/thermostats/heat.md | 4 ++++ docs/api/thermostats/heat_cool.md | 4 ++++ docs/api/thermostats/list.md | 4 ++++ docs/api/thermostats/off.md | 4 ++++ docs/api/thermostats/schedules/create.md | 4 ++++ docs/api/thermostats/schedules/delete.md | 4 ++++ docs/api/thermostats/schedules/get.md | 4 ++++ docs/api/thermostats/schedules/list.md | 4 ++++ docs/api/thermostats/schedules/update.md | 4 ++++ docs/api/thermostats/set_fallback_climate_preset.md | 4 ++++ docs/api/thermostats/set_fan_mode.md | 4 ++++ docs/api/thermostats/set_hvac_mode.md | 4 ++++ docs/api/thermostats/set_temperature_threshold.md | 4 ++++ docs/api/thermostats/simulate/hvac_mode_adjusted.md | 4 ++++ docs/api/thermostats/simulate/temperature_reached.md | 4 ++++ docs/api/thermostats/update_climate_preset.md | 4 ++++ docs/api/user_identities/add_acs_user.md | 4 ++++ docs/api/user_identities/create.md | 4 ++++ docs/api/user_identities/delete.md | 4 ++++ docs/api/user_identities/enrollment_automations/delete.md | 4 ++++ docs/api/user_identities/enrollment_automations/get.md | 4 ++++ docs/api/user_identities/enrollment_automations/launch.md | 4 ++++ docs/api/user_identities/enrollment_automations/list.md | 4 ++++ docs/api/user_identities/get.md | 4 ++++ docs/api/user_identities/grant_access_to_device.md | 4 ++++ docs/api/user_identities/list.md | 4 ++++ docs/api/user_identities/list_accessible_devices.md | 4 ++++ docs/api/user_identities/list_acs_systems.md | 4 ++++ docs/api/user_identities/list_acs_users.md | 4 ++++ docs/api/user_identities/remove_acs_user.md | 4 ++++ docs/api/user_identities/revoke_access_to_device.md | 4 ++++ docs/api/user_identities/update.md | 4 ++++ 79 files changed, 316 insertions(+) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index d280444f8..2805c6a65 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -1,8 +1,12 @@ # Add an ACS User to an Access Group +{% tabs %} +{% tab title="Signature" %} ``` PUT /acs/access_groups/add_user ⇒ void ``` +{% endtab %} +{% endtabs %} Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 2cc9f6028..73fe16bf4 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -1,8 +1,12 @@ # Get an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/get ⇒ { acs_access_group } ``` +{% endtab %} +{% endtabs %} Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index e4b00a263..01e436a12 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -1,8 +1,12 @@ # List Access Groups +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index e7614ea60..bbd65b0d0 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -1,8 +1,12 @@ # List Entrances Accessible to an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index b75ca142d..f151a3acb 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -1,8 +1,12 @@ # List ACS Users in an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 269906344..d417a68c9 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -1,8 +1,12 @@ # Remove an ACS User from an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/remove_user ⇒ void ``` +{% endtab %} +{% endtabs %} Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 80ce54802..fc98593dc 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -1,8 +1,12 @@ # Assign a Credential to an ACS User +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/credentials/assign ⇒ void ``` +{% endtab %} +{% endtabs %} Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index f7ee73c9e..1c39f1422 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -1,8 +1,12 @@ # Create a Credential for an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/create ⇒ { acs_credential } ``` +{% endtab %} +{% endtabs %} Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 893f332d3..9d00c4d61 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -1,8 +1,12 @@ # Delete a Credential +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index a03363f2b..1e44ed30c 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -1,8 +1,12 @@ # Get a Credential +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/get ⇒ { acs_credential } ``` +{% endtab %} +{% endtabs %} Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 5e4d7fd59..1a4e19719 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -1,8 +1,12 @@ # List Credentials +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 78f717d88..45809e06e 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -1,8 +1,12 @@ # List Accessible Entrances +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 2836e6c0e..283af8293 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -1,8 +1,12 @@ # Unassign a Credential from an ACS User +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/credentials/unassign ⇒ void ``` +{% endtab %} +{% endtabs %} Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index a0317d2f4..02e3e0ad3 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -1,8 +1,12 @@ # Update a Credential +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/credentials/update ⇒ void ``` +{% endtab %} +{% endtabs %} Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index ed011b840..613b48bba 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -1,8 +1,12 @@ # Encode a Credential +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/encode_credential ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 7d79694f7..4802c7db8 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -1,8 +1,12 @@ # List Encoders +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index a8f523438..3406a5566 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -1,8 +1,12 @@ # Scan a Credential +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/scan_credential ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index f754ff663..3ad65d74a 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -1,8 +1,12 @@ # Simulate that the Next Credential Encoding Will Fail +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index ff43764bf..9843a3308 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -1,8 +1,12 @@ # Simulate that the Next Credential Encoding Will Succeed +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 28489b42e..45a7dd81c 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -1,8 +1,12 @@ # Simulate that the Next Credential Scan Will Fail +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 3e2eb3bc3..da97c97b6 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -1,8 +1,12 @@ # Simulate that the Next Credential Scan Will Succeed +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 9c06b62fe..4c96237ac 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -1,8 +1,12 @@ # Get an Entrance +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/get ⇒ { acs_entrance } ``` +{% endtab %} +{% endtabs %} Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 86f7acef7..33b243769 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -1,8 +1,12 @@ # Grant an ACS User Access to an Entrance +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/grant_access ⇒ void ``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 0c7d45151..3503d3f87 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -1,8 +1,12 @@ # List Entrances +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index faab439d2..7508d01fb 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -1,8 +1,12 @@ # List Credentials with Access to an Entrance +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_credential, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index d5bb5f40d..4f1dfa2e1 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -1,8 +1,12 @@ # Get an ACS System +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/systems/get ⇒ { acs_system } ``` +{% endtab %} +{% endtabs %} Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 801c08d5f..97a2230ce 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -1,8 +1,12 @@ # List ACS Systems +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 054e53f4c..460818a89 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -1,8 +1,12 @@ # List Compatible Credential Manager ACS Systems +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 0740c2a68..3751d076a 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -1,8 +1,12 @@ # Add an ACS User to an Access Group +{% tabs %} +{% tab title="Signature" %} ``` PUT /acs/users/add_to_access_group ⇒ void ``` +{% endtab %} +{% endtabs %} Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 5adddb825..99595aedd 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -1,8 +1,12 @@ # Create an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/create ⇒ { acs_user } ``` +{% endtab %} +{% endtabs %} Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index a1fbaf153..01963fadb 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -1,8 +1,12 @@ # Delete an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 6fb9a9103..79acfe5ce 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -1,8 +1,12 @@ # Get an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/get ⇒ { acs_user } ``` +{% endtab %} +{% endtabs %} Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index c83996f19..d65058142 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -1,8 +1,12 @@ # List ACS Users +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index e67a8abea..246d70a5f 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -1,8 +1,12 @@ # List ACS User-Accessible Entrances +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endtab %} +{% endtabs %} Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 007c9bec9..119aba347 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -1,8 +1,12 @@ # Remove an ACS User from an Access Group +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/remove_from_access_group ⇒ void ``` +{% endtab %} +{% endtabs %} Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 583a2532b..fff46237a 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -1,8 +1,12 @@ # Revoke ACS User Access to All Entrances +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/revoke_access_to_all_entrances ⇒ void ``` +{% endtab %} +{% endtabs %} Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index c84182810..1e68cbf71 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -1,8 +1,12 @@ # Suspend an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/suspend ⇒ void ``` +{% endtab %} +{% endtabs %} [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 00064209a..4b18eb838 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -1,8 +1,12 @@ # Unsuspend an ACS User +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/unsuspend ⇒ void ``` +{% endtab %} +{% endtabs %} [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 4e2866bcd..0cbbdae60 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -1,8 +1,12 @@ # Update an ACS User +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/users/update ⇒ void ``` +{% endtab %} +{% endtabs %} Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index f160a5fdb..a1312416e 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -1,8 +1,12 @@ # Deactivate a Phone +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/deactivate ⇒ void ``` +{% endtab %} +{% endtabs %} Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 8d1166c18..d609d8c6c 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -1,8 +1,12 @@ # Get Phone +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/get ⇒ { phone } ``` +{% endtab %} +{% endtabs %} Returns a single phone entry matching the provided `device_id`. diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index e85c3aba1..f7bcc6972 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -1,8 +1,12 @@ # List Phones +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/list ⇒ { phones: [phone, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index c6ef24d60..1686ede5d 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -1,8 +1,12 @@ # Create a Sandbox Phone +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/simulate/create_sandbox_phone ⇒ { phone } ``` +{% endtab %} +{% endtabs %} Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 4a76e9bf7..a387eca74 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -1,8 +1,12 @@ # Activate a Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/activate_climate_preset ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 834cec24c..b8148a391 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -1,8 +1,12 @@ # Set to Cool Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/cool ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 0d93d5898..4f20ffbae 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -1,8 +1,12 @@ # Create a Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/create_climate_preset ⇒ void ``` +{% endtab %} +{% endtabs %} Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 13dd99c46..dd5f15a73 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -1,8 +1,12 @@ # Delete a Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/delete_climate_preset ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 0ee93ebd8..3995967e2 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -1,8 +1,12 @@ # Set to Heat Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/heat ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index acf0ee0fa..3f8f59ded 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -1,8 +1,12 @@ # Set to Heat-Cool (Auto) Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/heat_cool ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index ed07f77cc..e96d7a983 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -1,8 +1,12 @@ # List Thermostats +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/list ⇒ { devices: [device, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 07e778ab1..83049a22c 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -1,8 +1,12 @@ # Set to Off Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/off ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 2749a96e8..2ae7c7eba 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -1,8 +1,12 @@ # Create a Thermostat Schedule +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/create ⇒ { thermostat_schedule } ``` +{% endtab %} +{% endtabs %} Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 6b64d3d23..24913deb7 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -1,8 +1,12 @@ # Delete a Thermostat Schedule +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 102f9e1ef..d447f1fb8 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -1,8 +1,12 @@ # Get a Thermostat Schedule +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/get ⇒ { thermostat_schedule } ``` +{% endtab %} +{% endtabs %} Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index dddd3fafa..23648c329 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -1,8 +1,12 @@ # List Thermostat Schedules +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedule, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 2b7c2af5a..2f170b593 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -1,8 +1,12 @@ # Update a Thermostat Schedule +{% tabs %} +{% tab title="Signature" %} ``` PATCH /thermostats/schedules/update ⇒ void ``` +{% endtab %} +{% endtabs %} Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 362676b36..e5c879c78 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -1,8 +1,12 @@ # Set the Fallback Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/set_fallback_climate_preset ⇒ void ``` +{% endtab %} +{% endtabs %} Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 5a88879c2..ba9666104 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -1,8 +1,12 @@ # Set the Fan Mode Setting +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/set_fan_mode ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 82dbc09dd..4433ae302 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -1,8 +1,12 @@ # Set the HVAC Mode +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/set_hvac_mode ⇒ { action_attempt } ``` +{% endtab %} +{% endtabs %} Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index b7b4d24ac..6ef3cc763 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -1,8 +1,12 @@ # Set a Temperature Threshold +{% tabs %} +{% tab title="Signature" %} ``` PATCH /thermostats/set_temperature_threshold ⇒ void ``` +{% endtab %} +{% endtabs %} Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 11b27a62d..85c397611 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -1,8 +1,12 @@ # HVAC Mode Adjusted +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 66a10e442..27a3e90f1 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -1,8 +1,12 @@ # Temperature Reached +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/simulate/temperature_reached ⇒ void ``` +{% endtab %} +{% endtabs %} Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 3e56936f9..0e37698a0 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -1,8 +1,12 @@ # Update a Climate Preset +{% tabs %} +{% tab title="Signature" %} ``` PATCH /thermostats/update_climate_preset ⇒ void ``` +{% endtab %} +{% endtabs %} Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 52ed3a60d..4bfc51015 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -1,8 +1,12 @@ # Add an ACS User to a User Identity +{% tabs %} +{% tab title="Signature" %} ``` PUT /user_identities/add_acs_user ⇒ void ``` +{% endtab %} +{% endtabs %} Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 07eda4a0a..27be89a33 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -1,8 +1,12 @@ # Create a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/create ⇒ { user_identity } ``` +{% endtab %} +{% endtabs %} Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 2f56d236e..cffd2486b 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -1,8 +1,12 @@ # Delete a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index e914ebc3e..bf4463b81 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -1,8 +1,12 @@ # Delete an Enrollment Automation +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/delete ⇒ void ``` +{% endtab %} +{% endtabs %} Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index ee922cf72..3b93f089e 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -1,8 +1,12 @@ # Get an Enrollment Automation +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ``` +{% endtab %} +{% endtabs %} Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 8ca8fb9d4..14042b574 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -1,8 +1,12 @@ # Launch an Enrollment Automation +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation } ``` +{% endtab %} +{% endtabs %} Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 7e8901f8f..0fbd5c84b 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -1,8 +1,12 @@ # List Enrollment Automations +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: [enrollment_automation, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index e5af4532e..c84ae5e22 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -1,8 +1,12 @@ # Get a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/get ⇒ { user_identity } ``` +{% endtab %} +{% endtabs %} Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index c7fea2e76..3f158dcd7 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -1,8 +1,12 @@ # Grant a User Identity Access to a Device +{% tabs %} +{% tab title="Signature" %} ``` PUT /user_identities/grant_access_to_device ⇒ void ``` +{% endtab %} +{% endtabs %} Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 68bd99c01..d7b06f578 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -1,8 +1,12 @@ # List User Identities +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 2b9f6c65c..37a235e87 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -1,8 +1,12 @@ # List Accessible Devices for a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index ed32673e6..8e93e5109 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -1,8 +1,12 @@ # List ACS Systems Associated with a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index fc84f52bc..49b3bccec 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -1,8 +1,12 @@ # List ACS Users Associated with a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ``` +{% endtab %} +{% endtabs %} Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 663270462..fb35b5b9b 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -1,8 +1,12 @@ # Remove an ACS User from a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/remove_acs_user ⇒ void ``` +{% endtab %} +{% endtabs %} Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 0d8590456..731f6f2a1 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -1,8 +1,12 @@ # Revoke Access to a Device from a User Identity +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/revoke_access_to_device ⇒ void ``` +{% endtab %} +{% endtabs %} Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 742e986f3..2d9bc7c8c 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -1,8 +1,12 @@ # Update a User Identity +{% tabs %} +{% tab title="Signature" %} ``` PATCH /user_identities/update ⇒ void ``` +{% endtab %} +{% endtabs %} From 66206196d51ef7fdd92201c748adfbec1d9295ee Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 19:32:05 -0400 Subject: [PATCH 043/233] Update SUMMARY.md --- docs/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index e0b72de26..2a1e054ba 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -139,7 +139,7 @@ * [List Unmanaged Access Codes](api-clients/access_codes/unmanaged/list.md) * [Convert an Unmanaged Access Code](api-clients/access_codes/unmanaged/convert_to_managed.md) * [Delete an Unmanaged Access Code](api-clients/access_codes/unmanaged/delete.md) -* [Access Control Systems (ACS)](api/acs/README.md) +* [Access Control Systems](api/acs/README.md) * [Systems](api/acs/systems/README.md) * [List ACS Systems](api/acs/systems/list.md) * [Get an ACS System](api/acs/systems/get.md) From 196d81d676e34b81a618b24412adf6215297568d Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Thu, 27 Mar 2025 19:36:51 -0400 Subject: [PATCH 044/233] Update paths.yaml --- src/data/paths.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 59ffc89a8..94caa45c4 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -1,6 +1,6 @@ --- /acs: - title: Access Control Systems (ACS) + title: Access Control Systems description: Systems for managing and monitoring access to physical spaces overview: | Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: From 49dec45fff451563693519c4cde861345c7c366e Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Thu, 27 Mar 2025 23:37:50 +0000 Subject: [PATCH 045/233] ci: Generate docs --- docs/api/acs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index 78c99bd4b..b6244626e 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# Access Control Systems (ACS) +# Access Control Systems Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: @@ -21,7 +21,7 @@ To grant access using the Seam access control system API, use the following basi ## Resources -The Access Control Systems (ACS) namespace contains the following resources: +The Access Control Systems namespace contains the following resources: ### [`acs_system`](./systems/README.md#acs_system) Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). From e7a5612f50046017343bab65dd744d94cc5fb653 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 13:16:06 +0000 Subject: [PATCH 046/233] ci: Generate docs --- docs/api/access_codes/README.md | 280 -------------------------------- 1 file changed, 280 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 34a356bf0..7025eafbb 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -511,63 +511,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.changed` @@ -579,63 +563,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.scheduled_on_device` @@ -647,71 +615,53 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
code Format: String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
-
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.set_on_device` @@ -723,71 +673,53 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
code Format: String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
-
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.removed_from_device` @@ -799,63 +731,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.delay_in_setting_on_device` @@ -867,63 +783,47 @@ There was an unusually long delay in setting an [access code](https://docs.seam. access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.failed_to_set_on_device` @@ -935,63 +835,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.deleted` @@ -1003,71 +887,53 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
code Format: String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
-
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.delay_in_removing_from_device` @@ -1079,63 +945,47 @@ There was an unusually long delay in removing an [access code](https://docs.seam access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.failed_to_remove_from_device` @@ -1147,63 +997,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.modified_external_to_seam` @@ -1215,63 +1049,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.deleted_external_to_seam` @@ -1283,63 +1101,47 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.backup_access_code_pulled` @@ -1351,69 +1153,51 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
backup_access_code_id Format: String -
-
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.unmanaged.converted_to_managed` @@ -1425,63 +1209,47 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.unmanaged.failed_to_convert_to_managed` @@ -1493,63 +1261,47 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.unmanaged.created` @@ -1561,63 +1313,47 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- ### `access_code.unmanaged.removed` @@ -1629,62 +1365,46 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l access_code_id Format: UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). - -
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. -
-
device_id Format: UUID ID of the [device](../../core-concepts/devices/README.md). -
-
event_id Format: UUID ID of the event. -
-
event_type Format: String -
-
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). -
- --- From d8a1e325dbddb00595ff82171a0e5bdb1db4056e Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:05:51 -0400 Subject: [PATCH 047/233] Update paths.yaml --- src/data/paths.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 94caa45c4..59ffc89a8 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -1,6 +1,6 @@ --- /acs: - title: Access Control Systems + title: Access Control Systems (ACS) description: Systems for managing and monitoring access to physical spaces overview: | Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: From 76214553b16dffbc0eaab0179a55919bfabb1cd4 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:06:29 -0400 Subject: [PATCH 048/233] Update SUMMARY.md --- docs/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 2a1e054ba..e0b72de26 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -139,7 +139,7 @@ * [List Unmanaged Access Codes](api-clients/access_codes/unmanaged/list.md) * [Convert an Unmanaged Access Code](api-clients/access_codes/unmanaged/convert_to_managed.md) * [Delete an Unmanaged Access Code](api-clients/access_codes/unmanaged/delete.md) -* [Access Control Systems](api/acs/README.md) +* [Access Control Systems (ACS)](api/acs/README.md) * [Systems](api/acs/systems/README.md) * [List ACS Systems](api/acs/systems/list.md) * [Get an ACS System](api/acs/systems/get.md) From ce6d871ce971c854f552c8a7ec67f544e0989d9f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 18:09:43 +0000 Subject: [PATCH 049/233] ci: Generate docs --- docs/api/acs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index b6244626e..78c99bd4b 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -2,7 +2,7 @@ description: Systems for managing and monitoring access to physical spaces --- -# Access Control Systems +# Access Control Systems (ACS) Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements: @@ -21,7 +21,7 @@ To grant access using the Seam access control system API, use the following basi ## Resources -The Access Control Systems namespace contains the following resources: +The Access Control Systems (ACS) namespace contains the following resources: ### [`acs_system`](./systems/README.md#acs_system) Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). From 1e63ce00410210c370fd06ce548a4c14dbd67fa7 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:40:26 -0400 Subject: [PATCH 050/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 30f63b761..3454a5786 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -15,23 +15,12 @@ {{/if}} {{#each properties}} -{{#if ../headingOffset}} -#### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} -{{else}} -### {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} -{{/if}} +{{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} Format: `{{format}}`{{#if listItemFormat}} Item format: `{{listItemFormat}}`{{/if}} {{#if isDeprecated}} - {{> deprecated-warning}} {{/if}} -Format: `{{format}}` -{{#if listItemFormat}} - -Item format: `{{listItemFormat}}` -{{/if}} {{#if description}} - {{description}} {{/if}} {{#if enumValues}} From e0f2813533dfac7cd5ebd77fc9f6f0d91e2b824c Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 18:41:32 +0000 Subject: [PATCH 051/233] ci: Generate docs --- docs/api/access_codes/README.md | 88 ++++----------- docs/api/acs/access_groups/README.md | 48 ++------ docs/api/acs/credentials/README.md | 106 +++++------------- docs/api/acs/encoders/README.md | 26 +---- docs/api/acs/encoders/encode_credential.md | 11 +- docs/api/acs/encoders/scan_credential.md | 10 +- docs/api/acs/entrances/README.md | 46 ++------ docs/api/acs/systems/README.md | 93 ++++----------- docs/api/acs/users/README.md | 86 ++++---------- docs/api/phones/README.md | 44 ++------ .../thermostats/activate_climate_preset.md | 10 +- docs/api/thermostats/cool.md | 10 +- docs/api/thermostats/heat.md | 10 +- docs/api/thermostats/heat_cool.md | 10 +- docs/api/thermostats/off.md | 10 +- docs/api/thermostats/schedules/README.md | 38 ++----- docs/api/thermostats/set_fan_mode.md | 10 +- docs/api/thermostats/set_hvac_mode.md | 10 +- docs/api/user_identities/README.md | 30 ++--- .../enrollment_automations/README.md | 20 +--- 20 files changed, 178 insertions(+), 538 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 7025eafbb..76d5a7a26 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -6,155 +6,115 @@ The Access Codes route contains the following resources: ## Properties -### `access_code_id` - -Format: `UUID` +`access_code_id` Format: `UUID` Unique identifier for the access code. --- -### `code` - -Format: `String` +`code` Format: `String` Code used for access. Typically, a numeric or alphanumeric string. --- -### `common_code_key` - -Format: `String` +`common_code_key` Format: `String` Unique identifier for a group of access codes that share the same code. --- -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the access code was created. --- -### `device_id` - -Format: `UUID` +`device_id` Format: `UUID` Unique identifier for the device associated with the access code. --- -### `ends_at` - -Format: `Datetime` +`ends_at` Format: `Datetime` Date and time after which the time-bound access code becomes inactive. --- -### [`errors`](./#errors-1) - -Format: `List` - -Item format: `Object` +[`errors`](./#errors-1) Format: `List` Item format: `Object` Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. --- -### `is_backup` - -Format: `Boolean` +`is_backup` Format: `Boolean` Indicates whether the access code is a backup code. --- -### `is_backup_access_code_available` - -Format: `Boolean` +`is_backup_access_code_available` Format: `Boolean` Indicates whether a backup access code is available for use if the primary access code is lost or compromised. --- -### `is_external_modification_allowed` - -Format: `Boolean` +`is_external_modification_allowed` Format: `Boolean` Indicates whether changes to the access code from external sources are permitted. --- -### `is_managed` - -Format: `Boolean` +`is_managed` Format: `Boolean` Indicates whether Seam manages the access code. --- -### `is_offline_access_code` - -Format: `Boolean` +`is_offline_access_code` Format: `Boolean` Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. --- -### `is_one_time_use` - -Format: `Boolean` +`is_one_time_use` Format: `Boolean` Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. --- -### `is_scheduled_on_device` - -Format: `Boolean` +`is_scheduled_on_device` Format: `Boolean` Indicates whether the code is set on the device according to a preconfigured schedule. --- -### `is_waiting_for_code_assignment` - -Format: `Boolean` +`is_waiting_for_code_assignment` Format: `Boolean` Indicates whether the access code is waiting for a code assignment. --- -### `name` - -Format: `String` +`name` Format: `String` Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. --- -### `pulled_backup_access_code_id` - -Format: `UUID` +`pulled_backup_access_code_id` Format: `UUID` Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. --- -### `starts_at` - -Format: `Datetime` +`starts_at` Format: `Datetime` Date and time at which the time-bound access code becomes active. --- -### `status` - -Format: `Enum` +`status` Format: `Enum` 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. @@ -169,9 +129,7 @@ Possible enum values: --- -### `type` - -Format: `Enum` +`type` Format: `Enum` Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. @@ -181,11 +139,7 @@ Possible enum values: --- -### [`warnings`](./#warnings-1) - -Format: `List` - -Item format: `Object` +[`warnings`](./#warnings-1) Format: `List` Item format: `Object` Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 13a4b9413..1ef12037b 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -12,13 +12,11 @@ To learn whether your access control system supports access groups, see the corr ## Properties -### `access_group_type` - +`access_group_type` Format: `Enum` {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} -Format: `Enum` Possible enum values: - `pti_unit` @@ -30,49 +28,38 @@ Possible enum values: --- -### `access_group_type_display_name` - +`access_group_type_display_name` Format: `String` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} -Format: `String` --- -### `acs_access_group_id` - -Format: `UUID` +`acs_access_group_id` Format: `UUID` ID of the access group. --- -### `acs_system_id` - -Format: `UUID` +`acs_system_id` Format: `UUID` ID of the access control system that contains the access group. --- -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the access group was created. --- -### `display_name` +`display_name` Format: `String` -Format: `String` --- -### `external_type` - -Format: `Enum` +`external_type` Format: `Enum` Brand-specific terminology for the access group type. @@ -86,33 +73,24 @@ Possible enum values: --- -### `external_type_display_name` - -Format: `String` +`external_type_display_name` Format: `String` Display name that corresponds to the brand-specific terminology for the access group type. --- -### `is_managed` +`is_managed` Format: `Boolean` -Format: `Boolean` --- -### `name` - -Format: `String` +`name` Format: `String` Name of the access group. --- -### `warnings` - -Format: `List` - -Item format: `Object` +`warnings` Format: `List` Item format: `Object` Warnings associated with the `acs_access_group`. @@ -136,9 +114,7 @@ Unique identifier of the type of warning. Enables quick recognition and categori --- -### `workspace_id` - -Format: `UUID` +`workspace_id` Format: `UUID` ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index b1954885c..8deaac948 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -12,9 +12,7 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties -### `access_method` - -Format: `Enum` +`access_method` Format: `Enum` Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. @@ -25,39 +23,30 @@ Possible enum values: --- -### `acs_credential_id` - -Format: `UUID` +`acs_credential_id` Format: `UUID` ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -### `acs_credential_pool_id` +`acs_credential_pool_id` Format: `UUID` -Format: `UUID` --- -### `acs_system_id` - -Format: `UUID` +`acs_system_id` Format: `UUID` ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -### `acs_user_id` - -Format: `UUID` +`acs_user_id` Format: `UUID` ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. --- -### `assa_abloy_vostio_metadata` - -Format: `Object` +`assa_abloy_vostio_metadata` Format: `Object` Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -83,51 +72,37 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- --- -### `card_number` - -Format: `String` +`card_number` Format: `String` Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -### `code` - -Format: `String` +`code` Format: `String` Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. --- -### `display_name` - -Format: `String` +`display_name` Format: `String` Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -### `ends_at` - -Format: `String` +`ends_at` Format: `String` Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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` - -Format: `List` - -Item format: `Object` +`errors` Format: `List` Item format: `Object` Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -141,9 +116,7 @@ Errors associated with the [credential](../../../capability-guides/access-system --- -### `external_type` - -Format: `Enum` +`external_type` Format: `Enum` Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. @@ -158,87 +131,66 @@ Possible enum values: --- -### `external_type_display_name` - -Format: `String` +`external_type_display_name` Format: `String` Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -### `is_issued` - -Format: `Boolean` +`is_issued` Format: `Boolean` Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. --- -### `is_latest_desired_state_synced_with_provider` - -Format: `Boolean` +`is_latest_desired_state_synced_with_provider` Format: `Boolean` Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. --- -### `is_managed` +`is_managed` Format: `Boolean` -Format: `Boolean` --- -### `is_multi_phone_sync_credential` - -Format: `Boolean` +`is_multi_phone_sync_credential` Format: `Boolean` Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- -### `is_one_time_use` - -Format: `Boolean` +`is_one_time_use` Format: `Boolean` Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. --- -### `issued_at` - -Format: `Datetime` +`issued_at` Format: `Datetime` Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. --- -### `latest_desired_state_synced_with_provider_at` - -Format: `Datetime` +`latest_desired_state_synced_with_provider_at` Format: `Datetime` Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. --- -### `parent_acs_credential_id` - -Format: `UUID` +`parent_acs_credential_id` Format: `UUID` ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -### `starts_at` - -Format: `String` +`starts_at` Format: `String` Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -### `visionline_metadata` - -Format: `Object` +`visionline_metadata` Format: `Object` Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -280,19 +232,13 @@ Possible enum values: --- -### [`warnings`](./#warnings-1) - -Format: `List` - -Item format: `Object` +[`warnings`](./#warnings-1) Format: `List` Item format: `Object` Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -### `workspace_id` - -Format: `UUID` +`workspace_id` Format: `UUID` ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 6fa06bd01..fe8eb958a 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -21,43 +21,31 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties -### `acs_encoder_id` - -Format: `UUID` +`acs_encoder_id` Format: `UUID` ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. --- -### `acs_system_id` - -Format: `UUID` +`acs_system_id` Format: `UUID` ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. --- -### `display_name` - -Format: `String` +`display_name` Format: `String` Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -### `errors` - -Format: `List` - -Item format: `Object` +`errors` Format: `List` Item format: `Object` Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). @@ -81,9 +69,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -### `workspace_id` - -Format: `UUID` +`workspace_id` Format: `UUID` ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 613b48bba..1be4bf40d 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -49,25 +49,20 @@ Action attempt to track encoding credential data from the physical encoder onto ### Properties -#### `action_attempt_id` - -Format: `UUID` +`action_attempt_id` Format: `UUID` ID of the action attempt. --- -#### `action_type` - -Format: `String` +`action_type` Format: `String` Type of action that the action attempt tracks. --- -#### `status` +`status` Format: `Enum` -Format: `Enum` Possible enum values: - `success` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 3406a5566..120e84543 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -40,23 +40,19 @@ Reading credential data from physical encoder. ### Properties -#### `action_attempt_id` - -Format: `UUID` +`action_attempt_id` Format: `UUID` ID of the action attempt. --- -#### `action_type` +`action_type` Format: `String` -Format: `String` --- -#### `status` +`status` Format: `Enum` -Format: `Enum` Possible enum values: - `success` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index fa477d1e4..2116671f0 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -10,25 +10,19 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties -### `acs_entrance_id` - -Format: `UUID` +`acs_entrance_id` Format: `UUID` ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -### `acs_system_id` - -Format: `UUID` +`acs_system_id` Format: `UUID` ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -### `assa_abloy_vostio_metadata` - -Format: `Object` +`assa_abloy_vostio_metadata` Format: `Object` ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -60,25 +54,19 @@ Possible enum values: --- -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. --- -### `display_name` - -Format: `String` +`display_name` Format: `String` Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -### `dormakaba_community_metadata` - -Format: `Object` +`dormakaba_community_metadata` Format: `Object` dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -88,11 +76,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca --- -### `errors` - -Format: `List` - -Item format: `Object` +`errors` Format: `List` Item format: `Object` Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -110,9 +94,7 @@ Detailed description of the error. Provides insights into the issue and potentia --- -### `latch_metadata` - -Format: `Object` +`latch_metadata` Format: `Object` Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -134,9 +116,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide --- -### `salto_ks_metadata` - -Format: `Object` +`salto_ks_metadata` Format: `Object` Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -174,9 +154,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu --- -### `salto_space_metadata` - -Format: `Object` +`salto_space_metadata` Format: `Object` Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -194,9 +172,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability --- -### `visionline_metadata` - -Format: `Object` +`visionline_metadata` Format: `Object` Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index f7349e945..f2b05947a 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -12,97 +12,70 @@ For details about the resources associated with an access control system, see th ## Properties -### `acs_system_id` - -Format: `UUID` +`acs_system_id` Format: `UUID` ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -### `can_add_acs_users_to_acs_access_groups` - -Format: `Boolean` +`can_add_acs_users_to_acs_access_groups` Format: `Boolean` Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -### `can_automate_enrollment` - -Format: `Boolean` +`can_automate_enrollment` Format: `Boolean` Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -### `can_create_acs_access_groups` - -Format: `Boolean` +`can_create_acs_access_groups` Format: `Boolean` Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -### `can_remove_acs_users_from_acs_access_groups` - -Format: `Boolean` +`can_remove_acs_users_from_acs_access_groups` Format: `Boolean` Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -### `connected_account_id` - -Format: `UUID` +`connected_account_id` Format: `UUID` ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -### `connected_account_ids` - +`connected_account_ids` Format: `List` Item format: `UUID` {% hint style="warning" %} **Deprecated**. Use `connected_account_id`. {% endhint %} -Format: `List` - -Item format: `UUID` - IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. --- -### `default_credential_manager_acs_system_id` - -Format: `UUID` +`default_credential_manager_acs_system_id` Format: `UUID` ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -### [`errors`](./#errors-1) - -Format: `List` - -Item format: `Object` +[`errors`](./#errors-1) Format: `List` Item format: `Object` Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -### `external_type` - -Format: `Enum` +`external_type` Format: `Enum` Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. @@ -123,41 +96,32 @@ Possible enum values: --- -### `external_type_display_name` - -Format: `String` +`external_type_display_name` Format: `String` Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. --- -### `image_alt_text` - -Format: `String` +`image_alt_text` Format: `String` Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. --- -### `image_url` - -Format: `String` +`image_url` Format: `String` URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -### `is_credential_manager` - -Format: `Boolean` +`is_credential_manager` Format: `Boolean` Indicates whether the `acs_system` is a credential manager. --- -### `location` +`location` Format: `Object` -Format: `Object`
@@ -167,21 +131,17 @@ Time zone in which the [access control system](https://docs.seam.co/latest/capab
--- -### `name` - -Format: `String` +`name` Format: `String` Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -### `system_type` - +`system_type` Format: `Enum` {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} -Format: `Enum` Possible enum values: - `pti_site` @@ -200,19 +160,16 @@ Possible enum values: --- -### `system_type_display_name` - +`system_type_display_name` Format: `String` {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} -Format: `String` --- -### `visionline_metadata` +`visionline_metadata` Format: `Object` -Format: `Object`
@@ -234,19 +191,13 @@ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel i
--- -### [`warnings`](./#warnings-1) - -Format: `List` - -Item format: `Object` +[`warnings`](./#warnings-1) Format: `List` Item format: `Object` Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -### `workspace_id` - -Format: `UUID` +`workspace_id` Format: `UUID` ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 58d18d481..c519dd384 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -12,9 +12,7 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties -### `access_schedule` - -Format: `Object` +`access_schedule` Format: `Object` `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. @@ -32,69 +30,51 @@ Date and time at which the user's access starts, in [ISO 8601](https://www.iso.o --- -### `acs_system_id` - -Format: `UUID` +`acs_system_id` Format: `UUID` ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `acs_user_id` - -Format: `UUID` +`acs_user_id` Format: `UUID` ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. --- -### `display_name` - -Format: `String` +`display_name` Format: `String` Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `email` - +`email` Format: `String` {% hint style="warning" %} **Deprecated**. use email_address. {% endhint %} -Format: `String` --- -### `email_address` - -Format: `String` +`email_address` Format: `String` Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### [`errors`](./#errors-1) - -Format: `List` - -Item format: `Object` +[`errors`](./#errors-1) Format: `List` Item format: `Object` Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `external_type` - -Format: `Enum` +`external_type` Format: `Enum` Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. @@ -109,95 +89,71 @@ Possible enum values: --- -### `external_type_display_name` - -Format: `String` +`external_type_display_name` Format: `String` Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. --- -### `full_name` - -Format: `String` +`full_name` Format: `String` Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `hid_acs_system_id` +`hid_acs_system_id` Format: `UUID` -Format: `UUID` --- -### `is_managed` +`is_managed` Format: `Boolean` -Format: `Boolean` --- -### `is_suspended` - -Format: `Boolean` +`is_suspended` Format: `Boolean` Indicates whether the [ACS 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). --- -### `phone_number` - -Format: `String` +`phone_number` Format: `String` Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -### `user_identity_email_address` - -Format: `String` +`user_identity_email_address` Format: `String` Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `user_identity_full_name` - -Format: `String` +`user_identity_full_name` Format: `String` Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `user_identity_id` - -Format: `String` +`user_identity_id` Format: `String` ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `user_identity_phone_number` - -Format: `String` +`user_identity_phone_number` Format: `String` Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -### [`warnings`](./#warnings-1) - -Format: `List` - -Item format: `Object` +[`warnings`](./#warnings-1) Format: `List` Item format: `Object` Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `workspace_id` - -Format: `UUID` +`workspace_id` Format: `UUID` ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 31c155a02..7fec267f7 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -8,33 +8,25 @@ Represents an app user's mobile phone. ## Properties -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the `phone` was created. --- -### `custom_metadata` - -Format: `Record` +`custom_metadata` Format: `Record` Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. --- -### `device_id` - -Format: `UUID` +`device_id` Format: `UUID` ID of the `phone`. --- -### `device_type` - -Format: `Enum` +`device_type` Format: `Enum` Type of phone. @@ -44,19 +36,13 @@ Possible enum values: --- -### `display_name` - -Format: `String` +`display_name` Format: `String` Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. --- -### `errors` - -Format: `List` - -Item format: `Object` +`errors` Format: `List` Item format: `Object` Errors associated with the `phone`. @@ -70,17 +56,13 @@ Errors associated with the `phone`. --- -### `nickname` - -Format: `String` +`nickname` Format: `String` Optional nickname to describe the phone, settable through Seam. --- -### `properties` - -Format: `Object` +`properties` Format: `Object` Properties of the phone. @@ -126,11 +108,7 @@ Indicates whether the credential service has an active associated phone. --- -### `warnings` - -Format: `List` - -Item format: `Object` +`warnings` Format: `List` Item format: `Object` Warnings associated with the `phone`. @@ -144,9 +122,7 @@ Warnings associated with the `phone`. --- -### `workspace_id` - -Format: `UUID` +`workspace_id` Format: `UUID` ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index a387eca74..f7b0ac963 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -181,23 +181,19 @@ Activating climate preset. ### Properties -#### `action_attempt_id` - -Format: `UUID` +`action_attempt_id` Format: `UUID` ID of the action attempt. --- -#### `action_type` +`action_type` Format: `String` -Format: `String` --- -#### `status` +`status` Format: `Enum` -Format: `Enum` Possible enum values: - `success` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index b8148a391..d42f92806 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -191,23 +191,19 @@ Setting HVAC mode. ### Properties -#### `action_attempt_id` - -Format: `UUID` +`action_attempt_id` Format: `UUID` ID of the action attempt. --- -#### `action_type` +`action_type` Format: `String` -Format: `String` --- -#### `status` +`status` Format: `Enum` -Format: `Enum` Possible enum values: - `success` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 3995967e2..a6f6e4b85 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -191,23 +191,19 @@ Setting HVAC mode. ### Properties -#### `action_attempt_id` - -Format: `UUID` +`action_attempt_id` Format: `UUID` ID of the action attempt. --- -#### `action_type` +`action_type` Format: `String` -Format: `String` --- -#### `status` +`status` Format: `Enum` -Format: `Enum` Possible enum values: - `success` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 3f8f59ded..3b63ba2a6 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -215,23 +215,19 @@ Setting HVAC mode. ### Properties -#### `action_attempt_id` - -Format: `UUID` +`action_attempt_id` Format: `UUID` ID of the action attempt. --- -#### `action_type` +`action_type` Format: `String` -Format: `String` --- -#### `status` +`status` Format: `Enum` -Format: `Enum` Possible enum values: - `success` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 83049a22c..c441c4ed3 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -163,23 +163,19 @@ Setting HVAC mode. ### Properties -#### `action_attempt_id` - -Format: `UUID` +`action_attempt_id` Format: `UUID` ID of the action attempt. --- -#### `action_type` +`action_type` Format: `String` -Format: `String` --- -#### `status` +`status` Format: `Enum` -Format: `Enum` Possible enum values: - `success` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 338fdc51d..ecd8c47b0 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -8,43 +8,31 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties -### `climate_preset_key` - -Format: `String` +`climate_preset_key` Format: `String` Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. --- -### `device_id` - -Format: `UUID` +`device_id` Format: `UUID` ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. --- -### `ends_at` - -Format: `Datetime` +`ends_at` Format: `Datetime` Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -### `errors` - -Format: `List` - -Item format: `Object` +`errors` Format: `List` Item format: `Object` Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). @@ -62,33 +50,25 @@ Detailed description of the error. Provides insights into the issue and potentia --- -### `max_override_period_minutes` - -Format: `Number` +`max_override_period_minutes` Format: `Number` Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -### `name` - -Format: `String` +`name` Format: `String` User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -### `starts_at` - -Format: `Datetime` +`starts_at` Format: `Datetime` Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -### `thermostat_schedule_id` - -Format: `UUID` +`thermostat_schedule_id` Format: `UUID` ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index ba9666104..2e62d19d3 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -191,23 +191,19 @@ Setting fan mode. ### Properties -#### `action_attempt_id` - -Format: `UUID` +`action_attempt_id` Format: `UUID` ID of the action attempt. --- -#### `action_type` +`action_type` Format: `String` -Format: `String` --- -#### `status` +`status` Format: `Enum` -Format: `Enum` Possible enum values: - `success` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 4433ae302..d35a700b7 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -229,23 +229,19 @@ Setting HVAC mode. ### Properties -#### `action_attempt_id` - -Format: `UUID` +`action_attempt_id` Format: `UUID` ID of the action attempt. --- -#### `action_type` +`action_type` Format: `String` -Format: `String` --- -#### `status` +`status` Format: `Enum` -Format: `Enum` Possible enum values: - `success` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 0655fc022..fbdadc91b 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -8,61 +8,47 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the user identity was created. --- -### `display_name` +`display_name` Format: `String` -Format: `String` --- -### `email_address` - -Format: `String` +`email_address` Format: `String` Unique email address for the user identity. --- -### `full_name` +`full_name` Format: `String` -Format: `String` --- -### `phone_number` - -Format: `String` +`phone_number` Format: `String` Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- -### `user_identity_id` - -Format: `UUID` +`user_identity_id` Format: `UUID` ID of the user identity. --- -### `user_identity_key` - -Format: `String` +`user_identity_key` Format: `String` Unique key for the user identity. --- -### `workspace_id` - -Format: `UUID` +`workspace_id` Format: `UUID` ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 36127ebfc..9e3b30fd0 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -8,41 +8,31 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties -### `created_at` - -Format: `Datetime` +`created_at` Format: `Datetime` Date and time at which the enrollment automation was created. --- -### `credential_manager_acs_system_id` - -Format: `UUID` +`credential_manager_acs_system_id` Format: `UUID` ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. --- -### `enrollment_automation_id` - -Format: `UUID` +`enrollment_automation_id` Format: `UUID` ID of the enrollment automation. --- -### `user_identity_id` - -Format: `UUID` +`user_identity_id` Format: `UUID` ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). --- -### `workspace_id` - -Format: `UUID` +`workspace_id` Format: `UUID` ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. From 25f6c0fd97109a4fa0b2e44fe13d99ccab93be02 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:47:12 -0400 Subject: [PATCH 052/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 3454a5786..6ec8ce220 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -15,11 +15,10 @@ {{/if}} {{#each properties}} -{{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} Format: `{{format}}`{{#if listItemFormat}} Item format: `{{listItemFormat}}`{{/if}} +{{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} *{{format}}`*{{#if listItemFormat}}* of {{listItemFormat}}s*{{/if}} {{#if isDeprecated}} {{> deprecated-warning}} {{/if}} - {{#if description}} {{description}} {{/if}} From 36f6c4ad69dc6f5e742c211ed4f02038a60ccfb5 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 18:48:14 +0000 Subject: [PATCH 053/233] ci: Generate docs --- docs/api/access_codes/README.md | 63 +++++---------- docs/api/acs/access_groups/README.md | 36 +++------ docs/api/acs/credentials/README.md | 78 +++++++------------ docs/api/acs/encoders/README.md | 18 ++--- docs/api/acs/encoders/encode_credential.md | 9 +-- docs/api/acs/encoders/scan_credential.md | 9 +-- docs/api/acs/entrances/README.md | 33 +++----- docs/api/acs/systems/README.md | 66 ++++++---------- docs/api/acs/users/README.md | 63 +++++---------- docs/api/phones/README.md | 30 +++---- .../thermostats/activate_climate_preset.md | 9 +-- docs/api/thermostats/cool.md | 9 +-- docs/api/thermostats/heat.md | 9 +-- docs/api/thermostats/heat_cool.md | 9 +-- docs/api/thermostats/off.md | 9 +-- docs/api/thermostats/schedules/README.md | 27 +++---- docs/api/thermostats/set_fan_mode.md | 9 +-- docs/api/thermostats/set_hvac_mode.md | 9 +-- docs/api/user_identities/README.md | 24 ++---- .../enrollment_automations/README.md | 15 ++-- 20 files changed, 178 insertions(+), 356 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 76d5a7a26..eea46577a 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -6,116 +6,97 @@ The Access Codes route contains the following resources: ## Properties -`access_code_id` Format: `UUID` - +`access_code_id` *UUID`* Unique identifier for the access code. --- -`code` Format: `String` - +`code` *String`* Code used for access. Typically, a numeric or alphanumeric string. --- -`common_code_key` Format: `String` - +`common_code_key` *String`* Unique identifier for a group of access codes that share the same code. --- -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the access code was created. --- -`device_id` Format: `UUID` - +`device_id` *UUID`* Unique identifier for the device associated with the access code. --- -`ends_at` Format: `Datetime` - +`ends_at` *Datetime`* Date and time after which the time-bound access code becomes inactive. --- -[`errors`](./#errors-1) Format: `List` Item format: `Object` - +[`errors`](./#errors-1) *List`** of Objects* Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. --- -`is_backup` Format: `Boolean` - +`is_backup` *Boolean`* Indicates whether the access code is a backup code. --- -`is_backup_access_code_available` Format: `Boolean` - +`is_backup_access_code_available` *Boolean`* Indicates whether a backup access code is available for use if the primary access code is lost or compromised. --- -`is_external_modification_allowed` Format: `Boolean` - +`is_external_modification_allowed` *Boolean`* Indicates whether changes to the access code from external sources are permitted. --- -`is_managed` Format: `Boolean` - +`is_managed` *Boolean`* Indicates whether Seam manages the access code. --- -`is_offline_access_code` Format: `Boolean` - +`is_offline_access_code` *Boolean`* Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. --- -`is_one_time_use` Format: `Boolean` - +`is_one_time_use` *Boolean`* Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. --- -`is_scheduled_on_device` Format: `Boolean` - +`is_scheduled_on_device` *Boolean`* Indicates whether the code is set on the device according to a preconfigured schedule. --- -`is_waiting_for_code_assignment` Format: `Boolean` - +`is_waiting_for_code_assignment` *Boolean`* Indicates whether the access code is waiting for a code assignment. --- -`name` Format: `String` - +`name` *String`* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. --- -`pulled_backup_access_code_id` Format: `UUID` - +`pulled_backup_access_code_id` *UUID`* Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. --- -`starts_at` Format: `Datetime` - +`starts_at` *Datetime`* Date and time at which the time-bound access code becomes active. --- -`status` Format: `Enum` - +`status` *Enum`* 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. @@ -129,8 +110,7 @@ Possible enum values: --- -`type` Format: `Enum` - +`type` *Enum`* Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. Possible enum values: @@ -139,8 +119,7 @@ Possible enum values: --- -[`warnings`](./#warnings-1) Format: `List` Item format: `Object` - +[`warnings`](./#warnings-1) *List`** of Objects* Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. --- diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 1ef12037b..94313bcbc 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -12,12 +12,11 @@ To learn whether your access control system supports access groups, see the corr ## Properties -`access_group_type` Format: `Enum` +`access_group_type` *Enum`* {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} - Possible enum values: - `pti_unit` - `pti_access_level` @@ -28,39 +27,33 @@ Possible enum values: --- -`access_group_type_display_name` Format: `String` +`access_group_type_display_name` *String`* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} - --- -`acs_access_group_id` Format: `UUID` - +`acs_access_group_id` *UUID`* ID of the access group. --- -`acs_system_id` Format: `UUID` - +`acs_system_id` *UUID`* ID of the access control system that contains the access group. --- -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the access group was created. --- -`display_name` Format: `String` - +`display_name` *String`* --- -`external_type` Format: `Enum` - +`external_type` *Enum`* Brand-specific terminology for the access group type. Possible enum values: @@ -73,25 +66,21 @@ Possible enum values: --- -`external_type_display_name` Format: `String` - +`external_type_display_name` *String`* Display name that corresponds to the brand-specific terminology for the access group type. --- -`is_managed` Format: `Boolean` - +`is_managed` *Boolean`* --- -`name` Format: `String` - +`name` *String`* Name of the access group. --- -`warnings` Format: `List` Item format: `Object` - +`warnings` *List`** of Objects* Warnings associated with the `acs_access_group`.
@@ -114,8 +103,7 @@ Unique identifier of the type of warning. Enables quick recognition and categori
--- -`workspace_id` Format: `UUID` - +`workspace_id` *UUID`* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. --- diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 8deaac948..54faeaf85 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -12,8 +12,7 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties -`access_method` Format: `Enum` - +`access_method` *Enum`* Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. Possible enum values: @@ -23,31 +22,26 @@ Possible enum values: --- -`acs_credential_id` Format: `UUID` - +`acs_credential_id` *UUID`* ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`acs_credential_pool_id` Format: `UUID` - +`acs_credential_pool_id` *UUID`* --- -`acs_system_id` Format: `UUID` - +`acs_system_id` *UUID`* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`acs_user_id` Format: `UUID` - +`acs_user_id` *UUID`* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. --- -`assa_abloy_vostio_metadata` Format: `Object` - +`assa_abloy_vostio_metadata` *Object`* Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
@@ -72,38 +66,32 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
--- -`card_number` Format: `String` - +`card_number` *String`* Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`code` Format: `String` - +`code` *String`* Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. --- -`display_name` Format: `String` - +`display_name` *String`* Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -`ends_at` Format: `String` - +`ends_at` *String`* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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` Format: `List` Item format: `Object` - +`errors` *List`** of Objects* Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
@@ -116,8 +104,7 @@ Errors associated with the [credential](../../../capability-guides/access-system
--- -`external_type` Format: `Enum` - +`external_type` *Enum`* Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. Possible enum values: @@ -131,67 +118,56 @@ Possible enum values: --- -`external_type_display_name` Format: `String` - +`external_type_display_name` *String`* Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -`is_issued` Format: `Boolean` - +`is_issued` *Boolean`* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. --- -`is_latest_desired_state_synced_with_provider` Format: `Boolean` - +`is_latest_desired_state_synced_with_provider` *Boolean`* Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. --- -`is_managed` Format: `Boolean` - +`is_managed` *Boolean`* --- -`is_multi_phone_sync_credential` Format: `Boolean` - +`is_multi_phone_sync_credential` *Boolean`* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- -`is_one_time_use` Format: `Boolean` - +`is_one_time_use` *Boolean`* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. --- -`issued_at` Format: `Datetime` - +`issued_at` *Datetime`* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. --- -`latest_desired_state_synced_with_provider_at` Format: `Datetime` - +`latest_desired_state_synced_with_provider_at` *Datetime`* Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. --- -`parent_acs_credential_id` Format: `UUID` - +`parent_acs_credential_id` *UUID`* ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`starts_at` Format: `String` - +`starts_at` *String`* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -`visionline_metadata` Format: `Object` - +`visionline_metadata` *Object`* Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
@@ -232,14 +208,12 @@ Possible enum values:
--- -[`warnings`](./#warnings-1) Format: `List` Item format: `Object` - +[`warnings`](./#warnings-1) *List`** of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`workspace_id` Format: `UUID` - +`workspace_id` *UUID`* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index fe8eb958a..8886dd0ae 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -21,32 +21,27 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties -`acs_encoder_id` Format: `UUID` - +`acs_encoder_id` *UUID`* ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. --- -`acs_system_id` Format: `UUID` - +`acs_system_id` *UUID`* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. --- -`display_name` Format: `String` - +`display_name` *String`* Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -`errors` Format: `List` Item format: `Object` - +`errors` *List`** of Objects* Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
@@ -69,8 +64,7 @@ Detailed description of the error. Provides insights into the issue and potentia
--- -`workspace_id` Format: `UUID` - +`workspace_id` *UUID`* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 1be4bf40d..eaa99ed2e 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -49,20 +49,17 @@ Action attempt to track encoding credential data from the physical encoder onto ### Properties -`action_attempt_id` Format: `UUID` - +`action_attempt_id` *UUID`* ID of the action attempt. --- -`action_type` Format: `String` - +`action_type` *String`* Type of action that the action attempt tracks. --- -`status` Format: `Enum` - +`status` *Enum`* Possible enum values: - `success` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 120e84543..5aa061fb9 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -40,19 +40,16 @@ Reading credential data from physical encoder. ### Properties -`action_attempt_id` Format: `UUID` - +`action_attempt_id` *UUID`* ID of the action attempt. --- -`action_type` Format: `String` - +`action_type` *String`* --- -`status` Format: `Enum` - +`status` *Enum`* Possible enum values: - `success` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 2116671f0..c60078557 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -10,20 +10,17 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties -`acs_entrance_id` Format: `UUID` - +`acs_entrance_id` *UUID`* ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -`acs_system_id` Format: `UUID` - +`acs_system_id` *UUID`* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -`assa_abloy_vostio_metadata` Format: `Object` - +`assa_abloy_vostio_metadata` *Object`* ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -54,20 +51,17 @@ Possible enum values:
--- -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. --- -`display_name` Format: `String` - +`display_name` *String`* Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -`dormakaba_community_metadata` Format: `Object` - +`dormakaba_community_metadata` *Object`* dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -76,8 +70,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
--- -`errors` Format: `List` Item format: `Object` - +`errors` *List`** of Objects* Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -94,8 +87,7 @@ Detailed description of the error. Provides insights into the issue and potentia
--- -`latch_metadata` Format: `Object` - +`latch_metadata` *Object`* Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -116,8 +108,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
--- -`salto_ks_metadata` Format: `Object` - +`salto_ks_metadata` *Object`* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -154,8 +145,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
--- -`salto_space_metadata` Format: `Object` - +`salto_space_metadata` *Object`* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -172,8 +162,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
--- -`visionline_metadata` Format: `Object` - +`visionline_metadata` *Object`* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index f2b05947a..61f359f49 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -12,71 +12,60 @@ For details about the resources associated with an access control system, see th ## Properties -`acs_system_id` Format: `UUID` - +`acs_system_id` *UUID`* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`can_add_acs_users_to_acs_access_groups` Format: `Boolean` - +`can_add_acs_users_to_acs_access_groups` *Boolean`* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -`can_automate_enrollment` Format: `Boolean` - +`can_automate_enrollment` *Boolean`* Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`can_create_acs_access_groups` Format: `Boolean` - +`can_create_acs_access_groups` *Boolean`* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -`can_remove_acs_users_from_acs_access_groups` Format: `Boolean` - +`can_remove_acs_users_from_acs_access_groups` *Boolean`* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -`connected_account_id` Format: `UUID` - +`connected_account_id` *UUID`* ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`connected_account_ids` Format: `List` Item format: `UUID` +`connected_account_ids` *List`** of UUIDs* {% hint style="warning" %} **Deprecated**. Use `connected_account_id`. {% endhint %} - IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. --- -`default_credential_manager_acs_system_id` Format: `UUID` - +`default_credential_manager_acs_system_id` *UUID`* ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -[`errors`](./#errors-1) Format: `List` Item format: `Object` - +[`errors`](./#errors-1) *List`** of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`external_type` Format: `Enum` - +`external_type` *Enum`* Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. Possible enum values: @@ -96,32 +85,27 @@ Possible enum values: --- -`external_type_display_name` Format: `String` - +`external_type_display_name` *String`* Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. --- -`image_alt_text` Format: `String` - +`image_alt_text` *String`* Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. --- -`image_url` Format: `String` - +`image_url` *String`* URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`is_credential_manager` Format: `Boolean` - +`is_credential_manager` *Boolean`* Indicates whether the `acs_system` is a credential manager. --- -`location` Format: `Object` - +`location` *Object`*
@@ -131,18 +115,16 @@ Time zone in which the [access control system](https://docs.seam.co/latest/capab
--- -`name` Format: `String` - +`name` *String`* Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`system_type` Format: `Enum` +`system_type` *Enum`* {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} - Possible enum values: - `pti_site` - `alta_org` @@ -160,16 +142,14 @@ Possible enum values: --- -`system_type_display_name` Format: `String` +`system_type_display_name` *String`* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} - --- -`visionline_metadata` Format: `Object` - +`visionline_metadata` *Object`*
@@ -191,14 +171,12 @@ Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel i
--- -[`warnings`](./#warnings-1) Format: `List` Item format: `Object` - +[`warnings`](./#warnings-1) *List`** of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`workspace_id` Format: `UUID` - +`workspace_id` *UUID`* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index c519dd384..e0b1926bf 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -12,8 +12,7 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties -`access_schedule` Format: `Object` - +`access_schedule` *Object`* `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.
@@ -30,52 +29,44 @@ Date and time at which the user's access starts, in [ISO 8601](https://www.iso.o
--- -`acs_system_id` Format: `UUID` - +`acs_system_id` *UUID`* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`acs_user_id` Format: `UUID` - +`acs_user_id` *UUID`* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. --- -`display_name` Format: `String` - +`display_name` *String`* Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`email` Format: `String` +`email` *String`* {% hint style="warning" %} **Deprecated**. use email_address. {% endhint %} - --- -`email_address` Format: `String` - +`email_address` *String`* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -[`errors`](./#errors-1) Format: `List` Item format: `Object` - +[`errors`](./#errors-1) *List`** of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`external_type` Format: `Enum` - +`external_type` *Enum`* Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. Possible enum values: @@ -89,72 +80,60 @@ Possible enum values: --- -`external_type_display_name` Format: `String` - +`external_type_display_name` *String`* Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. --- -`full_name` Format: `String` - +`full_name` *String`* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`hid_acs_system_id` Format: `UUID` - +`hid_acs_system_id` *UUID`* --- -`is_managed` Format: `Boolean` - +`is_managed` *Boolean`* --- -`is_suspended` Format: `Boolean` - +`is_suspended` *Boolean`* Indicates whether the [ACS 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). --- -`phone_number` Format: `String` - +`phone_number` *String`* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -`user_identity_email_address` Format: `String` - +`user_identity_email_address` *String`* Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`user_identity_full_name` Format: `String` - +`user_identity_full_name` *String`* Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`user_identity_id` Format: `String` - +`user_identity_id` *String`* ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`user_identity_phone_number` Format: `String` - +`user_identity_phone_number` *String`* Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -[`warnings`](./#warnings-1) Format: `List` Item format: `Object` - +[`warnings`](./#warnings-1) *List`** of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`workspace_id` Format: `UUID` - +`workspace_id` *UUID`* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 7fec267f7..b9cdd597b 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -8,26 +8,22 @@ Represents an app user's mobile phone. ## Properties -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the `phone` was created. --- -`custom_metadata` Format: `Record` - +`custom_metadata` *Record`* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. --- -`device_id` Format: `UUID` - +`device_id` *UUID`* ID of the `phone`. --- -`device_type` Format: `Enum` - +`device_type` *Enum`* Type of phone. Possible enum values: @@ -36,14 +32,12 @@ Possible enum values: --- -`display_name` Format: `String` - +`display_name` *String`* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. --- -`errors` Format: `List` Item format: `Object` - +`errors` *List`** of Objects* Errors associated with the `phone`.
@@ -56,14 +50,12 @@ Errors associated with the `phone`.
--- -`nickname` Format: `String` - +`nickname` *String`* Optional nickname to describe the phone, settable through Seam. --- -`properties` Format: `Object` - +`properties` *Object`* Properties of the phone.
@@ -108,8 +100,7 @@ Indicates whether the credential service has an active associated phone.
--- -`warnings` Format: `List` Item format: `Object` - +`warnings` *List`** of Objects* Warnings associated with the `phone`.
@@ -122,8 +113,7 @@ Warnings associated with the `phone`.
--- -`workspace_id` Format: `UUID` - +`workspace_id` *UUID`* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. --- diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index f7b0ac963..eec913541 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -181,19 +181,16 @@ Activating climate preset. ### Properties -`action_attempt_id` Format: `UUID` - +`action_attempt_id` *UUID`* ID of the action attempt. --- -`action_type` Format: `String` - +`action_type` *String`* --- -`status` Format: `Enum` - +`status` *Enum`* Possible enum values: - `success` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index d42f92806..0a6e669df 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -191,19 +191,16 @@ Setting HVAC mode. ### Properties -`action_attempt_id` Format: `UUID` - +`action_attempt_id` *UUID`* ID of the action attempt. --- -`action_type` Format: `String` - +`action_type` *String`* --- -`status` Format: `Enum` - +`status` *Enum`* Possible enum values: - `success` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index a6f6e4b85..f9abc7700 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -191,19 +191,16 @@ Setting HVAC mode. ### Properties -`action_attempt_id` Format: `UUID` - +`action_attempt_id` *UUID`* ID of the action attempt. --- -`action_type` Format: `String` - +`action_type` *String`* --- -`status` Format: `Enum` - +`status` *Enum`* Possible enum values: - `success` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 3b63ba2a6..7d837670f 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -215,19 +215,16 @@ Setting HVAC mode. ### Properties -`action_attempt_id` Format: `UUID` - +`action_attempt_id` *UUID`* ID of the action attempt. --- -`action_type` Format: `String` - +`action_type` *String`* --- -`status` Format: `Enum` - +`status` *Enum`* Possible enum values: - `success` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index c441c4ed3..a8b048a1e 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -163,19 +163,16 @@ Setting HVAC mode. ### Properties -`action_attempt_id` Format: `UUID` - +`action_attempt_id` *UUID`* ID of the action attempt. --- -`action_type` Format: `String` - +`action_type` *String`* --- -`status` Format: `Enum` - +`status` *Enum`* Possible enum values: - `success` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index ecd8c47b0..77e40cdfa 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -8,32 +8,27 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties -`climate_preset_key` Format: `String` - +`climate_preset_key` *String`* Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. --- -`device_id` Format: `UUID` - +`device_id` *UUID`* ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. --- -`ends_at` Format: `Datetime` - +`ends_at` *Datetime`* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -`errors` Format: `List` Item format: `Object` - +`errors` *List`** of Objects* Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
@@ -50,26 +45,22 @@ Detailed description of the error. Provides insights into the issue and potentia
--- -`max_override_period_minutes` Format: `Number` - +`max_override_period_minutes` *Number`* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -`name` Format: `String` - +`name` *String`* User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -`starts_at` Format: `Datetime` - +`starts_at` *Datetime`* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -`thermostat_schedule_id` Format: `UUID` - +`thermostat_schedule_id` *UUID`* ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 2e62d19d3..259e669c0 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -191,19 +191,16 @@ Setting fan mode. ### Properties -`action_attempt_id` Format: `UUID` - +`action_attempt_id` *UUID`* ID of the action attempt. --- -`action_type` Format: `String` - +`action_type` *String`* --- -`status` Format: `Enum` - +`status` *Enum`* Possible enum values: - `success` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index d35a700b7..b7badbc73 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -229,19 +229,16 @@ Setting HVAC mode. ### Properties -`action_attempt_id` Format: `UUID` - +`action_attempt_id` *UUID`* ID of the action attempt. --- -`action_type` Format: `String` - +`action_type` *String`* --- -`status` Format: `Enum` - +`status` *Enum`* Possible enum values: - `success` diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index fbdadc91b..a28afc519 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -8,48 +8,40 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the user identity was created. --- -`display_name` Format: `String` - +`display_name` *String`* --- -`email_address` Format: `String` - +`email_address` *String`* Unique email address for the user identity. --- -`full_name` Format: `String` - +`full_name` *String`* --- -`phone_number` Format: `String` - +`phone_number` *String`* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- -`user_identity_id` Format: `UUID` - +`user_identity_id` *UUID`* ID of the user identity. --- -`user_identity_key` Format: `String` - +`user_identity_key` *String`* Unique key for the user identity. --- -`workspace_id` Format: `UUID` - +`workspace_id` *UUID`* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. --- diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 9e3b30fd0..72aa9d2ec 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -8,32 +8,27 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties -`created_at` Format: `Datetime` - +`created_at` *Datetime`* Date and time at which the enrollment automation was created. --- -`credential_manager_acs_system_id` Format: `UUID` - +`credential_manager_acs_system_id` *UUID`* ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. --- -`enrollment_automation_id` Format: `UUID` - +`enrollment_automation_id` *UUID`* ID of the enrollment automation. --- -`user_identity_id` Format: `UUID` - +`user_identity_id` *UUID`* ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). --- -`workspace_id` Format: `UUID` - +`workspace_id` *UUID`* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. --- From e58605eeec1304627ace36a5a8a01417d196f089 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:54:45 -0400 Subject: [PATCH 054/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 6ec8ce220..6c3824fd6 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -15,19 +15,20 @@ {{/if}} {{#each properties}} -{{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} *{{format}}`*{{#if listItemFormat}}* of {{listItemFormat}}s*{{/if}} -{{#if isDeprecated}} -{{> deprecated-warning}} -{{/if}} +{{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} *{{format}}*{{#if listItemFormat}}* of {{listItemFormat}}s*{{/if}} {{#if description}} {{description}} {{/if}} +{{#if isDeprecated}} +{{> deprecated-warning}} +{{/if}} {{#if enumValues}} - -Possible enum values: +
+Possible enum values: {{#each enumValues}} - `{{this}}` {{/each}} +
{{/if}} {{#unless (eq objectProperties undefined)}} {{#if (eq objectProperties.length 0)}} From cc14aed4287b191e1ac5b1f03b7dcd76159e1c98 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:55:12 -0400 Subject: [PATCH 055/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 6c3824fd6..d1d4f6f52 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -47,7 +47,4 @@ This object has no properties. {{> property-collapsible this}} {{/each}} {{/if}} - ---- - {{/each}} From 40b633fdb2dd988743e5a55eeb7433170c5628b7 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 18:56:21 +0000 Subject: [PATCH 056/233] ci: Generate docs --- docs/api/access_codes/README.md | 115 ++++---------- docs/api/acs/access_groups/README.md | 70 +++------ docs/api/acs/credentials/README.md | 140 ++++-------------- docs/api/acs/encoders/README.md | 30 +--- docs/api/acs/encoders/encode_credential.md | 20 +-- docs/api/acs/encoders/scan_credential.md | 20 +-- docs/api/acs/entrances/README.md | 57 ++----- docs/api/acs/systems/README.md | 122 ++++----------- docs/api/acs/users/README.md | 110 +++----------- docs/api/phones/README.md | 55 ++----- .../thermostats/activate_climate_preset.md | 20 +-- docs/api/thermostats/cool.md | 20 +-- docs/api/thermostats/heat.md | 20 +-- docs/api/thermostats/heat_cool.md | 20 +-- docs/api/thermostats/off.md | 20 +-- docs/api/thermostats/schedules/README.md | 45 ++---- docs/api/thermostats/set_fan_mode.md | 20 +-- docs/api/thermostats/set_hvac_mode.md | 20 +-- docs/api/user_identities/README.md | 40 +---- .../enrollment_automations/README.md | 25 +--- 20 files changed, 237 insertions(+), 752 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index eea46577a..82bf58473 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -6,124 +6,63 @@ The Access Codes route contains the following resources: ## Properties -`access_code_id` *UUID`* +`access_code_id` *UUID* Unique identifier for the access code. - ---- - -`code` *String`* +`code` *String* Code used for access. Typically, a numeric or alphanumeric string. - ---- - -`common_code_key` *String`* +`common_code_key` *String* Unique identifier for a group of access codes that share the same code. - ---- - -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the access code was created. - ---- - -`device_id` *UUID`* +`device_id` *UUID* Unique identifier for the device associated with the access code. - ---- - -`ends_at` *Datetime`* +`ends_at` *Datetime* Date and time after which the time-bound access code becomes inactive. - ---- - -[`errors`](./#errors-1) *List`** of Objects* +[`errors`](./#errors-1) *List** of Objects* Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. - ---- - -`is_backup` *Boolean`* +`is_backup` *Boolean* Indicates whether the access code is a backup code. - ---- - -`is_backup_access_code_available` *Boolean`* +`is_backup_access_code_available` *Boolean* Indicates whether a backup access code is available for use if the primary access code is lost or compromised. - ---- - -`is_external_modification_allowed` *Boolean`* +`is_external_modification_allowed` *Boolean* Indicates whether changes to the access code from external sources are permitted. - ---- - -`is_managed` *Boolean`* +`is_managed` *Boolean* Indicates whether Seam manages the access code. - ---- - -`is_offline_access_code` *Boolean`* +`is_offline_access_code` *Boolean* Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. - ---- - -`is_one_time_use` *Boolean`* +`is_one_time_use` *Boolean* Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. - ---- - -`is_scheduled_on_device` *Boolean`* +`is_scheduled_on_device` *Boolean* Indicates whether the code is set on the device according to a preconfigured schedule. - ---- - -`is_waiting_for_code_assignment` *Boolean`* +`is_waiting_for_code_assignment` *Boolean* Indicates whether the access code is waiting for a code assignment. - ---- - -`name` *String`* +`name` *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. - ---- - -`pulled_backup_access_code_id` *UUID`* +`pulled_backup_access_code_id` *UUID* Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. - ---- - -`starts_at` *Datetime`* +`starts_at` *Datetime* Date and time at which the time-bound access code becomes active. - ---- - -`status` *Enum`* +`status` *Enum* 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. - -Possible enum values: +
+Possible enum values: - `setting` - `set` - `unset` - `removing` - `unknown` - ---- - -`type` *Enum`* +
+`type` *Enum* Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. - -Possible enum values: +
+Possible enum values: - `time_bound` - `ongoing` - ---- - -[`warnings`](./#warnings-1) *List`** of Objects* +
+[`warnings`](./#warnings-1) *List** of Objects* Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. - ---- - ## Errors ### `smartthings_failed_to_set_access_code` diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 94313bcbc..0d294fe28 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -12,75 +12,47 @@ To learn whether your access control system supports access groups, see the corr ## Properties -`access_group_type` *Enum`* +`access_group_type` *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} - -Possible enum values: +
+Possible enum values: - `pti_unit` - `pti_access_level` - `salto_ks_access_group` - `brivo_group` - `salto_space_group` - `dormakaba_community_access_group` - ---- - -`access_group_type_display_name` *String`* +
+`access_group_type_display_name` *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} - ---- - -`acs_access_group_id` *UUID`* +`acs_access_group_id` *UUID* ID of the access group. - ---- - -`acs_system_id` *UUID`* +`acs_system_id` *UUID* ID of the access control system that contains the access group. - ---- - -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the access group was created. - ---- - -`display_name` *String`* - ---- - -`external_type` *Enum`* +`display_name` *String* +`external_type` *Enum* Brand-specific terminology for the access group type. - -Possible enum values: +
+Possible enum values: - `pti_unit` - `pti_access_level` - `salto_ks_access_group` - `brivo_group` - `salto_space_group` - `dormakaba_community_access_group` - ---- - -`external_type_display_name` *String`* +
+`external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the access group type. - ---- - -`is_managed` *Boolean`* - ---- - -`name` *String`* +`is_managed` *Boolean* +`name` *String* Name of the access group. - ---- - -`warnings` *List`** of Objects* +`warnings` *List** of Objects* Warnings associated with the `acs_access_group`.
@@ -100,14 +72,8 @@ Detailed description of the warning. Provides insights into the issue and potent warning_code Format: String Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. -
---- - -`workspace_id` *UUID`* +
`workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. - ---- - ## Endpoints ### [`/acs/access_groups/add_user`](./add_user.md) diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 54faeaf85..d5877483a 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -12,36 +12,22 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties -`access_method` *Enum`* +`access_method` *Enum* Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. - -Possible enum values: +
+Possible enum values: - `code` - `card` - `mobile_key` - ---- - -`acs_credential_id` *UUID`* +
+`acs_credential_id` *UUID* ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). - ---- - -`acs_credential_pool_id` *UUID`* - ---- - -`acs_system_id` *UUID`* +`acs_credential_pool_id` *UUID* +`acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). - ---- - -`acs_user_id` *UUID`* +`acs_user_id` *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. - ---- - -`assa_abloy_vostio_metadata` *Object`* +`assa_abloy_vostio_metadata` *Object* Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
@@ -63,35 +49,17 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
override_guest_acs_entrance_ids Format: List Item format: String -
---- - -`card_number` *String`* +
`card_number` *String* Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). - ---- - -`code` *String`* +`code` *String* Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). - ---- - -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. - ---- - -`display_name` *String`* +`display_name` *String* Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. - ---- - -`ends_at` *String`* +`ends_at` *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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` *List`** of Objects* +`errors` *List** of Objects* Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
@@ -101,13 +69,10 @@ Errors associated with the [credential](../../../capability-guides/access-system
message Format: String -
---- - -`external_type` *Enum`* +
`external_type` *Enum* Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. - -Possible enum values: +
+Possible enum values: - `pti_card` - `brivo_credential` - `hid_credential` @@ -115,59 +80,27 @@ Possible enum values: - `salto_ks_credential` - `assa_abloy_vostio_key` - `salto_space_key` - ---- - -`external_type_display_name` *String`* +
+`external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. - ---- - -`is_issued` *Boolean`* +`is_issued` *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. - ---- - -`is_latest_desired_state_synced_with_provider` *Boolean`* +`is_latest_desired_state_synced_with_provider` *Boolean* Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. - ---- - -`is_managed` *Boolean`* - ---- - -`is_multi_phone_sync_credential` *Boolean`* +`is_managed` *Boolean* +`is_multi_phone_sync_credential` *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). - ---- - -`is_one_time_use` *Boolean`* +`is_one_time_use` *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. - ---- - -`issued_at` *Datetime`* +`issued_at` *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. - ---- - -`latest_desired_state_synced_with_provider_at` *Datetime`* +`latest_desired_state_synced_with_provider_at` *Datetime* Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. - ---- - -`parent_acs_credential_id` *UUID`* +`parent_acs_credential_id` *UUID* ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). - ---- - -`starts_at` *String`* +`starts_at` *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ---- - -`visionline_metadata` *Object`* +`visionline_metadata` *Object* Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
@@ -205,19 +138,10 @@ Possible enum values:
joiner_acs_credential_ids Format: List Item format: UUID -
---- - -[`warnings`](./#warnings-1) *List`** of Objects* +
[`warnings`](./#warnings-1) *List** of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). - ---- - -`workspace_id` *UUID`* +`workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). - ---- - ## Warnings ### `waiting_to_be_issued` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 8886dd0ae..5d709373d 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -21,27 +21,15 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties -`acs_encoder_id` *UUID`* +`acs_encoder_id` *UUID* ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. - ---- - -`acs_system_id` *UUID`* +`acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - ---- - -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. - ---- - -`display_name` *String`* +`display_name` *String* Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - ---- - -`errors` *List`** of Objects* +`errors` *List** of Objects* Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
@@ -61,14 +49,8 @@ Unique identifier of the type of error. Enables quick recognition and categoriza message Format: String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
---- - -`workspace_id` *UUID`* +`workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - ---- - ## Endpoints ### [`/acs/encoders/encode_credential`](./encode_credential.md) diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index eaa99ed2e..c63a614f3 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -49,22 +49,14 @@ Action attempt to track encoding credential data from the physical encoder onto ### Properties -`action_attempt_id` *UUID`* +`action_attempt_id` *UUID* ID of the action attempt. - ---- - -`action_type` *String`* +`action_type` *String* Type of action that the action attempt tracks. - ---- - -`status` *Enum`* - -Possible enum values: +`status` *Enum* +
+Possible enum values: - `success` - `pending` - `error` - ---- - +
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 5aa061fb9..266f640b3 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -40,21 +40,13 @@ Reading credential data from physical encoder. ### Properties -`action_attempt_id` *UUID`* +`action_attempt_id` *UUID* ID of the action attempt. - ---- - -`action_type` *String`* - ---- - -`status` *Enum`* - -Possible enum values: +`action_type` *String* +`status` *Enum* +
+Possible enum values: - `success` - `pending` - `error` - ---- - +
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index c60078557..198a881d2 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -10,17 +10,11 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties -`acs_entrance_id` *UUID`* +`acs_entrance_id` *UUID* ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - ---- - -`acs_system_id` *UUID`* +`acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - ---- - -`assa_abloy_vostio_metadata` *Object`* +`assa_abloy_vostio_metadata` *Object* ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -48,29 +42,17 @@ Possible enum values:
stand_open Format: Boolean -
---- - -`created_at` *Datetime`* +
`created_at` *Datetime* Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. - ---- - -`display_name` *String`* +`display_name` *String* Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - ---- - -`dormakaba_community_metadata` *Object`* +`dormakaba_community_metadata` *Object* dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
access_point_name Format: String -
---- - -`errors` *List`** of Objects* +`errors` *List** of Objects* Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -84,10 +66,7 @@ Unique identifier of the type of error. Enables quick recognition and categoriza message Format: String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
---- - -`latch_metadata` *Object`* +`latch_metadata` *Object* Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -105,10 +84,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
is_connected Format: Boolean -
---- - -`salto_ks_metadata` *Object`* +
`salto_ks_metadata` *Object* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -142,10 +118,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
privacy_mode Format: Boolean -
---- - -`salto_space_metadata` *Object`* +
`salto_space_metadata` *Object* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -159,10 +132,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
ext_door_id Format: String -
---- - -`visionline_metadata` *Object`* +
`visionline_metadata` *Object* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -194,10 +164,7 @@ Possible enum values: - `commonDoor` - `touch` -
---- - -## Endpoints +## Endpoints ### [`/acs/entrances/get`](./get.md) diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 61f359f49..ff24179d1 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -12,63 +12,33 @@ For details about the resources associated with an access control system, see th ## Properties -`acs_system_id` *UUID`* +`acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - -`can_add_acs_users_to_acs_access_groups` *Boolean`* +`can_add_acs_users_to_acs_access_groups` *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). - ---- - -`can_automate_enrollment` *Boolean`* +`can_automate_enrollment` *Boolean* Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - -`can_create_acs_access_groups` *Boolean`* +`can_create_acs_access_groups` *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). - ---- - -`can_remove_acs_users_from_acs_access_groups` *Boolean`* +`can_remove_acs_users_from_acs_access_groups` *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). - ---- - -`connected_account_id` *UUID`* +`connected_account_id` *UUID* ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - -`connected_account_ids` *List`** of UUIDs* +`connected_account_ids` *List** of UUIDs* +IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). {% hint style="warning" %} **Deprecated**. Use `connected_account_id`. {% endhint %} -IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. - ---- - -`default_credential_manager_acs_system_id` *UUID`* +`default_credential_manager_acs_system_id` *UUID* ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - -[`errors`](./#errors-1) *List`** of Objects* +[`errors`](./#errors-1) *List** of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - -`external_type` *Enum`* +`external_type` *Enum* Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. - -Possible enum values: +
+Possible enum values: - `pti_site` - `alta_org` - `salto_ks_site` @@ -82,50 +52,30 @@ Possible enum values: - `legic_connect_credential_service` - `assa_abloy_vostio` - `assa_abloy_vostio_credential_service` - ---- - -`external_type_display_name` *String`* +
+`external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. - ---- - -`image_alt_text` *String`* +`image_alt_text` *String* Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. - ---- - -`image_url` *String`* +`image_url` *String* URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - -`is_credential_manager` *Boolean`* +`is_credential_manager` *Boolean* Indicates whether the `acs_system` is a credential manager. - ---- - -`location` *Object`* +`location` *Object*
time_zone Format: String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. -
---- - -`name` *String`* +`name` *String* Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - -`system_type` *Enum`* +`system_type` *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} - -Possible enum values: +
+Possible enum values: - `pti_site` - `alta_org` - `salto_ks_site` @@ -139,17 +89,12 @@ Possible enum values: - `legic_connect_credential_service` - `assa_abloy_vostio` - `assa_abloy_vostio_credential_service` - ---- - -`system_type_display_name` *String`* +
+`system_type_display_name` *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} - ---- - -`visionline_metadata` *Object`* +`visionline_metadata` *Object*
@@ -168,19 +113,10 @@ Keyset loaded into a reader. Mobile keys and reader administration tools securel system_id Format: String Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. -
---- - -[`warnings`](./#warnings-1) *List`** of Objects* +[`warnings`](./#warnings-1) *List** of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - -`workspace_id` *UUID`* +`workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - ---- - ## Errors ### `seam_bridge_disconnected` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index e0b1926bf..a993b0ba6 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -12,7 +12,7 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties -`access_schedule` *Object`* +`access_schedule` *Object* `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.
@@ -26,50 +26,26 @@ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org starts_at Format: Datetime Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -
---- - -`acs_system_id` *UUID`* +`acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -`acs_user_id` *UUID`* +`acs_user_id` *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. - ---- - -`display_name` *String`* +`display_name` *String* Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -`email` *String`* +`email` *String* {% hint style="warning" %} **Deprecated**. use email_address. {% endhint %} - ---- - -`email_address` *String`* +`email_address` *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -[`errors`](./#errors-1) *List`** of Objects* +[`errors`](./#errors-1) *List** of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -`external_type` *Enum`* +`external_type` *Enum* Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. - -Possible enum values: +
+Possible enum values: - `pti_user` - `brivo_user` - `hid_credential_manager_user` @@ -77,67 +53,29 @@ Possible enum values: - `latch_user` - `dormakaba_community_user` - `salto_space_user` - ---- - -`external_type_display_name` *String`* +
+`external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. - ---- - -`full_name` *String`* +`full_name` *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -`hid_acs_system_id` *UUID`* - ---- - -`is_managed` *Boolean`* - ---- - -`is_suspended` *Boolean`* +`hid_acs_system_id` *UUID* +`is_managed` *Boolean* +`is_suspended` *Boolean* Indicates whether the [ACS 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). - ---- - -`phone_number` *String`* +`phone_number` *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). - ---- - -`user_identity_email_address` *String`* +`user_identity_email_address` *String* Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -`user_identity_full_name` *String`* +`user_identity_full_name` *String* Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -`user_identity_id` *String`* +`user_identity_id` *String* ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -`user_identity_phone_number` *String`* +`user_identity_phone_number` *String* Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). - ---- - -[`warnings`](./#warnings-1) *List`** of Objects* +[`warnings`](./#warnings-1) *List** of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -`workspace_id` *UUID`* +`workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - ## Errors ### `deleted_externally` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index b9cdd597b..39ca14531 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -8,36 +8,22 @@ Represents an app user's mobile phone. ## Properties -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the `phone` was created. - ---- - -`custom_metadata` *Record`* +`custom_metadata` *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. - ---- - -`device_id` *UUID`* +`device_id` *UUID* ID of the `phone`. - ---- - -`device_type` *Enum`* +`device_type` *Enum* Type of phone. - -Possible enum values: +
+Possible enum values: - `ios_phone` - `android_phone` - ---- - -`display_name` *String`* +
+`display_name` *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. - ---- - -`errors` *List`** of Objects* +`errors` *List** of Objects* Errors associated with the `phone`.
@@ -47,15 +33,9 @@ Errors associated with the `phone`.
message Format: String -
---- - -`nickname` *String`* +
`nickname` *String* Optional nickname to describe the phone, settable through Seam. - ---- - -`properties` *Object`* +`properties` *Object* Properties of the phone.
@@ -97,10 +77,7 @@ Salto Space credential service metadata for the phone. salto_space_credential_service_metadata.has_active_phone Format: Boolean Indicates whether the credential service has an active associated phone. -
---- - -`warnings` *List`** of Objects* +`warnings` *List** of Objects* Warnings associated with the `phone`.
@@ -110,14 +87,8 @@ Warnings associated with the `phone`.
warning_code Format: String -
---- - -`workspace_id` *UUID`* +
`workspace_id` *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. - ---- - ## Endpoints ### [`/phones/deactivate`](./deactivate.md) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index eec913541..79dd0acf9 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -181,21 +181,13 @@ Activating climate preset. ### Properties -`action_attempt_id` *UUID`* +`action_attempt_id` *UUID* ID of the action attempt. - ---- - -`action_type` *String`* - ---- - -`status` *Enum`* - -Possible enum values: +`action_type` *String* +`status` *Enum* +
+Possible enum values: - `success` - `pending` - `error` - ---- - +
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 0a6e669df..db43a72af 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -191,21 +191,13 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID`* +`action_attempt_id` *UUID* ID of the action attempt. - ---- - -`action_type` *String`* - ---- - -`status` *Enum`* - -Possible enum values: +`action_type` *String* +`status` *Enum* +
+Possible enum values: - `success` - `pending` - `error` - ---- - +
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index f9abc7700..b9e52c491 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -191,21 +191,13 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID`* +`action_attempt_id` *UUID* ID of the action attempt. - ---- - -`action_type` *String`* - ---- - -`status` *Enum`* - -Possible enum values: +`action_type` *String* +`status` *Enum* +
+Possible enum values: - `success` - `pending` - `error` - ---- - +
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 7d837670f..7c10bfc3a 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -215,21 +215,13 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID`* +`action_attempt_id` *UUID* ID of the action attempt. - ---- - -`action_type` *String`* - ---- - -`status` *Enum`* - -Possible enum values: +`action_type` *String* +`status` *Enum* +
+Possible enum values: - `success` - `pending` - `error` - ---- - +
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index a8b048a1e..b485fd041 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -163,21 +163,13 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID`* +`action_attempt_id` *UUID* ID of the action attempt. - ---- - -`action_type` *String`* - ---- - -`status` *Enum`* - -Possible enum values: +`action_type` *String* +`status` *Enum* +
+Possible enum values: - `success` - `pending` - `error` - ---- - +
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 77e40cdfa..4a31b3c8f 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -8,27 +8,15 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties -`climate_preset_key` *String`* +`climate_preset_key` *String* Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). - ---- - -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. - ---- - -`device_id` *UUID`* +`device_id` *UUID* ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. - ---- - -`ends_at` *Datetime`* +`ends_at` *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ---- - -`errors` *List`** of Objects* +`errors` *List** of Objects* Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
@@ -42,29 +30,14 @@ Unique identifier of the type of error. Enables quick recognition and categoriza message Format: String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
---- - -`max_override_period_minutes` *Number`* +`max_override_period_minutes` *Number* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). - ---- - -`name` *String`* +`name` *String* User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). - ---- - -`starts_at` *Datetime`* +`starts_at` *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ---- - -`thermostat_schedule_id` *UUID`* +`thermostat_schedule_id` *UUID* ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). - ---- - ## Endpoints ### [`/thermostats/schedules/create`](./create.md) diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 259e669c0..3186c9116 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -191,21 +191,13 @@ Setting fan mode. ### Properties -`action_attempt_id` *UUID`* +`action_attempt_id` *UUID* ID of the action attempt. - ---- - -`action_type` *String`* - ---- - -`status` *Enum`* - -Possible enum values: +`action_type` *String* +`status` *Enum* +
+Possible enum values: - `success` - `pending` - `error` - ---- - +
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index b7badbc73..1b33b6a9f 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -229,21 +229,13 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID`* +`action_attempt_id` *UUID* ID of the action attempt. - ---- - -`action_type` *String`* - ---- - -`status` *Enum`* - -Possible enum values: +`action_type` *String* +`status` *Enum* +
+Possible enum values: - `success` - `pending` - `error` - ---- - +
diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index a28afc519..14e52dc55 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -8,44 +8,20 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the user identity was created. - ---- - -`display_name` *String`* - ---- - -`email_address` *String`* +`display_name` *String* +`email_address` *String* Unique email address for the user identity. - ---- - -`full_name` *String`* - ---- - -`phone_number` *String`* +`full_name` *String* +`phone_number` *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). - ---- - -`user_identity_id` *UUID`* +`user_identity_id` *UUID* ID of the user identity. - ---- - -`user_identity_key` *String`* +`user_identity_key` *String* Unique key for the user identity. - ---- - -`workspace_id` *UUID`* +`workspace_id` *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. - ---- - ## Endpoints ### [`/user_identities/add_acs_user`](./add_acs_user.md) diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 72aa9d2ec..09e9f8beb 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -8,31 +8,16 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties -`created_at` *Datetime`* +`created_at` *Datetime* Date and time at which the enrollment automation was created. - ---- - -`credential_manager_acs_system_id` *UUID`* +`credential_manager_acs_system_id` *UUID* ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. - ---- - -`enrollment_automation_id` *UUID`* +`enrollment_automation_id` *UUID* ID of the enrollment automation. - ---- - -`user_identity_id` *UUID`* +`user_identity_id` *UUID* ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - ---- - -`workspace_id` *UUID`* +`workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. - ---- - ## Endpoints ### [`/user_identities/enrollment_automations/delete`](./delete.md) From 70e9606754e24fbc6bcb40aba47d2e95008917ca Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:58:48 -0400 Subject: [PATCH 057/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index d1d4f6f52..d63cf16de 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -16,11 +16,14 @@ {{#each properties}} {{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} *{{format}}*{{#if listItemFormat}}* of {{listItemFormat}}s*{{/if}} + {{#if description}} {{description}} + {{/if}} {{#if isDeprecated}} {{> deprecated-warning}} + {{/if}} {{#if enumValues}}
@@ -29,6 +32,7 @@ - `{{this}}` {{/each}}
+ {{/if}} {{#unless (eq objectProperties undefined)}} {{#if (eq objectProperties.length 0)}} From cc79132d95f2782180e28a37de210dc0d69a3a93 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 18:59:53 +0000 Subject: [PATCH 058/233] ci: Generate docs --- docs/api/access_codes/README.md | 44 ++++++++++++++++ docs/api/acs/access_groups/README.md | 24 +++++++++ docs/api/acs/credentials/README.md | 52 +++++++++++++++++++ docs/api/acs/encoders/README.md | 12 +++++ docs/api/acs/encoders/encode_credential.md | 6 +++ docs/api/acs/encoders/scan_credential.md | 5 ++ docs/api/acs/entrances/README.md | 22 ++++++++ docs/api/acs/systems/README.md | 45 ++++++++++++++++ docs/api/acs/users/README.md | 41 +++++++++++++++ docs/api/phones/README.md | 21 ++++++++ .../thermostats/activate_climate_preset.md | 5 ++ docs/api/thermostats/cool.md | 5 ++ docs/api/thermostats/heat.md | 5 ++ docs/api/thermostats/heat_cool.md | 5 ++ docs/api/thermostats/off.md | 5 ++ docs/api/thermostats/schedules/README.md | 18 +++++++ docs/api/thermostats/set_fan_mode.md | 5 ++ docs/api/thermostats/set_hvac_mode.md | 5 ++ docs/api/user_identities/README.md | 14 +++++ .../enrollment_automations/README.md | 10 ++++ 20 files changed, 349 insertions(+) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 82bf58473..72a062ee9 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -7,45 +7,83 @@ The Access Codes route contains the following resources: ## Properties `access_code_id` *UUID* + Unique identifier for the access code. + `code` *String* + Code used for access. Typically, a numeric or alphanumeric string. + `common_code_key` *String* + Unique identifier for a group of access codes that share the same code. + `created_at` *Datetime* + Date and time at which the access code was created. + `device_id` *UUID* + Unique identifier for the device associated with the access code. + `ends_at` *Datetime* + Date and time after which the time-bound access code becomes inactive. + [`errors`](./#errors-1) *List** of Objects* + Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. + `is_backup` *Boolean* + Indicates whether the access code is a backup code. + `is_backup_access_code_available` *Boolean* + Indicates whether a backup access code is available for use if the primary access code is lost or compromised. + `is_external_modification_allowed` *Boolean* + Indicates whether changes to the access code from external sources are permitted. + `is_managed` *Boolean* + Indicates whether Seam manages the access code. + `is_offline_access_code` *Boolean* + Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. + `is_one_time_use` *Boolean* + Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. + `is_scheduled_on_device` *Boolean* + Indicates whether the code is set on the device according to a preconfigured schedule. + `is_waiting_for_code_assignment` *Boolean* + Indicates whether the access code is waiting for a code assignment. + `name` *String* + Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + `pulled_backup_access_code_id` *UUID* + Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. + `starts_at` *Datetime* + Date and time at which the time-bound access code becomes active. + `status` *Enum* + 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. +
Possible enum values: - `setting` @@ -54,15 +92,21 @@ Date and time at which the time-bound access code becomes active. - `removing` - `unknown`
+ `type` *Enum* + Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. +
Possible enum values: - `time_bound` - `ongoing`
+ [`warnings`](./#warnings-1) *List** of Objects* + Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. + ## Errors ### `smartthings_failed_to_set_access_code` diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 0d294fe28..090d9a8c6 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -13,9 +13,11 @@ To learn whether your access control system supports access groups, see the corr ## Properties `access_group_type` *Enum* + {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} +
Possible enum values: - `pti_unit` @@ -25,19 +27,31 @@ To learn whether your access control system supports access groups, see the corr - `salto_space_group` - `dormakaba_community_access_group`
+ `access_group_type_display_name` *String* + {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} + `acs_access_group_id` *UUID* + ID of the access group. + `acs_system_id` *UUID* + ID of the access control system that contains the access group. + `created_at` *Datetime* + Date and time at which the access group was created. + `display_name` *String* + `external_type` *Enum* + Brand-specific terminology for the access group type. +
Possible enum values: - `pti_unit` @@ -47,14 +61,22 @@ Brand-specific terminology for the access group type. - `salto_space_group` - `dormakaba_community_access_group`
+ `external_type_display_name` *String* + Display name that corresponds to the brand-specific terminology for the access group type. + `is_managed` *Boolean* + `name` *String* + Name of the access group. + `warnings` *List** of Objects* + Warnings associated with the `acs_access_group`. +
created_at Format: Datetime @@ -73,7 +95,9 @@ Detailed description of the warning. Provides insights into the issue and potent Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
`workspace_id` *UUID* + ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. + ## Endpoints ### [`/acs/access_groups/add_user`](./add_user.md) diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index d5877483a..895880e16 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -13,23 +13,35 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties `access_method` *Enum* + Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. +
Possible enum values: - `code` - `card` - `mobile_key`
+ `acs_credential_id` *UUID* + ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). + `acs_credential_pool_id` *UUID* + `acs_system_id` *UUID* + ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). + `acs_user_id` *UUID* + ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. + `assa_abloy_vostio_metadata` *Object* + Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). +
door_names Format: List Item format: String @@ -50,18 +62,30 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- override_guest_acs_entrance_ids Format: List Item format: String
`card_number` *String* + Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). + `code` *String* + Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). + `created_at` *Datetime* + Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. + `display_name` *String* + Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. + `ends_at` *String* + Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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` *List** of Objects* + Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). +
error_code Format: String @@ -70,7 +94,9 @@ Errors associated with the [credential](../../../capability-guides/access-system message Format: String
`external_type` *Enum* + Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. +
Possible enum values: - `pti_card` @@ -81,28 +107,50 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces - `assa_abloy_vostio_key` - `salto_space_key`
+ `external_type_display_name` *String* + Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. + `is_issued` *Boolean* + Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. + `is_latest_desired_state_synced_with_provider` *Boolean* + Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. + `is_managed` *Boolean* + `is_multi_phone_sync_credential` *Boolean* + Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). + `is_one_time_use` *Boolean* + Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. + `issued_at` *Datetime* + Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. + `latest_desired_state_synced_with_provider_at` *Datetime* + Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. + `parent_acs_credential_id` *UUID* + ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). + `starts_at` *String* + Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + `visionline_metadata` *Object* + Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). +
auto_join Format: Boolean @@ -139,9 +187,13 @@ Possible enum values: joiner_acs_credential_ids Format: List Item format: UUID
[`warnings`](./#warnings-1) *List** of Objects* + Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). + `workspace_id` *UUID* + ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). + ## Warnings ### `waiting_to_be_issued` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 5d709373d..13443a4d9 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -22,16 +22,26 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties `acs_encoder_id` *UUID* + ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. + `acs_system_id` *UUID* + ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + `created_at` *Datetime* + Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. + `display_name` *String* + Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + `errors` *List** of Objects* + Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). +
created_at Format: Datetime @@ -50,7 +60,9 @@ Unique identifier of the type of error. Enables quick recognition and categoriza Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
`workspace_id` *UUID* + ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + ## Endpoints ### [`/acs/encoders/encode_credential`](./encode_credential.md) diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index c63a614f3..bf9fc4ee9 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -50,13 +50,19 @@ Action attempt to track encoding credential data from the physical encoder onto ### Properties `action_attempt_id` *UUID* + ID of the action attempt. + `action_type` *String* + Type of action that the action attempt tracks. + `status` *Enum* +
Possible enum values: - `success` - `pending` - `error`
+ diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 266f640b3..b45ab0736 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -41,12 +41,17 @@ Reading credential data from physical encoder. ### Properties `action_attempt_id` *UUID* + ID of the action attempt. + `action_type` *String* + `status` *Enum* +
Possible enum values: - `success` - `pending` - `error`
+ diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 198a881d2..b1c4a7434 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -11,12 +11,18 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties `acs_entrance_id` *UUID* + ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + `acs_system_id` *UUID* + ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + `assa_abloy_vostio_metadata` *Object* + ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
door_name Format: String @@ -43,18 +49,26 @@ Possible enum values: stand_open Format: Boolean
`created_at` *Datetime* + Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. + `display_name` *String* + Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + `dormakaba_community_metadata` *Object* + dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
access_point_name Format: String
`errors` *List** of Objects* + Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
error_code Format: String @@ -67,8 +81,10 @@ Unique identifier of the type of error. Enables quick recognition and categoriza Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
`latch_metadata` *Object* + Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
accessibility_type Format: String @@ -85,8 +101,10 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide is_connected Format: Boolean
`salto_ks_metadata` *Object* + Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
battery_level Format: String @@ -119,8 +137,10 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu privacy_mode Format: Boolean
`salto_space_metadata` *Object* + Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
door_description Format: String @@ -133,8 +153,10 @@ Salto Space-specific metadata associated with the [entrance](../../../capability ext_door_id Format: String
`visionline_metadata` *Object* + Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
door_category Format: Enum diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index ff24179d1..667b5a269 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -13,30 +13,53 @@ For details about the resources associated with an access control system, see th ## Properties `acs_system_id` *UUID* + ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + `can_add_acs_users_to_acs_access_groups` *Boolean* + Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). + `can_automate_enrollment` *Boolean* + Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + `can_create_acs_access_groups` *Boolean* + Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). + `can_remove_acs_users_from_acs_access_groups` *Boolean* + Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). + `connected_account_id` *UUID* + ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + `connected_account_ids` *List** of UUIDs* + IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + {% hint style="warning" %} **Deprecated**. Use `connected_account_id`. {% endhint %} + `created_at` *Datetime* + Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. + `default_credential_manager_acs_system_id` *UUID* + ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + [`errors`](./#errors-1) *List** of Objects* + Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + `external_type` *Enum* + Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. +
Possible enum values: - `pti_site` @@ -53,27 +76,41 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/ - `assa_abloy_vostio` - `assa_abloy_vostio_credential_service`
+ `external_type_display_name` *String* + Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. + `image_alt_text` *String* + Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. + `image_url` *String* + URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + `is_credential_manager` *Boolean* + Indicates whether the `acs_system` is a credential manager. + `location` *Object* +
time_zone Format: String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
`name` *String* + Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + `system_type` *Enum* + {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} +
Possible enum values: - `pti_site` @@ -90,12 +127,16 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide - `assa_abloy_vostio` - `assa_abloy_vostio_credential_service`
+ `system_type_display_name` *String* + {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} + `visionline_metadata` *Object* +
lan_address Format: String @@ -114,9 +155,13 @@ Keyset loaded into a reader. Mobile keys and reader administration tools securel Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
[`warnings`](./#warnings-1) *List** of Objects* + Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + `workspace_id` *UUID* + ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + ## Errors ### `seam_bridge_disconnected` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index a993b0ba6..66db31a1c 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -13,8 +13,10 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties `access_schedule` *Object* + `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. +
ends_at Format: Datetime @@ -27,23 +29,39 @@ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
`acs_system_id` *UUID* + ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + `acs_user_id` *UUID* + ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + `created_at` *Datetime* + Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. + `display_name` *String* + Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + `email` *String* + {% hint style="warning" %} **Deprecated**. use email_address. {% endhint %} + `email_address` *String* + Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + [`errors`](./#errors-1) *List** of Objects* + Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + `external_type` *Enum* + Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. +
Possible enum values: - `pti_user` @@ -54,28 +72,51 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi - `dormakaba_community_user` - `salto_space_user`
+ `external_type_display_name` *String* + Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. + `full_name` *String* + Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + `hid_acs_system_id` *UUID* + `is_managed` *Boolean* + `is_suspended` *Boolean* + Indicates whether the [ACS 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). + `phone_number` *String* + Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). + `user_identity_email_address` *String* + Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + `user_identity_full_name` *String* + Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + `user_identity_id` *String* + ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + `user_identity_phone_number` *String* + Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). + [`warnings`](./#warnings-1) *List** of Objects* + Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + `workspace_id` *UUID* + ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + ## Errors ### `deleted_externally` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 39ca14531..6dce58548 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -9,23 +9,36 @@ Represents an app user's mobile phone. ## Properties `created_at` *Datetime* + Date and time at which the `phone` was created. + `custom_metadata` *Record* + Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. + `device_id` *UUID* + ID of the `phone`. + `device_type` *Enum* + Type of phone. +
Possible enum values: - `ios_phone` - `android_phone`
+ `display_name` *String* + Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. + `errors` *List** of Objects* + Errors associated with the `phone`. +
error_code Format: String @@ -34,10 +47,14 @@ Errors associated with the `phone`. message Format: String
`nickname` *String* + Optional nickname to describe the phone, settable through Seam. + `properties` *Object* + Properties of the phone. +
assa_abloy_credential_service_metadata Format: Object @@ -78,8 +95,10 @@ Salto Space credential service metadata for the phone. Indicates whether the credential service has an active associated phone.
`warnings` *List** of Objects* + Warnings associated with the `phone`. +
message Format: String @@ -88,7 +107,9 @@ Warnings associated with the `phone`. warning_code Format: String
`workspace_id` *UUID* + ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. + ## Endpoints ### [`/phones/deactivate`](./deactivate.md) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 79dd0acf9..238112a79 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -182,12 +182,17 @@ Activating climate preset. ### Properties `action_attempt_id` *UUID* + ID of the action attempt. + `action_type` *String* + `status` *Enum* +
Possible enum values: - `success` - `pending` - `error`
+ diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index db43a72af..c7c23e9ca 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -192,12 +192,17 @@ Setting HVAC mode. ### Properties `action_attempt_id` *UUID* + ID of the action attempt. + `action_type` *String* + `status` *Enum* +
Possible enum values: - `success` - `pending` - `error`
+ diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index b9e52c491..ddc7ed114 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -192,12 +192,17 @@ Setting HVAC mode. ### Properties `action_attempt_id` *UUID* + ID of the action attempt. + `action_type` *String* + `status` *Enum* +
Possible enum values: - `success` - `pending` - `error`
+ diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 7c10bfc3a..74e34e0b9 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -216,12 +216,17 @@ Setting HVAC mode. ### Properties `action_attempt_id` *UUID* + ID of the action attempt. + `action_type` *String* + `status` *Enum* +
Possible enum values: - `success` - `pending` - `error`
+ diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index b485fd041..9eb7f25c0 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -164,12 +164,17 @@ Setting HVAC mode. ### Properties `action_attempt_id` *UUID* + ID of the action attempt. + `action_type` *String* + `status` *Enum* +
Possible enum values: - `success` - `pending` - `error`
+ diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 4a31b3c8f..73cb53764 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -9,16 +9,26 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties `climate_preset_key` *String* + Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + `created_at` *Datetime* + Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. + `device_id` *UUID* + ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. + `ends_at` *Datetime* + Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + `errors` *List** of Objects* + Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +
error_code Format: String @@ -31,13 +41,21 @@ Unique identifier of the type of error. Enables quick recognition and categoriza Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
`max_override_period_minutes` *Number* + Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). + `name` *String* + User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + `starts_at` *Datetime* + Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + `thermostat_schedule_id` *UUID* + ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + ## Endpoints ### [`/thermostats/schedules/create`](./create.md) diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 3186c9116..7a8b4ba40 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -192,12 +192,17 @@ Setting fan mode. ### Properties `action_attempt_id` *UUID* + ID of the action attempt. + `action_type` *String* + `status` *Enum* +
Possible enum values: - `success` - `pending` - `error`
+ diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 1b33b6a9f..47eca14f7 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -230,12 +230,17 @@ Setting HVAC mode. ### Properties `action_attempt_id` *UUID* + ID of the action attempt. + `action_type` *String* + `status` *Enum* +
Possible enum values: - `success` - `pending` - `error`
+ diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 14e52dc55..9f3a6b6e4 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -9,19 +9,33 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties `created_at` *Datetime* + Date and time at which the user identity was created. + `display_name` *String* + `email_address` *String* + Unique email address for the user identity. + `full_name` *String* + `phone_number` *String* + Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). + `user_identity_id` *UUID* + ID of the user identity. + `user_identity_key` *String* + Unique key for the user identity. + `workspace_id` *UUID* + ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. + ## Endpoints ### [`/user_identities/add_acs_user`](./add_acs_user.md) diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 09e9f8beb..a285ebaa8 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -9,15 +9,25 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties `created_at` *Datetime* + Date and time at which the enrollment automation was created. + `credential_manager_acs_system_id` *UUID* + ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. + `enrollment_automation_id` *UUID* + ID of the enrollment automation. + `user_identity_id` *UUID* + ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + `workspace_id` *UUID* + ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. + ## Endpoints ### [`/user_identities/enrollment_automations/delete`](./delete.md) From fbc7b0a537c14d818e99be10f3d2734f2cfce6ed Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:23:36 -0400 Subject: [PATCH 059/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index d63cf16de..b2a85fb48 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -15,7 +15,7 @@ {{/if}} {{#each properties}} -{{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} *{{format}}*{{#if listItemFormat}}* of {{listItemFormat}}s*{{/if}} +{{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} {{#if description}} {{description}} @@ -51,4 +51,5 @@ This object has no properties. {{> property-collapsible this}} {{/each}} {{/if}} +--- {{/each}} From 9712038a2f3f3dce35437243ab17153973f63e40 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 19:24:44 +0000 Subject: [PATCH 060/233] ci: Generate docs --- docs/api/access_codes/README.md | 25 ++++++++++++-- docs/api/acs/access_groups/README.md | 16 +++++++-- docs/api/acs/credentials/README.md | 34 ++++++++++++++++--- docs/api/acs/encoders/README.md | 10 ++++-- docs/api/acs/encoders/encode_credential.md | 3 ++ docs/api/acs/encoders/scan_credential.md | 3 ++ docs/api/acs/entrances/README.md | 25 ++++++++++---- docs/api/acs/systems/README.md | 30 +++++++++++++--- docs/api/acs/users/README.md | 27 +++++++++++++-- docs/api/phones/README.md | 18 +++++++--- .../thermostats/activate_climate_preset.md | 3 ++ docs/api/thermostats/cool.md | 3 ++ docs/api/thermostats/heat.md | 3 ++ docs/api/thermostats/heat_cool.md | 3 ++ docs/api/thermostats/off.md | 3 ++ docs/api/thermostats/schedules/README.md | 13 +++++-- docs/api/thermostats/set_fan_mode.md | 3 ++ docs/api/thermostats/set_hvac_mode.md | 3 ++ docs/api/user_identities/README.md | 8 +++++ .../enrollment_automations/README.md | 5 +++ 20 files changed, 208 insertions(+), 30 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 72a062ee9..7d99377c8 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -10,74 +10,92 @@ The Access Codes route contains the following resources: Unique identifier for the access code. +--- `code` *String* Code used for access. Typically, a numeric or alphanumeric string. +--- `common_code_key` *String* Unique identifier for a group of access codes that share the same code. +--- `created_at` *Datetime* Date and time at which the access code was created. +--- `device_id` *UUID* Unique identifier for the device associated with the access code. +--- `ends_at` *Datetime* Date and time after which the time-bound access code becomes inactive. -[`errors`](./#errors-1) *List** of Objects* +--- +[`errors`](./#errors-1) *List* *of Objects* Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. +--- `is_backup` *Boolean* Indicates whether the access code is a backup code. +--- `is_backup_access_code_available` *Boolean* Indicates whether a backup access code is available for use if the primary access code is lost or compromised. +--- `is_external_modification_allowed` *Boolean* Indicates whether changes to the access code from external sources are permitted. +--- `is_managed` *Boolean* Indicates whether Seam manages the access code. +--- `is_offline_access_code` *Boolean* Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. +--- `is_one_time_use` *Boolean* Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. +--- `is_scheduled_on_device` *Boolean* Indicates whether the code is set on the device according to a preconfigured schedule. +--- `is_waiting_for_code_assignment` *Boolean* Indicates whether the access code is waiting for a code assignment. +--- `name` *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. +--- `pulled_backup_access_code_id` *UUID* Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. +--- `starts_at` *Datetime* Date and time at which the time-bound access code becomes active. +--- `status` *Enum* @@ -93,6 +111,7 @@ Date and time at which the time-bound access code becomes active. - `unknown`
+--- `type` *Enum* Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. @@ -103,10 +122,12 @@ Nature of the access code. Values are "ongoing" for access codes that are active - `ongoing` -[`warnings`](./#warnings-1) *List** of Objects* +--- +[`warnings`](./#warnings-1) *List* *of Objects* Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. +--- ## Errors ### `smartthings_failed_to_set_access_code` diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 090d9a8c6..64c16074a 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -28,26 +28,32 @@ To learn whether your access control system supports access groups, see the corr - `dormakaba_community_access_group` +--- `access_group_type_display_name` *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} +--- `acs_access_group_id` *UUID* ID of the access group. +--- `acs_system_id` *UUID* ID of the access control system that contains the access group. +--- `created_at` *Datetime* Date and time at which the access group was created. +--- `display_name` *String* +--- `external_type` *Enum* Brand-specific terminology for the access group type. @@ -62,17 +68,21 @@ Brand-specific terminology for the access group type. - `dormakaba_community_access_group` +--- `external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the access group type. +--- `is_managed` *Boolean* +--- `name` *String* Name of the access group. -`warnings` *List** of Objects* +--- +`warnings` *List* *of Objects* Warnings associated with the `acs_access_group`. @@ -94,10 +104,12 @@ Detailed description of the warning. Provides insights into the issue and potent warning_code Format: String Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. -`workspace_id` *UUID* +--- +`workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. +--- ## Endpoints ### [`/acs/access_groups/add_user`](./add_user.md) diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 895880e16..cc34468cb 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -23,20 +23,25 @@ Access method for the [credential](../../../capability-guides/access-systems/man - `mobile_key` +--- `acs_credential_id` *UUID* ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- `acs_credential_pool_id` *UUID* +--- `acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- `acs_user_id` *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. +--- `assa_abloy_vostio_metadata` *Object* Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -61,27 +66,33 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
override_guest_acs_entrance_ids Format: List Item format: String -
`card_number` *String* +--- +`card_number` *String* Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- `code` *String* Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- `created_at` *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. +--- `display_name` *String* Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. +--- `ends_at` *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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` *List** of Objects* +--- +`errors` *List* *of Objects* Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -93,7 +104,8 @@ Errors associated with the [credential](../../../capability-guides/access-system
message Format: String -
`external_type` *Enum* +--- +`external_type` *Enum* Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. @@ -108,44 +120,55 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces - `salto_space_key` +--- `external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. +--- `is_issued` *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. +--- `is_latest_desired_state_synced_with_provider` *Boolean* Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. +--- `is_managed` *Boolean* +--- `is_multi_phone_sync_credential` *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). +--- `is_one_time_use` *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. +--- `issued_at` *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. +--- `latest_desired_state_synced_with_provider_at` *Datetime* Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. +--- `parent_acs_credential_id` *UUID* ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- `starts_at` *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. +--- `visionline_metadata` *Object* Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -186,14 +209,17 @@ Possible enum values:
joiner_acs_credential_ids Format: List Item format: UUID -
[`warnings`](./#warnings-1) *List** of Objects* +--- +[`warnings`](./#warnings-1) *List* *of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- ## Warnings ### `waiting_to_be_issued` diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 13443a4d9..31838b4e2 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -25,19 +25,23 @@ To verify if your access control system requires a card encoder, see the corresp ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. +--- `acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). +--- `created_at` *Datetime* Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. +--- `display_name` *String* Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -`errors` *List** of Objects* +--- +`errors` *List* *of Objects* Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). @@ -59,10 +63,12 @@ Unique identifier of the type of error. Enables quick recognition and categoriza message Format: String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -`workspace_id` *UUID* +--- +`workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). +--- ## Endpoints ### [`/acs/encoders/encode_credential`](./encode_credential.md) diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index bf9fc4ee9..10735bf34 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -53,10 +53,12 @@ Action attempt to track encoding credential data from the physical encoder onto ID of the action attempt. +--- `action_type` *String* Type of action that the action attempt tracks. +--- `status` *Enum*
@@ -66,3 +68,4 @@ Type of action that the action attempt tracks. - `error`
+--- diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index b45ab0736..60d0f39f4 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -44,8 +44,10 @@ Reading credential data from physical encoder. ID of the action attempt. +--- `action_type` *String* +--- `status` *Enum*
@@ -55,3 +57,4 @@ ID of the action attempt. - `error`
+--- diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index b1c4a7434..b5c1f6d5a 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -14,10 +14,12 @@ In an access control system, an entrance is a secured door, gate, zone, or other ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +--- `acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +--- `assa_abloy_vostio_metadata` *Object* ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -48,14 +50,17 @@ Possible enum values:
stand_open Format: Boolean -
`created_at` *Datetime* +--- +`created_at` *Datetime* Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. +--- `display_name` *String* Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +--- `dormakaba_community_metadata` *Object* dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -64,7 +69,8 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
access_point_name Format: String -
`errors` *List** of Objects* +--- +`errors` *List* *of Objects* Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -80,7 +86,8 @@ Unique identifier of the type of error. Enables quick recognition and categoriza message Format: String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -`latch_metadata` *Object* +--- +`latch_metadata` *Object* Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -100,7 +107,8 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
is_connected Format: Boolean -
`salto_ks_metadata` *Object* +--- +`salto_ks_metadata` *Object* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -136,7 +144,8 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
privacy_mode Format: Boolean -
`salto_space_metadata` *Object* +--- +`salto_space_metadata` *Object* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -152,7 +161,8 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
ext_door_id Format: String -
`visionline_metadata` *Object* +--- +`visionline_metadata` *Object* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -186,7 +196,8 @@ Possible enum values: - `commonDoor` - `touch` -## Endpoints +--- +## Endpoints ### [`/acs/entrances/get`](./get.md) diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 667b5a269..877caa6fc 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -16,27 +16,33 @@ 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). +--- `can_add_acs_users_to_acs_access_groups` *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). +--- `can_automate_enrollment` *Boolean* Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +--- `can_create_acs_access_groups` *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). +--- `can_remove_acs_users_from_acs_access_groups` *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). +--- `connected_account_id` *UUID* ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -`connected_account_ids` *List** of UUIDs* +--- +`connected_account_ids` *List* *of UUIDs* IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -44,18 +50,22 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README **Deprecated**. Use `connected_account_id`. {% endhint %} +--- `created_at` *Datetime* Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. +--- `default_credential_manager_acs_system_id` *UUID* ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -[`errors`](./#errors-1) *List** of Objects* +--- +[`errors`](./#errors-1) *List* *of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +--- `external_type` *Enum* Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. @@ -77,22 +87,27 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/ - `assa_abloy_vostio_credential_service` +--- `external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. +--- `image_alt_text` *String* Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. +--- `image_url` *String* URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +--- `is_credential_manager` *Boolean* Indicates whether the `acs_system` is a credential manager. +--- `location` *Object* @@ -101,10 +116,12 @@ Indicates whether the `acs_system` is a credential manager. time_zone Format: String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. -`name` *String* +--- +`name` *String* Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +--- `system_type` *Enum* {% hint style="warning" %} @@ -128,12 +145,14 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide - `assa_abloy_vostio_credential_service` +--- `system_type_display_name` *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} +--- `visionline_metadata` *Object* @@ -154,14 +173,17 @@ Keyset loaded into a reader. Mobile keys and reader administration tools securel system_id Format: String Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. -[`warnings`](./#warnings-1) *List** of Objects* +--- +[`warnings`](./#warnings-1) *List* *of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +--- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +--- ## Errors ### `seam_bridge_disconnected` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 66db31a1c..c71426122 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -28,36 +28,44 @@ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org starts_at Format: Datetime Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -`acs_system_id` *UUID* +--- +`acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- `acs_user_id` *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- `created_at` *Datetime* Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. +--- `display_name` *String* Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- `email` *String* {% hint style="warning" %} **Deprecated**. use email_address. {% endhint %} +--- `email_address` *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -[`errors`](./#errors-1) *List** of Objects* +--- +[`errors`](./#errors-1) *List* *of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- `external_type` *Enum* Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. @@ -73,50 +81,63 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi - `salto_space_user` +--- `external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. +--- `full_name` *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- `hid_acs_system_id` *UUID* +--- `is_managed` *Boolean* +--- `is_suspended` *Boolean* Indicates whether the [ACS 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). +--- `phone_number` *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). +--- `user_identity_email_address` *String* Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- `user_identity_full_name` *String* Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- `user_identity_id` *String* ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- `user_identity_phone_number` *String* Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). -[`warnings`](./#warnings-1) *List** of Objects* +--- +[`warnings`](./#warnings-1) *List* *of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- ## Errors ### `deleted_externally` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 6dce58548..9a02b0a17 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -12,14 +12,17 @@ Represents an app user's mobile phone. Date and time at which the `phone` was created. +--- `custom_metadata` *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. +--- `device_id` *UUID* ID of the `phone`. +--- `device_type` *Enum* Type of phone. @@ -30,11 +33,13 @@ Type of phone. - `android_phone` +--- `display_name` *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. -`errors` *List** of Objects* +--- +`errors` *List* *of Objects* Errors associated with the `phone`. @@ -46,10 +51,12 @@ Errors associated with the `phone`.
message Format: String -
`nickname` *String* +--- +`nickname` *String* Optional nickname to describe the phone, settable through Seam. +--- `properties` *Object* Properties of the phone. @@ -94,7 +101,8 @@ Salto Space credential service metadata for the phone. salto_space_credential_service_metadata.has_active_phone Format: Boolean Indicates whether the credential service has an active associated phone. -`warnings` *List** of Objects* +--- +`warnings` *List* *of Objects* Warnings associated with the `phone`. @@ -106,10 +114,12 @@ Warnings associated with the `phone`.
warning_code Format: String -
`workspace_id` *UUID* +--- +`workspace_id` *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. +--- ## Endpoints ### [`/phones/deactivate`](./deactivate.md) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 238112a79..5071a7bda 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -185,8 +185,10 @@ Activating climate preset. ID of the action attempt. +--- `action_type` *String* +--- `status` *Enum*
@@ -196,3 +198,4 @@ ID of the action attempt. - `error`
+--- diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index c7c23e9ca..d8a0dcdae 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -195,8 +195,10 @@ Setting HVAC mode. ID of the action attempt. +--- `action_type` *String* +--- `status` *Enum*
@@ -206,3 +208,4 @@ ID of the action attempt. - `error`
+--- diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index ddc7ed114..83f86712b 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -195,8 +195,10 @@ Setting HVAC mode. ID of the action attempt. +--- `action_type` *String* +--- `status` *Enum*
@@ -206,3 +208,4 @@ ID of the action attempt. - `error`
+--- diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 74e34e0b9..477d4227a 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -219,8 +219,10 @@ Setting HVAC mode. ID of the action attempt. +--- `action_type` *String* +--- `status` *Enum*
@@ -230,3 +232,4 @@ ID of the action attempt. - `error`
+--- diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 9eb7f25c0..ff2c5471b 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -167,8 +167,10 @@ Setting HVAC mode. ID of the action attempt. +--- `action_type` *String* +--- `status` *Enum*
@@ -178,3 +180,4 @@ ID of the action attempt. - `error`
+--- diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 73cb53764..09f3cd0c7 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -12,19 +12,23 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +--- `created_at` *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. +--- `device_id` *UUID* ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. +--- `ends_at` *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -`errors` *List** of Objects* +--- +`errors` *List* *of Objects* Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). @@ -40,22 +44,27 @@ Unique identifier of the type of error. Enables quick recognition and categoriza message Format: String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -`max_override_period_minutes` *Number* +--- +`max_override_period_minutes` *Number* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). +--- `name` *String* User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +--- `starts_at` *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. +--- `thermostat_schedule_id` *UUID* ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +--- ## Endpoints ### [`/thermostats/schedules/create`](./create.md) diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 7a8b4ba40..fd1f54f50 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -195,8 +195,10 @@ Setting fan mode. ID of the action attempt. +--- `action_type` *String* +--- `status` *Enum*
@@ -206,3 +208,4 @@ ID of the action attempt. - `error`
+--- diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 47eca14f7..7aa6e5e4f 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -233,8 +233,10 @@ Setting HVAC mode. ID of the action attempt. +--- `action_type` *String* +--- `status` *Enum*
@@ -244,3 +246,4 @@ ID of the action attempt. - `error`
+--- diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 9f3a6b6e4..616e94d0c 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -12,30 +12,38 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil Date and time at which the user identity was created. +--- `display_name` *String* +--- `email_address` *String* Unique email address for the user identity. +--- `full_name` *String* +--- `phone_number` *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). +--- `user_identity_id` *UUID* ID of the user identity. +--- `user_identity_key` *String* Unique key for the user identity. +--- `workspace_id` *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. +--- ## Endpoints ### [`/user_identities/add_acs_user`](./add_acs_user.md) diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index a285ebaa8..bdce4d04e 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -12,22 +12,27 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui Date and time at which the enrollment automation was created. +--- `credential_manager_acs_system_id` *UUID* ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. +--- `enrollment_automation_id` *UUID* ID of the enrollment automation. +--- `user_identity_id` *UUID* ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +--- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. +--- ## Endpoints ### [`/user_identities/enrollment_automations/delete`](./delete.md) From 6023778c1b3180e0123e59f316fabc7eabceaf91 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:30:24 -0400 Subject: [PATCH 061/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index b2a85fb48..626e0a4f8 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -27,7 +27,9 @@ {{/if}} {{#if enumValues}}
+ Possible enum values: + {{#each enumValues}} - `{{this}}` {{/each}} From 50dd6bb180a44111540d53420d7117d6630495da Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 19:31:28 +0000 Subject: [PATCH 062/233] ci: Generate docs --- docs/api/access_codes/README.md | 4 ++++ docs/api/acs/access_groups/README.md | 4 ++++ docs/api/acs/credentials/README.md | 4 ++++ docs/api/acs/encoders/encode_credential.md | 2 ++ docs/api/acs/encoders/scan_credential.md | 2 ++ docs/api/acs/systems/README.md | 4 ++++ docs/api/acs/users/README.md | 2 ++ docs/api/phones/README.md | 2 ++ docs/api/thermostats/activate_climate_preset.md | 2 ++ docs/api/thermostats/cool.md | 2 ++ docs/api/thermostats/heat.md | 2 ++ docs/api/thermostats/heat_cool.md | 2 ++ docs/api/thermostats/off.md | 2 ++ docs/api/thermostats/set_fan_mode.md | 2 ++ docs/api/thermostats/set_hvac_mode.md | 2 ++ 15 files changed, 38 insertions(+) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 7d99377c8..a8747f5d5 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -103,7 +103,9 @@ Date and time at which the time-bound access code becomes active.
+ Possible enum values: + - `setting` - `set` - `unset` @@ -117,7 +119,9 @@ Date and time at which the time-bound access code becomes active. Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.
+ Possible enum values: + - `time_bound` - `ongoing`
diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 64c16074a..d9cf4c003 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -19,7 +19,9 @@ To learn whether your access control system supports access groups, see the corr {% endhint %}
+ Possible enum values: + - `pti_unit` - `pti_access_level` - `salto_ks_access_group` @@ -59,7 +61,9 @@ Date and time at which the access group was created. Brand-specific terminology for the access group type.
+ Possible enum values: + - `pti_unit` - `pti_access_level` - `salto_ks_access_group` diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index cc34468cb..85c5bc9aa 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -17,7 +17,9 @@ For each `acs_credential`, you define the access method. You can also specify ad Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
+ Possible enum values: + - `code` - `card` - `mobile_key` @@ -110,7 +112,9 @@ Errors associated with the [credential](../../../capability-guides/access-system Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
+ Possible enum values: + - `pti_card` - `brivo_credential` - `hid_credential` diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 10735bf34..d8d2dfaa7 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -62,7 +62,9 @@ Type of action that the action attempt tracks. `status` *Enum*
+ Possible enum values: + - `success` - `pending` - `error` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 60d0f39f4..9a8f86931 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -51,7 +51,9 @@ ID of the action attempt. `status` *Enum*
+ Possible enum values: + - `success` - `pending` - `error` diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 877caa6fc..300b9829b 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -71,7 +71,9 @@ Errors associated with the [access control system](https://docs.seam.co/latest/c Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.
+ Possible enum values: + - `pti_site` - `alta_org` - `salto_ks_site` @@ -129,7 +131,9 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide {% endhint %}
+ Possible enum values: + - `pti_site` - `alta_org` - `salto_ks_site` diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index c71426122..3708b283a 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -71,7 +71,9 @@ Errors associated with the [ACS user](https://docs.seam.co/latest/capability-gui Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.
+ Possible enum values: + - `pti_user` - `brivo_user` - `hid_credential_manager_user` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 9a02b0a17..eff284999 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -28,7 +28,9 @@ ID of the `phone`. Type of phone.
+ Possible enum values: + - `ios_phone` - `android_phone`
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 5071a7bda..287d603f2 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -192,7 +192,9 @@ ID of the action attempt. `status` *Enum*
+ Possible enum values: + - `success` - `pending` - `error` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index d8a0dcdae..9213f0c96 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -202,7 +202,9 @@ ID of the action attempt. `status` *Enum*
+ Possible enum values: + - `success` - `pending` - `error` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 83f86712b..4c67e0ba0 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -202,7 +202,9 @@ ID of the action attempt. `status` *Enum*
+ Possible enum values: + - `success` - `pending` - `error` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 477d4227a..c217bf923 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -226,7 +226,9 @@ ID of the action attempt. `status` *Enum*
+ Possible enum values: + - `success` - `pending` - `error` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index ff2c5471b..2579b5906 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -174,7 +174,9 @@ ID of the action attempt. `status` *Enum*
+ Possible enum values: + - `success` - `pending` - `error` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index fd1f54f50..c11d9c17b 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -202,7 +202,9 @@ ID of the action attempt. `status` *Enum*
+ Possible enum values: + - `success` - `pending` - `error` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 7aa6e5e4f..07bd998c5 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -240,7 +240,9 @@ ID of the action attempt. `status` *Enum*
+ Possible enum values: + - `success` - `pending` - `error` From 2fbf2d621481644f8a798b31e0a37b2961caa4bc Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:34:53 -0400 Subject: [PATCH 063/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 626e0a4f8..e111737e0 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -53,5 +53,6 @@ This object has no properties. {{> property-collapsible this}} {{/each}} {{/if}} + --- {{/each}} From 2eb000f7f7f29b1812e821668386be43fb2e7cef Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 19:36:03 +0000 Subject: [PATCH 064/233] ci: Generate docs --- docs/api/access_codes/README.md | 21 ++++++++++++ docs/api/acs/access_groups/README.md | 14 +++++++- docs/api/acs/credentials/README.md | 32 +++++++++++++++++-- docs/api/acs/encoders/README.md | 8 ++++- docs/api/acs/encoders/encode_credential.md | 3 ++ docs/api/acs/encoders/scan_credential.md | 3 ++ docs/api/acs/entrances/README.md | 25 +++++++++++---- docs/api/acs/systems/README.md | 26 +++++++++++++-- docs/api/acs/users/README.md | 23 ++++++++++++- docs/api/phones/README.md | 16 ++++++++-- .../thermostats/activate_climate_preset.md | 3 ++ docs/api/thermostats/cool.md | 3 ++ docs/api/thermostats/heat.md | 3 ++ docs/api/thermostats/heat_cool.md | 3 ++ docs/api/thermostats/off.md | 3 ++ docs/api/thermostats/schedules/README.md | 11 ++++++- docs/api/thermostats/set_fan_mode.md | 3 ++ docs/api/thermostats/set_hvac_mode.md | 3 ++ docs/api/user_identities/README.md | 8 +++++ .../enrollment_automations/README.md | 5 +++ 20 files changed, 197 insertions(+), 19 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index a8747f5d5..64ebd523e 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -10,91 +10,109 @@ The Access Codes route contains the following resources: Unique identifier for the access code. + --- `code` *String* Code used for access. Typically, a numeric or alphanumeric string. + --- `common_code_key` *String* Unique identifier for a group of access codes that share the same code. + --- `created_at` *Datetime* Date and time at which the access code was created. + --- `device_id` *UUID* Unique identifier for the device associated with the access code. + --- `ends_at` *Datetime* Date and time after which the time-bound access code becomes inactive. + --- [`errors`](./#errors-1) *List* *of Objects* Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. + --- `is_backup` *Boolean* Indicates whether the access code is a backup code. + --- `is_backup_access_code_available` *Boolean* Indicates whether a backup access code is available for use if the primary access code is lost or compromised. + --- `is_external_modification_allowed` *Boolean* Indicates whether changes to the access code from external sources are permitted. + --- `is_managed` *Boolean* Indicates whether Seam manages the access code. + --- `is_offline_access_code` *Boolean* Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. + --- `is_one_time_use` *Boolean* Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. + --- `is_scheduled_on_device` *Boolean* Indicates whether the code is set on the device according to a preconfigured schedule. + --- `is_waiting_for_code_assignment` *Boolean* Indicates whether the access code is waiting for a code assignment. + --- `name` *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + --- `pulled_backup_access_code_id` *UUID* Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. + --- `starts_at` *Datetime* Date and time at which the time-bound access code becomes active. + --- `status` *Enum* @@ -113,6 +131,7 @@ Date and time at which the time-bound access code becomes active. - `unknown`
+ --- `type` *Enum* @@ -126,11 +145,13 @@ Nature of the access code. Values are "ongoing" for access codes that are active - `ongoing`
+ --- [`warnings`](./#warnings-1) *List* *of Objects* Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. + --- ## Errors diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index d9cf4c003..179576388 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -30,6 +30,7 @@ To learn whether your access control system supports access groups, see the corr - `dormakaba_community_access_group`
+ --- `access_group_type_display_name` *String* @@ -37,24 +38,29 @@ To learn whether your access control system supports access groups, see the corr **Deprecated**. Use `external_type_display_name`. {% endhint %} + --- `acs_access_group_id` *UUID* ID of the access group. + --- `acs_system_id` *UUID* ID of the access control system that contains the access group. + --- `created_at` *Datetime* Date and time at which the access group was created. + --- `display_name` *String* + --- `external_type` *Enum* @@ -72,19 +78,23 @@ Brand-specific terminology for the access group type. - `dormakaba_community_access_group`
+ --- `external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the access group type. + --- `is_managed` *Boolean* + --- `name` *String* Name of the access group. + --- `warnings` *List* *of Objects* @@ -108,11 +118,13 @@ Detailed description of the warning. Provides insights into the issue and potent warning_code Format: String Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. -
--- +
+--- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. + --- ## Endpoints diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 85c5bc9aa..251910709 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -25,24 +25,29 @@ Access method for the [credential](../../../capability-guides/access-systems/man - `mobile_key`
+ --- `acs_credential_id` *UUID* ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). + --- `acs_credential_pool_id` *UUID* + --- `acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). + --- `acs_user_id` *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. + --- `assa_abloy_vostio_metadata` *Object* @@ -68,31 +73,37 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
override_guest_acs_entrance_ids Format: List Item format: String -
--- +
+--- `card_number` *String* Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). + --- `code` *String* Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). + --- `created_at` *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. + --- `display_name` *String* Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. + --- `ends_at` *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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` *List* *of Objects* @@ -106,7 +117,8 @@ Errors associated with the [credential](../../../capability-guides/access-system
message Format: String -
--- +
+--- `external_type` *Enum* Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. @@ -124,54 +136,65 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces - `salto_space_key`
+ --- `external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. + --- `is_issued` *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. + --- `is_latest_desired_state_synced_with_provider` *Boolean* Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. + --- `is_managed` *Boolean* + --- `is_multi_phone_sync_credential` *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). + --- `is_one_time_use` *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. + --- `issued_at` *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. + --- `latest_desired_state_synced_with_provider_at` *Datetime* Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. + --- `parent_acs_credential_id` *UUID* ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). + --- `starts_at` *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + --- `visionline_metadata` *Object* @@ -213,16 +236,19 @@ Possible enum values:
joiner_acs_credential_ids Format: List Item format: UUID -
--- +
+--- [`warnings`](./#warnings-1) *List* *of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). + --- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). + --- ## Warnings diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 31838b4e2..b872216f0 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -25,21 +25,25 @@ To verify if your access control system requires a card encoder, see the corresp ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. + --- `acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + --- `created_at` *Datetime* Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. + --- `display_name` *String* Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + --- `errors` *List* *of Objects* @@ -63,11 +67,13 @@ Unique identifier of the type of error. Enables quick recognition and categoriza message Format: String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
--- +
+--- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + --- ## Endpoints diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index d8d2dfaa7..de4fc1177 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -53,11 +53,13 @@ Action attempt to track encoding credential data from the physical encoder onto ID of the action attempt. + --- `action_type` *String* Type of action that the action attempt tracks. + --- `status` *Enum* @@ -70,4 +72,5 @@ Type of action that the action attempt tracks. - `error`
+ --- diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 9a8f86931..6279bb4cd 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -44,9 +44,11 @@ Reading credential data from physical encoder. ID of the action attempt. + --- `action_type` *String* + --- `status` *Enum* @@ -59,4 +61,5 @@ ID of the action attempt. - `error`
+ --- diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index b5c1f6d5a..2a8d18e65 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -14,11 +14,13 @@ In an access control system, an entrance is a secured door, gate, zone, or other ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + --- `acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + --- `assa_abloy_vostio_metadata` *Object* @@ -50,16 +52,19 @@ Possible enum values:
stand_open Format: Boolean -
--- +
+--- `created_at` *Datetime* Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. + --- `display_name` *String* Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + --- `dormakaba_community_metadata` *Object* @@ -69,7 +74,8 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
access_point_name Format: String -
--- +
+--- `errors` *List* *of Objects* Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -86,7 +92,8 @@ Unique identifier of the type of error. Enables quick recognition and categoriza message Format: String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
--- + +--- `latch_metadata` *Object* Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -107,7 +114,8 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
is_connected Format: Boolean -
--- + +--- `salto_ks_metadata` *Object* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -144,7 +152,8 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
privacy_mode Format: Boolean -
--- + +--- `salto_space_metadata` *Object* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -161,7 +170,8 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
ext_door_id Format: String -
--- + +--- `visionline_metadata` *Object* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -196,7 +206,8 @@ Possible enum values: - `commonDoor` - `touch` ---- + +--- ## Endpoints ### [`/acs/entrances/get`](./get.md) diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 300b9829b..262f70277 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -16,31 +16,37 @@ 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). + --- `can_add_acs_users_to_acs_access_groups` *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). + --- `can_automate_enrollment` *Boolean* Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + --- `can_create_acs_access_groups` *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). + --- `can_remove_acs_users_from_acs_access_groups` *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). + --- `connected_account_id` *UUID* ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + --- `connected_account_ids` *List* *of UUIDs* @@ -50,21 +56,25 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README **Deprecated**. Use `connected_account_id`. {% endhint %} + --- `created_at` *Datetime* Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. + --- `default_credential_manager_acs_system_id` *UUID* ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + --- [`errors`](./#errors-1) *List* *of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + --- `external_type` *Enum* @@ -89,26 +99,31 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/ - `assa_abloy_vostio_credential_service` + --- `external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. + --- `image_alt_text` *String* Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. + --- `image_url` *String* URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + --- `is_credential_manager` *Boolean* Indicates whether the `acs_system` is a credential manager. + --- `location` *Object* @@ -118,11 +133,13 @@ Indicates whether the `acs_system` is a credential manager. time_zone Format: String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. ---- + +--- `name` *String* Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + --- `system_type` *Enum* @@ -149,6 +166,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide - `assa_abloy_vostio_credential_service` + --- `system_type_display_name` *String* @@ -156,6 +174,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide **Deprecated**. Use `external_type_display_name`. {% endhint %} + --- `visionline_metadata` *Object* @@ -177,16 +196,19 @@ Keyset loaded into a reader. Mobile keys and reader administration tools securel system_id Format: String Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. ---- + +--- [`warnings`](./#warnings-1) *List* *of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + --- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + --- ## Errors diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 3708b283a..172a87adc 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -28,26 +28,31 @@ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org starts_at Format: Datetime Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. ---- + +--- `acs_system_id` *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- `acs_user_id` *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- `created_at` *Datetime* Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. + --- `display_name` *String* Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- `email` *String* @@ -55,16 +60,19 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac **Deprecated**. use email_address. {% endhint %} + --- `email_address` *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- [`errors`](./#errors-1) *List* *of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- `external_type` *Enum* @@ -83,62 +91,75 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi - `salto_space_user` + --- `external_type_display_name` *String* Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. + --- `full_name` *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- `hid_acs_system_id` *UUID* + --- `is_managed` *Boolean* + --- `is_suspended` *Boolean* Indicates whether the [ACS 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). + --- `phone_number` *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). + --- `user_identity_email_address` *String* Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- `user_identity_full_name` *String* Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- `user_identity_id` *String* ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- `user_identity_phone_number` *String* Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). + --- [`warnings`](./#warnings-1) *List* *of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- ## Errors diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index eff284999..5b3838e5e 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -12,16 +12,19 @@ Represents an app user's mobile phone. Date and time at which the `phone` was created. + --- `custom_metadata` *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. + --- `device_id` *UUID* ID of the `phone`. + --- `device_type` *Enum* @@ -35,11 +38,13 @@ Type of phone. - `android_phone` + --- `display_name` *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. + --- `errors` *List* *of Objects* @@ -53,11 +58,13 @@ Errors associated with the `phone`.
message Format: String -
--- + +--- `nickname` *String* Optional nickname to describe the phone, settable through Seam. + --- `properties` *Object* @@ -103,7 +110,8 @@ Salto Space credential service metadata for the phone. salto_space_credential_service_metadata.has_active_phone Format: Boolean Indicates whether the credential service has an active associated phone. ---- + +--- `warnings` *List* *of Objects* Warnings associated with the `phone`. @@ -116,11 +124,13 @@ Warnings associated with the `phone`.
warning_code Format: String -
--- + +--- `workspace_id` *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. + --- ## Endpoints diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 287d603f2..1f790053f 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -185,9 +185,11 @@ Activating climate preset. ID of the action attempt. + --- `action_type` *String* + --- `status` *Enum* @@ -200,4 +202,5 @@ ID of the action attempt. - `error` + --- diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 9213f0c96..09f1e508e 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -195,9 +195,11 @@ Setting HVAC mode. ID of the action attempt. + --- `action_type` *String* + --- `status` *Enum* @@ -210,4 +212,5 @@ ID of the action attempt. - `error` + --- diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 4c67e0ba0..4bf884280 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -195,9 +195,11 @@ Setting HVAC mode. ID of the action attempt. + --- `action_type` *String* + --- `status` *Enum* @@ -210,4 +212,5 @@ ID of the action attempt. - `error` + --- diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index c217bf923..df0956801 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -219,9 +219,11 @@ Setting HVAC mode. ID of the action attempt. + --- `action_type` *String* + --- `status` *Enum* @@ -234,4 +236,5 @@ ID of the action attempt. - `error` + --- diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 2579b5906..425ee1b5c 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -167,9 +167,11 @@ Setting HVAC mode. ID of the action attempt. + --- `action_type` *String* + --- `status` *Enum* @@ -182,4 +184,5 @@ ID of the action attempt. - `error` + --- diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 09f3cd0c7..1ec6f31f3 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -12,21 +12,25 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + --- `created_at` *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. + --- `device_id` *UUID* ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. + --- `ends_at` *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + --- `errors` *List* *of Objects* @@ -44,26 +48,31 @@ Unique identifier of the type of error. Enables quick recognition and categoriza message Format: String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. ---- + +--- `max_override_period_minutes` *Number* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). + --- `name` *String* User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + --- `starts_at` *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + --- `thermostat_schedule_id` *UUID* ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + --- ## Endpoints diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index c11d9c17b..8d07eb3c9 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -195,9 +195,11 @@ Setting fan mode. ID of the action attempt. + --- `action_type` *String* + --- `status` *Enum* @@ -210,4 +212,5 @@ ID of the action attempt. - `error` + --- diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 07bd998c5..906c65ac5 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -233,9 +233,11 @@ Setting HVAC mode. ID of the action attempt. + --- `action_type` *String* + --- `status` *Enum* @@ -248,4 +250,5 @@ ID of the action attempt. - `error` + --- diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 616e94d0c..0af69a43d 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -12,37 +12,45 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil Date and time at which the user identity was created. + --- `display_name` *String* + --- `email_address` *String* Unique email address for the user identity. + --- `full_name` *String* + --- `phone_number` *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). + --- `user_identity_id` *UUID* ID of the user identity. + --- `user_identity_key` *String* Unique key for the user identity. + --- `workspace_id` *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. + --- ## Endpoints diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index bdce4d04e..1d19d4a6c 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -12,26 +12,31 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui Date and time at which the enrollment automation was created. + --- `credential_manager_acs_system_id` *UUID* ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. + --- `enrollment_automation_id` *UUID* ID of the enrollment automation. + --- `user_identity_id` *UUID* ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + --- `workspace_id` *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. + --- ## Endpoints From 3ea7031f0fdcc6d5903b3e81d9024bfc6c49872b Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:36:29 -0400 Subject: [PATCH 065/233] Update property-collapsible.hbs --- src/layouts/partials/property-collapsible.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs index 7db38f980..6f1830f4d 100644 --- a/src/layouts/partials/property-collapsible.hbs +++ b/src/layouts/partials/property-collapsible.hbs @@ -1,5 +1,5 @@
-{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}} +{{name}} {{format}}{{#if listItemFormat}} {{listItemFormat}}{{/if}} {{> property-content}} -
\ No newline at end of file + From bb97b28425c5742bd3a181eec6389454a50cc80f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 19:37:27 +0000 Subject: [PATCH 066/233] ci: Generate docs --- docs/api/access_codes/README.md | 420 ++++++++++++------ docs/api/acs/access_groups/README.md | 33 +- docs/api/acs/credentials/README.md | 117 +++-- docs/api/acs/encoders/README.md | 57 ++- docs/api/acs/entrances/README.md | 126 ++++-- docs/api/acs/systems/README.md | 75 ++-- docs/api/acs/users/README.md | 30 +- docs/api/phones/README.md | 45 +- docs/api/thermostats/schedules/README.md | 6 +- .../enrollment_automations/README.md | 18 +- 10 files changed, 618 insertions(+), 309 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 64ebd523e..9d3443e90 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -470,50 +470,58 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.changed` @@ -522,50 +530,58 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.scheduled_on_device` @@ -574,56 +590,65 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-code Format: String +code String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.set_on_device` @@ -632,56 +657,65 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-code Format: String +code String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.removed_from_device` @@ -690,50 +724,58 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.delay_in_setting_on_device` @@ -742,50 +784,58 @@ There was an unusually long delay in setting an [access code](https://docs.seam.
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.failed_to_set_on_device` @@ -794,50 +844,58 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.deleted` @@ -846,56 +904,65 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-code Format: String +code String Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.delay_in_removing_from_device` @@ -904,50 +971,58 @@ There was an unusually long delay in removing an [access code](https://docs.seam
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.failed_to_remove_from_device` @@ -956,50 +1031,58 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.modified_external_to_seam` @@ -1008,50 +1091,58 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.deleted_external_to_seam` @@ -1060,50 +1151,58 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.backup_access_code_pulled` @@ -1112,54 +1211,63 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks
-access_code_id Format: 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 Format: String +backup_access_code_id String
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.unmanaged.converted_to_managed` @@ -1168,50 +1276,58 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.unmanaged.failed_to_convert_to_managed` @@ -1220,50 +1336,58 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.unmanaged.created` @@ -1272,50 +1396,58 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- ### `access_code.unmanaged.removed` @@ -1324,49 +1456,57 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-access_code_id Format: UUID +access_code_id UUID ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: 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 179576388..18622cfe6 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -103,22 +103,25 @@ Warnings associated with the `acs_access_group`.
-created_at Format: Datetime +created_at Datetime Date and time at which Seam created the warning.
+
-message Format: String +message String Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
+
-warning_code Format: String +warning_code String Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
+ --- `workspace_id` *UUID* @@ -157,47 +160,55 @@ An ACS access group was deleted.
-acs_access_group_id Format: UUID +acs_access_group_id UUID
+
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: 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 251910709..9c0a95be9 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -56,24 +56,29 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
-door_names Format: List Item format: String +door_names List String
+
-endpoint_id Format: String +endpoint_id String
+
-key_id Format: String +key_id String
+
-key_issuing_request_id Format: String +key_issuing_request_id String
+
-override_guest_acs_entrance_ids Format: List Item format: String +override_guest_acs_entrance_ids List String
+ --- `card_number` *String* @@ -112,12 +117,14 @@ Errors associated with the [credential](../../../capability-guides/access-system
-error_code Format: String +error_code String
+
-message Format: String +message String
+ --- `external_type` *Enum* @@ -203,40 +210,48 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
-auto_join Format: Boolean +auto_join Boolean
+
-card_function_type Format: Enum +card_function_type Enum Possible enum values: - `guest` - `staff`
+
-card_id Format: String +card_id String
+
-common_acs_entrance_ids Format: List Item format: UUID +common_acs_entrance_ids List UUID
+
-credential_id Format: String +credential_id String
+
-guest_acs_entrance_ids Format: List Item format: UUID +guest_acs_entrance_ids List UUID
+
-is_valid Format: Boolean +is_valid Boolean
+
-joiner_acs_credential_ids Format: List Item format: UUID +joiner_acs_credential_ids List UUID
+ --- [`warnings`](./#warnings-1) *List* *of Objects* @@ -325,48 +340,56 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-acs_credential_id Format: UUID +acs_credential_id UUID
+
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md).
+ --- ### `acs_credential.issued` @@ -375,48 +398,56 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-acs_credential_id Format: UUID +acs_credential_id UUID
+
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md).
+ --- ### `acs_credential.reissued` @@ -425,47 +456,55 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-acs_credential_id Format: UUID +acs_credential_id UUID
+
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: 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 b872216f0..7c0ab28ba 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -52,22 +52,25 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
-created_at Format: Datetime +created_at Datetime Date and time at which Seam created the error.
+
-error_code Format: String +error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
-message Format: String +message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+ --- `workspace_id` *UUID* @@ -97,50 +100,58 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
-acs_encoder_id Format: 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 Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md).
+ --- ### `acs_encoder.removed` @@ -149,49 +160,57 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
-acs_encoder_id Format: 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 Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: 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 2a8d18e65..b4582b50a 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -29,15 +29,17 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
-door_name Format: String +door_name String
+
-door_number Format: Number +door_number Number
+
-door_type Format: Enum +door_type Enum Possible enum values: - `CommonDoor` @@ -45,14 +47,17 @@ Possible enum values: - `GuestDoor` - `Elevator`
+
-pms_id Format: String +pms_id String
+
-stand_open Format: Boolean +stand_open Boolean
+ --- `created_at` *Datetime* @@ -73,8 +78,9 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
-access_point_name Format: String +access_point_name String
+ --- `errors` *List* *of Objects* @@ -83,16 +89,18 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
-error_code Format: String +error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
-message Format: String +message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+ --- `latch_metadata` *Object* @@ -101,20 +109,24 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
-accessibility_type Format: String +accessibility_type String
+
-door_name Format: String +door_name String
+
-door_type Format: String +door_type String
+
-is_connected Format: Boolean +is_connected Boolean
+ --- `salto_ks_metadata` *Object* @@ -123,36 +135,44 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
-battery_level Format: String +battery_level String
+
-door_name Format: String +door_name String
+
-intrusion_alarm Format: Boolean +intrusion_alarm Boolean
+
-left_open_alarm Format: Boolean +left_open_alarm Boolean
+
-lock_type Format: String +lock_type String
+
-locked_state Format: String +locked_state String
+
-online Format: Boolean +online Boolean
+
-privacy_mode Format: Boolean +privacy_mode Boolean
+ --- `salto_space_metadata` *Object* @@ -161,16 +181,19 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
-door_description Format: String +door_description String
+
-door_name Format: String +door_name String
+
-ext_door_id Format: String +ext_door_id String
+ --- `visionline_metadata` *Object* @@ -179,7 +202,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
-door_category Format: Enum +door_category Enum Possible enum values: - `entrance` @@ -188,13 +211,15 @@ Possible enum values: - `common` - `common (PMS)`
+
-door_name Format: String +door_name String
+
-profiles Format: List Item format: Object +profiles List Object - visionline_door_profile_id Format: String @@ -207,6 +232,7 @@ Possible enum values: - `touch`
+ --- ## Endpoints @@ -233,48 +259,56 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
-acs_entrance_id Format: UUID +acs_entrance_id UUID
+
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md).
+ --- ### `acs_entrance.removed` @@ -283,47 +317,55 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
-acs_entrance_id Format: UUID +acs_entrance_id UUID
+
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: 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 262f70277..07bd9252f 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -130,10 +130,11 @@ Indicates whether the `acs_system` is a credential manager.
-time_zone Format: String +time_zone String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
+ --- `name` *String* @@ -181,22 +182,25 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
-lan_address Format: String +lan_address String IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
+
-mobile_access_uuid Format: String +mobile_access_uuid String Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
+
-system_id Format: String +system_id String Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
+ --- [`warnings`](./#warnings-1) *List* *of Objects* @@ -289,44 +293,51 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md).
+ --- ### `acs_system.added` @@ -335,44 +346,51 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md).
+ --- ### `acs_system.disconnected` @@ -381,43 +399,50 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: 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 172a87adc..76363c7a0 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -19,16 +19,18 @@ For details about how to configure `acs_user`s in your access control system, se
-ends_at Format: Datetime +ends_at Datetime 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.
+
-starts_at Format: Datetime +starts_at Datetime Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ --- `acs_system_id` *UUID* @@ -259,47 +261,55 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
-acs_system_id Format: UUID +acs_system_id UUID ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
+
-acs_user_id Format: UUID +acs_user_id UUID
+
-connected_account_id Format: UUID +connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
+
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: 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 5b3838e5e..c51465fb5 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -53,12 +53,14 @@ Errors associated with the `phone`.
-error_code Format: String +error_code String
+
-message Format: String +message String
+ --- `nickname` *String* @@ -73,13 +75,14 @@ Properties of the phone.
-assa_abloy_credential_service_metadata Format: Object +assa_abloy_credential_service_metadata Object ASSA ABLOY Credential Service metadata for the phone.
+
-assa_abloy_credential_service_metadata.endpoints Format: List Item format: Object +assa_abloy_credential_service_metadata.endpoints List Object Endpoints associated with the phone. @@ -93,24 +96,28 @@ Endpoints associated with the phone. Indicated whether the endpoint is active.
+
-assa_abloy_credential_service_metadata.has_active_endpoint Format: Boolean +assa_abloy_credential_service_metadata.has_active_endpoint Boolean Indicates whether the credential service has active endpoints associated with the phone.
+
-salto_space_credential_service_metadata Format: Object +salto_space_credential_service_metadata Object Salto Space credential service metadata for the phone.
+
-salto_space_credential_service_metadata.has_active_phone Format: Boolean +salto_space_credential_service_metadata.has_active_phone Boolean Indicates whether the credential service has an active associated phone.
+ --- `warnings` *List* *of Objects* @@ -119,12 +126,14 @@ Warnings associated with the `phone`.
-message Format: String +message String
+
-warning_code Format: String +warning_code String
+ --- `workspace_id` *UUID* @@ -154,37 +163,43 @@ A phone device was deactivated.
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-device_id Format: UUID +device_id UUID ID of the [device](../../core-concepts/devices/README.md).
+
-event_id Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md).
+ --- diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 1ec6f31f3..3b91fd5a4 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -39,16 +39,18 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
-error_code Format: String +error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+
-message Format: String +message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+ --- `max_override_period_minutes` *Number* diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 1d19d4a6c..a6fddf7c0 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -63,37 +63,43 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
-created_at Format: Datetime +created_at Datetime Date and time at which the event was created.
+
-enrollment_automation_id Format: 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 Format: UUID +event_id UUID ID of the event.
+
-event_type Format: String +event_type String
+
-occurred_at Format: Datetime +occurred_at Datetime Date and time at which the event occurred.
+
-workspace_id Format: UUID +workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md).
+ --- From 18d74361d9941d12751c1fbbcb66b9d6e418c8ca Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:38:22 -0400 Subject: [PATCH 067/233] Update property-nested-internal.hbs --- .../partials/property-nested-internal.hbs | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/src/layouts/partials/property-nested-internal.hbs b/src/layouts/partials/property-nested-internal.hbs index 4b59f0076..7e985636a 100644 --- a/src/layouts/partials/property-nested-internal.hbs +++ b/src/layouts/partials/property-nested-internal.hbs @@ -1,15 +1,21 @@ +{{#if description}} + + {{description}} +{{/if}} {{#if isDeprecated}} {{> deprecated-warning}} {{/if}} -{{#if description}} - {{description}} -{{/if}} {{#if enumValues}} - Possible enum values: +
+ +Possible enum values: + {{#each enumValues}} - `{{this}}` {{/each}} -{{/if}} \ No newline at end of file +
+ +{{/if}} From ee5e881db8b64c646c812177924c3307942cf0fc Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:39:08 -0400 Subject: [PATCH 068/233] Update property-nested.hbs --- src/layouts/partials/property-nested.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs index 92689d8b6..b254d940a 100644 --- a/src/layouts/partials/property-nested.hbs +++ b/src/layouts/partials/property-nested.hbs @@ -1,8 +1,8 @@ -{{name}} Format: {{format}}{{#if listItemFormat}} Item format: {{listItemFormat}}{{/if}} +{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{> property-nested-internal}} {{#if listProperties}} {{#each listProperties}} - {{> property-nested this}} {{/each}} -{{/if}} \ No newline at end of file +{{/if}} From a6a323dec68987ab175a377716fbfd123f51b9ec Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:39:25 -0400 Subject: [PATCH 069/233] Update property-collapsible.hbs --- src/layouts/partials/property-collapsible.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs index 6f1830f4d..eb61cb83e 100644 --- a/src/layouts/partials/property-collapsible.hbs +++ b/src/layouts/partials/property-collapsible.hbs @@ -1,5 +1,5 @@
-{{name}} {{format}}{{#if listItemFormat}} {{listItemFormat}}{{/if}} +{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{> property-content}}
From d501737e7bb0a47c478eeb1bffbe3b3bae153f25 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:40:26 -0400 Subject: [PATCH 070/233] Update property-content.hbs --- src/layouts/partials/property-content.hbs | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs index 07866a381..aa3ab81a3 100644 --- a/src/layouts/partials/property-content.hbs +++ b/src/layouts/partials/property-content.hbs @@ -1,21 +1,25 @@ -{{#if isDeprecated}} - -{{> deprecated-warning}} -{{/if}} {{#if description}} {{description}} {{/if}} +{{#if isDeprecated}} + +{{> deprecated-warning}} +{{/if}} {{#if enumValues}} +
+ +Possible enum values: -Possible enum values: {{#each enumValues}} - `{{this}}` {{/each}} +
+ {{/if}} {{#if listProperties}} {{#each listProperties}} - {{> property-nested this}} {{/each}} -{{/if}} \ No newline at end of file +{{/if}} From fa6f082fdade2a16e22f380834867714082f22e0 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 19:41:30 +0000 Subject: [PATCH 071/233] ci: Generate docs --- docs/api/acs/credentials/README.md | 16 ++++++++++------ docs/api/acs/entrances/README.md | 27 +++++++++++++++++++++------ docs/api/phones/README.md | 8 +++++--- 3 files changed, 36 insertions(+), 15 deletions(-) diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 9c0a95be9..fc356ae23 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -56,7 +56,7 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
-door_names List String +door_names List of Strings
@@ -76,7 +76,7 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
-override_guest_acs_entrance_ids List String +override_guest_acs_entrance_ids List of Strings
--- @@ -216,12 +216,16 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
card_function_type Enum +
+ +Possible enum values: -Possible enum values: - `guest` - `staff`
+
+
card_id String @@ -229,7 +233,7 @@ Possible enum values:
-common_acs_entrance_ids List UUID +common_acs_entrance_ids List of UUIDs
@@ -239,7 +243,7 @@ Possible enum values:
-guest_acs_entrance_ids List UUID +guest_acs_entrance_ids List of UUIDs
@@ -249,7 +253,7 @@ Possible enum values:
-joiner_acs_credential_ids List UUID +joiner_acs_credential_ids List of UUIDs
--- diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index b4582b50a..88fa9d5fd 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -40,14 +40,18 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
door_type Enum +
+ +Possible enum values: -Possible enum values: - `CommonDoor` - `EntranceDoor` - `GuestDoor` - `Elevator`
+
+
pms_id String @@ -203,8 +207,10 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
door_category Enum +
+ +Possible enum values: -Possible enum values: - `entrance` - `guest` - `elevator reader` @@ -212,6 +218,8 @@ Possible enum values: - `common (PMS)`
+
+
door_name String @@ -219,17 +227,24 @@ Possible enum values:
-profiles List Object +profiles List of Objects -- visionline_door_profile_id Format: String +- visionline_door_profile_id String -- visionline_door_profile_type Format: Enum - Possible enum values: +- visionline_door_profile_type Enum + + +
+ +Possible enum values: + - `BLE` - `commonDoor` - `touch` +
+
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index c51465fb5..4ec5f6146 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -82,19 +82,21 @@ ASSA ABLOY Credential Service metadata for the phone.
-assa_abloy_credential_service_metadata.endpoints List Object +assa_abloy_credential_service_metadata.endpoints List of Objects Endpoints associated with the phone. -- endpoint_id Format: String +- endpoint_id String ID of the associated endpoint. -- is_active Format: Boolean + +- is_active Boolean Indicated whether the endpoint is active. +
From c21cf01e7e849e2663d8a5ecd9a986ac61cd376e Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:48:29 -0400 Subject: [PATCH 072/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index e111737e0..e0adbb774 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -15,7 +15,7 @@ {{/if}} {{#each properties}} -{{#if linkTarget}}[`{{name}}`]({{linkTarget}}){{else}}`{{name}}`{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} +{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} {{#if description}} {{description}} From c074fa34a85f33918aa82264d16362fd3e2eb6fd Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:48:52 -0400 Subject: [PATCH 073/233] Update property-collapsible.hbs --- src/layouts/partials/property-collapsible.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs index eb61cb83e..fe95305b1 100644 --- a/src/layouts/partials/property-collapsible.hbs +++ b/src/layouts/partials/property-collapsible.hbs @@ -1,5 +1,5 @@
-{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} +**{{name}}** {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{> property-content}}
From d86798d9997c48cf44521c4329ba6dc9cdf1ca04 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:49:27 -0400 Subject: [PATCH 074/233] Update property-nested.hbs --- src/layouts/partials/property-nested.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs index b254d940a..c9f0e4479 100644 --- a/src/layouts/partials/property-nested.hbs +++ b/src/layouts/partials/property-nested.hbs @@ -1,4 +1,4 @@ -{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} +{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{> property-nested-internal}} {{#if listProperties}} {{#each listProperties}} From 15ea26bfef03ee608209dc0a4bb17d92bfeb5b89 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Fri, 28 Mar 2025 15:49:58 -0400 Subject: [PATCH 075/233] Update property-collapsible.hbs --- src/layouts/partials/property-collapsible.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs index fe95305b1..d0b792b12 100644 --- a/src/layouts/partials/property-collapsible.hbs +++ b/src/layouts/partials/property-collapsible.hbs @@ -1,5 +1,5 @@
-**{{name}}** {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} +{{name}}** {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{> property-content}}
From 52c4028dddb270476df90f59ecee7f9a46d0668b Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Fri, 28 Mar 2025 19:51:03 +0000 Subject: [PATCH 076/233] ci: Generate docs --- docs/api/access_codes/README.md | 322 +++++++++--------- docs/api/acs/access_groups/README.md | 46 +-- docs/api/acs/credentials/README.md | 130 +++---- docs/api/acs/encoders/README.md | 50 +-- docs/api/acs/encoders/encode_credential.md | 6 +- docs/api/acs/encoders/scan_credential.md | 6 +- docs/api/acs/entrances/README.md | 110 +++--- docs/api/acs/systems/README.md | 94 ++--- docs/api/acs/users/README.md | 62 ++-- docs/api/phones/README.md | 54 +-- .../thermostats/activate_climate_preset.md | 6 +- docs/api/thermostats/cool.md | 6 +- docs/api/thermostats/heat.md | 6 +- docs/api/thermostats/heat_cool.md | 6 +- docs/api/thermostats/off.md | 6 +- docs/api/thermostats/schedules/README.md | 22 +- docs/api/thermostats/set_fan_mode.md | 6 +- docs/api/thermostats/set_hvac_mode.md | 6 +- docs/api/user_identities/README.md | 16 +- .../enrollment_automations/README.md | 22 +- 20 files changed, 491 insertions(+), 491 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 9d3443e90..40188cd8f 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -6,115 +6,115 @@ The Access Codes route contains the following resources: ## Properties -`access_code_id` *UUID* +**`access_code_id`** *UUID* Unique identifier for the access code. --- -`code` *String* +**`code`** *String* Code used for access. Typically, a numeric or alphanumeric string. --- -`common_code_key` *String* +**`common_code_key`** *String* Unique identifier for a group of access codes that share the same code. --- -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the access code was created. --- -`device_id` *UUID* +**`device_id`** *UUID* Unique identifier for the device associated with the access code. --- -`ends_at` *Datetime* +**`ends_at`** *Datetime* Date and time after which the time-bound access code becomes inactive. --- -[`errors`](./#errors-1) *List* *of Objects* +[**`errors`**](./#errors-1) *List* *of Objects* Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. --- -`is_backup` *Boolean* +**`is_backup`** *Boolean* Indicates whether the access code is a backup code. --- -`is_backup_access_code_available` *Boolean* +**`is_backup_access_code_available`** *Boolean* Indicates whether a backup access code is available for use if the primary access code is lost or compromised. --- -`is_external_modification_allowed` *Boolean* +**`is_external_modification_allowed`** *Boolean* Indicates whether changes to the access code from external sources are permitted. --- -`is_managed` *Boolean* +**`is_managed`** *Boolean* Indicates whether Seam manages the access code. --- -`is_offline_access_code` *Boolean* +**`is_offline_access_code`** *Boolean* Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. --- -`is_one_time_use` *Boolean* +**`is_one_time_use`** *Boolean* Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. --- -`is_scheduled_on_device` *Boolean* +**`is_scheduled_on_device`** *Boolean* Indicates whether the code is set on the device according to a preconfigured schedule. --- -`is_waiting_for_code_assignment` *Boolean* +**`is_waiting_for_code_assignment`** *Boolean* Indicates whether the access code is waiting for a code assignment. --- -`name` *String* +**`name`** *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. --- -`pulled_backup_access_code_id` *UUID* +**`pulled_backup_access_code_id`** *UUID* Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. --- -`starts_at` *Datetime* +**`starts_at`** *Datetime* Date and time at which the time-bound access code becomes active. --- -`status` *Enum* +**`status`** *Enum* 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. @@ -133,7 +133,7 @@ Date and time at which the time-bound access code becomes active. --- -`type` *Enum* +**`type`** *Enum* Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. @@ -147,7 +147,7 @@ Nature of the access code. Values are "ongoing" for access codes that are active --- -[`warnings`](./#warnings-1) *List* *of Objects* +[**`warnings`**](./#warnings-1) *List* *of Objects* Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. @@ -470,54 +470,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -530,54 +530,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -590,61 +590,61 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -657,61 +657,61 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -724,54 +724,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -784,54 +784,54 @@ There was an unusually long delay in setting an [access code](https://docs.seam.
-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 String +event_type** String
-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).
@@ -844,54 +844,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -904,61 +904,61 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -971,54 +971,54 @@ There was an unusually long delay in removing an [access code](https://docs.seam
-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 String +event_type** String
-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).
@@ -1031,54 +1031,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -1091,54 +1091,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -1151,54 +1151,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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 String +event_type** String
-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).
@@ -1211,59 +1211,59 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks
-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 String +event_type** String
-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).
@@ -1276,54 +1276,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-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 String +event_type** String
-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).
@@ -1336,54 +1336,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-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 String +event_type** String
-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).
@@ -1396,54 +1396,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-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 String +event_type** String
-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).
@@ -1456,54 +1456,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-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 String +event_type** String
-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 18622cfe6..14809d1af 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -12,7 +12,7 @@ To learn whether your access control system supports access groups, see the corr ## Properties -`access_group_type` *Enum* +**`access_group_type`** *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -32,7 +32,7 @@ To learn whether your access control system supports access groups, see the corr --- -`access_group_type_display_name` *String* +**`access_group_type_display_name`** *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -40,29 +40,29 @@ To learn whether your access control system supports access groups, see the corr --- -`acs_access_group_id` *UUID* +**`acs_access_group_id`** *UUID* ID of the access group. --- -`acs_system_id` *UUID* +**`acs_system_id`** *UUID* ID of the access control system that contains the access group. --- -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the access group was created. --- -`display_name` *String* +**`display_name`** *String* --- -`external_type` *Enum* +**`external_type`** *Enum* Brand-specific terminology for the access group type. @@ -80,50 +80,50 @@ Brand-specific terminology for the access group type. --- -`external_type_display_name` *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the access group type. --- -`is_managed` *Boolean* +**`is_managed`** *Boolean* --- -`name` *String* +**`name`** *String* Name of the access group. --- -`warnings` *List* *of Objects* +**`warnings`** *List* *of Objects* Warnings associated with the `acs_access_group`.
-created_at Datetime +created_at** Datetime Date and time at which Seam created the warning.
-message String +message** String Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-warning_code String +warning_code** String Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
--- -`workspace_id` *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. @@ -160,52 +160,52 @@ An ACS access group was deleted.
-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 String +event_type** String
-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 fc356ae23..8757efe54 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -12,7 +12,7 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties -`access_method` *Enum* +**`access_method`** *Enum* Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. @@ -27,106 +27,106 @@ Access method for the [credential](../../../capability-guides/access-systems/man --- -`acs_credential_id` *UUID* +**`acs_credential_id`** *UUID* ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`acs_credential_pool_id` *UUID* +**`acs_credential_pool_id`** *UUID* --- -`acs_system_id` *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`acs_user_id` *UUID* +**`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. --- -`assa_abloy_vostio_metadata` *Object* +**`assa_abloy_vostio_metadata`** *Object* Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-door_names List of Strings +door_names** List of Strings
-endpoint_id String +endpoint_id** String
-key_id String +key_id** String
-key_issuing_request_id String +key_issuing_request_id** String
-override_guest_acs_entrance_ids List of Strings +override_guest_acs_entrance_ids** List of Strings
--- -`card_number` *String* +**`card_number`** *String* Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`code` *String* +**`code`** *String* Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. --- -`display_name` *String* +**`display_name`** *String* Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -`ends_at` *String* +**`ends_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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` *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-error_code String +error_code** String
-message String +message** String
--- -`external_type` *Enum* +**`external_type`** *Enum* Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. @@ -145,77 +145,77 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces --- -`external_type_display_name` *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -`is_issued` *Boolean* +**`is_issued`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. --- -`is_latest_desired_state_synced_with_provider` *Boolean* +**`is_latest_desired_state_synced_with_provider`** *Boolean* Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. --- -`is_managed` *Boolean* +**`is_managed`** *Boolean* --- -`is_multi_phone_sync_credential` *Boolean* +**`is_multi_phone_sync_credential`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- -`is_one_time_use` *Boolean* +**`is_one_time_use`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. --- -`issued_at` *Datetime* +**`issued_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. --- -`latest_desired_state_synced_with_provider_at` *Datetime* +**`latest_desired_state_synced_with_provider_at`** *Datetime* Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. --- -`parent_acs_credential_id` *UUID* +**`parent_acs_credential_id`** *UUID* ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`starts_at` *String* +**`starts_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -`visionline_metadata` *Object* +**`visionline_metadata`** *Object* Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
-auto_join Boolean +auto_join** Boolean
-card_function_type Enum +card_function_type** Enum
Possible enum values: @@ -228,42 +228,42 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
-card_id String +card_id** String
-common_acs_entrance_ids List of UUIDs +common_acs_entrance_ids** List of UUIDs
-credential_id String +credential_id** String
-guest_acs_entrance_ids List of UUIDs +guest_acs_entrance_ids** List of UUIDs
-is_valid Boolean +is_valid** Boolean
-joiner_acs_credential_ids List of UUIDs +joiner_acs_credential_ids** List of UUIDs
--- -[`warnings`](./#warnings-1) *List* *of Objects* +[**`warnings`**](./#warnings-1) *List* *of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -`workspace_id` *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -344,52 +344,52 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-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 String +event_type** String
-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).
@@ -402,52 +402,52 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-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 String +event_type** String
-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).
@@ -460,52 +460,52 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-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 String +event_type** String
-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 7c0ab28ba..7b47fd1ac 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -21,58 +21,58 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties -`acs_encoder_id` *UUID* +**`acs_encoder_id`** *UUID* ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. --- -`acs_system_id` *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. --- -`display_name` *String* +**`display_name`** *String* Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -`errors` *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
-created_at Datetime +created_at** Datetime Date and time at which Seam created the error.
-error_code String +error_code** String Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-message String +message** String Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
--- -`workspace_id` *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). @@ -100,54 +100,54 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
-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 String +event_type** String
-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).
@@ -160,54 +160,54 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
-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 String +event_type** String
-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/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index de4fc1177..1d6e94f74 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -49,19 +49,19 @@ Action attempt to track encoding credential data from the physical encoder onto ### Properties -`action_attempt_id` *UUID* +**`action_attempt_id`** *UUID* ID of the action attempt. --- -`action_type` *String* +**`action_type`** *String* Type of action that the action attempt tracks. --- -`status` *Enum* +**`status`** *Enum*
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 6279bb4cd..75064e512 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -40,17 +40,17 @@ Reading credential data from physical encoder. ### Properties -`action_attempt_id` *UUID* +**`action_attempt_id`** *UUID* ID of the action attempt. --- -`action_type` *String* +**`action_type`** *String* --- -`status` *Enum* +**`status`** *Enum*
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 88fa9d5fd..07f4cba9e 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -10,36 +10,36 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties -`acs_entrance_id` *UUID* +**`acs_entrance_id`** *UUID* ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -`acs_system_id` *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -`assa_abloy_vostio_metadata` *Object* +**`assa_abloy_vostio_metadata`** *Object* ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-door_name String +door_name** String
-door_number Number +door_number** Number
-door_type Enum +door_type** Enum
Possible enum values: @@ -54,159 +54,159 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
-pms_id String +pms_id** String
-stand_open Boolean +stand_open** Boolean
--- -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. --- -`display_name` *String* +**`display_name`** *String* Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -`dormakaba_community_metadata` *Object* +**`dormakaba_community_metadata`** *Object* dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-access_point_name String +access_point_name** String
--- -`errors` *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-error_code String +error_code** String Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-message String +message** String Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
--- -`latch_metadata` *Object* +**`latch_metadata`** *Object* Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-accessibility_type String +accessibility_type** String
-door_name String +door_name** String
-door_type String +door_type** String
-is_connected Boolean +is_connected** Boolean
--- -`salto_ks_metadata` *Object* +**`salto_ks_metadata`** *Object* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-battery_level String +battery_level** String
-door_name String +door_name** String
-intrusion_alarm Boolean +intrusion_alarm** Boolean
-left_open_alarm Boolean +left_open_alarm** Boolean
-lock_type String +lock_type** String
-locked_state String +locked_state** String
-online Boolean +online** Boolean
-privacy_mode Boolean +privacy_mode** Boolean
--- -`salto_space_metadata` *Object* +**`salto_space_metadata`** *Object* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-door_description String +door_description** String
-door_name String +door_name** String
-ext_door_id String +ext_door_id** String
--- -`visionline_metadata` *Object* +**`visionline_metadata`** *Object* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
-door_category Enum +door_category** Enum
Possible enum values: @@ -222,18 +222,18 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
-door_name String +door_name** String
-profiles List of Objects +profiles** List of Objects -- visionline_door_profile_id String +- visionline_door_profile_id String -- visionline_door_profile_type Enum +- visionline_door_profile_type Enum
@@ -274,52 +274,52 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
-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 String +event_type** String
-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).
@@ -332,52 +332,52 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
-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 String +event_type** String
-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 07bd9252f..1ca2d4c95 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -12,43 +12,43 @@ For details about the resources associated with an access control system, see th ## Properties -`acs_system_id` *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`can_add_acs_users_to_acs_access_groups` *Boolean* +**`can_add_acs_users_to_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -`can_automate_enrollment` *Boolean* +**`can_automate_enrollment`** *Boolean* Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`can_create_acs_access_groups` *Boolean* +**`can_create_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -`can_remove_acs_users_from_acs_access_groups` *Boolean* +**`can_remove_acs_users_from_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -`connected_account_id` *UUID* +**`connected_account_id`** *UUID* ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`connected_account_ids` *List* *of UUIDs* +**`connected_account_ids`** *List* *of UUIDs* IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -58,25 +58,25 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README --- -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. --- -`default_credential_manager_acs_system_id` *UUID* +**`default_credential_manager_acs_system_id`** *UUID* ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -[`errors`](./#errors-1) *List* *of Objects* +[**`errors`**](./#errors-1) *List* *of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`external_type` *Enum* +**`external_type`** *Enum* Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. @@ -101,48 +101,48 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/ --- -`external_type_display_name` *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. --- -`image_alt_text` *String* +**`image_alt_text`** *String* Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. --- -`image_url` *String* +**`image_url`** *String* URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`is_credential_manager` *Boolean* +**`is_credential_manager`** *Boolean* Indicates whether the `acs_system` is a credential manager. --- -`location` *Object* +**`location`** *Object*
-time_zone String +time_zone** String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
--- -`name` *String* +**`name`** *String* Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`system_type` *Enum* +**`system_type`** *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -169,7 +169,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -`system_type_display_name` *String* +**`system_type_display_name`** *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -177,38 +177,38 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -`visionline_metadata` *Object* +**`visionline_metadata`** *Object*
-lan_address String +lan_address** String IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
-mobile_access_uuid String +mobile_access_uuid** String Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
-system_id String +system_id** String Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
--- -[`warnings`](./#warnings-1) *List* *of Objects* +[**`warnings`**](./#warnings-1) *List* *of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -`workspace_id` *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -293,47 +293,47 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-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 String +event_type** String
-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).
@@ -346,47 +346,47 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-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 String +event_type** String
-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).
@@ -399,47 +399,47 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-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 String +event_type** String
-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 76363c7a0..5673fe371 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -12,51 +12,51 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties -`access_schedule` *Object* +**`access_schedule`** *Object* `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.
-ends_at Datetime +ends_at** Datetime 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.
-starts_at Datetime +starts_at** Datetime Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
--- -`acs_system_id` *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`acs_user_id` *UUID* +**`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. --- -`display_name` *String* +**`display_name`** *String* Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`email` *String* +**`email`** *String* {% hint style="warning" %} **Deprecated**. use email_address. @@ -64,19 +64,19 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -`email_address` *String* +**`email_address`** *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -[`errors`](./#errors-1) *List* *of Objects* +[**`errors`**](./#errors-1) *List* *of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`external_type` *Enum* +**`external_type`** *Enum* Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. @@ -95,69 +95,69 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi --- -`external_type_display_name` *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. --- -`full_name` *String* +**`full_name`** *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`hid_acs_system_id` *UUID* +**`hid_acs_system_id`** *UUID* --- -`is_managed` *Boolean* +**`is_managed`** *Boolean* --- -`is_suspended` *Boolean* +**`is_suspended`** *Boolean* Indicates whether the [ACS 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). --- -`phone_number` *String* +**`phone_number`** *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -`user_identity_email_address` *String* +**`user_identity_email_address`** *String* Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`user_identity_full_name` *String* +**`user_identity_full_name`** *String* Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`user_identity_id` *String* +**`user_identity_id`** *String* ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`user_identity_phone_number` *String* +**`user_identity_phone_number`** *String* Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -[`warnings`](./#warnings-1) *List* *of Objects* +[**`warnings`**](./#warnings-1) *List* *of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -`workspace_id` *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). @@ -261,52 +261,52 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
-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 String +event_type** String
-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 4ec5f6146..1f9b3c633 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -8,25 +8,25 @@ Represents an app user's mobile phone. ## Properties -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the `phone` was created. --- -`custom_metadata` *Record* +**`custom_metadata`** *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. --- -`device_id` *UUID* +**`device_id`** *UUID* ID of the `phone`. --- -`device_type` *Enum* +**`device_type`** *Enum* Type of phone. @@ -40,59 +40,59 @@ Type of phone. --- -`display_name` *String* +**`display_name`** *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. --- -`errors` *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the `phone`.
-error_code String +error_code** String
-message String +message** String
--- -`nickname` *String* +**`nickname`** *String* Optional nickname to describe the phone, settable through Seam. --- -`properties` *Object* +**`properties`** *Object* Properties of the phone.
-assa_abloy_credential_service_metadata Object +assa_abloy_credential_service_metadata** Object ASSA ABLOY Credential Service metadata for the phone.
-assa_abloy_credential_service_metadata.endpoints List of Objects +assa_abloy_credential_service_metadata.endpoints** List of Objects Endpoints associated with the phone. -- endpoint_id String +- endpoint_id String ID of the associated endpoint. -- is_active Boolean +- is_active Boolean Indicated whether the endpoint is active. @@ -101,43 +101,43 @@ Endpoints associated with the phone.
-assa_abloy_credential_service_metadata.has_active_endpoint Boolean +assa_abloy_credential_service_metadata.has_active_endpoint** Boolean Indicates whether the credential service has active endpoints associated with the phone.
-salto_space_credential_service_metadata Object +salto_space_credential_service_metadata** Object Salto Space credential service metadata for the phone.
-salto_space_credential_service_metadata.has_active_phone Boolean +salto_space_credential_service_metadata.has_active_phone** Boolean Indicates whether the credential service has an active associated phone.
--- -`warnings` *List* *of Objects* +**`warnings`** *List* *of Objects* Warnings associated with the `phone`.
-message String +message** String
-warning_code String +warning_code** String
--- -`workspace_id` *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. @@ -165,40 +165,40 @@ A phone device was deactivated.
-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 String +event_type** String
-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/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 1f790053f..ce1a466bc 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -181,17 +181,17 @@ Activating climate preset. ### Properties -`action_attempt_id` *UUID* +**`action_attempt_id`** *UUID* ID of the action attempt. --- -`action_type` *String* +**`action_type`** *String* --- -`status` *Enum* +**`status`** *Enum*
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 09f1e508e..ac14fa6c2 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -191,17 +191,17 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID* +**`action_attempt_id`** *UUID* ID of the action attempt. --- -`action_type` *String* +**`action_type`** *String* --- -`status` *Enum* +**`status`** *Enum*
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 4bf884280..af646f7a9 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -191,17 +191,17 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID* +**`action_attempt_id`** *UUID* ID of the action attempt. --- -`action_type` *String* +**`action_type`** *String* --- -`status` *Enum* +**`status`** *Enum*
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index df0956801..054eba736 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -215,17 +215,17 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID* +**`action_attempt_id`** *UUID* ID of the action attempt. --- -`action_type` *String* +**`action_type`** *String* --- -`status` *Enum* +**`status`** *Enum*
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 425ee1b5c..7be57f83f 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -163,17 +163,17 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID* +**`action_attempt_id`** *UUID* ID of the action attempt. --- -`action_type` *String* +**`action_type`** *String* --- -`status` *Enum* +**`status`** *Enum*
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 3b91fd5a4..37470849b 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -8,69 +8,69 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties -`climate_preset_key` *String* +**`climate_preset_key`** *String* Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. --- -`device_id` *UUID* +**`device_id`** *UUID* ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. --- -`ends_at` *Datetime* +**`ends_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -`errors` *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
-error_code String +error_code** String Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-message String +message** String Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
--- -`max_override_period_minutes` *Number* +**`max_override_period_minutes`** *Number* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -`name` *String* +**`name`** *String* User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -`starts_at` *Datetime* +**`starts_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -`thermostat_schedule_id` *UUID* +**`thermostat_schedule_id`** *UUID* ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 8d07eb3c9..5a9e43c02 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -191,17 +191,17 @@ Setting fan mode. ### Properties -`action_attempt_id` *UUID* +**`action_attempt_id`** *UUID* ID of the action attempt. --- -`action_type` *String* +**`action_type`** *String* --- -`status` *Enum* +**`status`** *Enum*
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 906c65ac5..5d2088739 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -229,17 +229,17 @@ Setting HVAC mode. ### Properties -`action_attempt_id` *UUID* +**`action_attempt_id`** *UUID* ID of the action attempt. --- -`action_type` *String* +**`action_type`** *String* --- -`status` *Enum* +**`status`** *Enum*
diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 0af69a43d..63204399e 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -8,45 +8,45 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the user identity was created. --- -`display_name` *String* +**`display_name`** *String* --- -`email_address` *String* +**`email_address`** *String* Unique email address for the user identity. --- -`full_name` *String* +**`full_name`** *String* --- -`phone_number` *String* +**`phone_number`** *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- -`user_identity_id` *UUID* +**`user_identity_id`** *UUID* ID of the user identity. --- -`user_identity_key` *String* +**`user_identity_key`** *String* Unique key for the user identity. --- -`workspace_id` *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index a6fddf7c0..31e39601c 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -8,31 +8,31 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties -`created_at` *Datetime* +**`created_at`** *Datetime* Date and time at which the enrollment automation was created. --- -`credential_manager_acs_system_id` *UUID* +**`credential_manager_acs_system_id`** *UUID* ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. --- -`enrollment_automation_id` *UUID* +**`enrollment_automation_id`** *UUID* ID of the enrollment automation. --- -`user_identity_id` *UUID* +**`user_identity_id`** *UUID* ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). --- -`workspace_id` *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. @@ -63,40 +63,40 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
-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 String +event_type** String
-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).
From 7007567fdc62de64e28768ecd1f37a72a8bc778b Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 29 Mar 2025 15:06:27 -0400 Subject: [PATCH 077/233] Update property-collapsible.hbs --- src/layouts/partials/property-collapsible.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs index d0b792b12..174e0f618 100644 --- a/src/layouts/partials/property-collapsible.hbs +++ b/src/layouts/partials/property-collapsible.hbs @@ -1,5 +1,5 @@
-{{name}}** {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} +{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{> property-content}}
From c5c252095a09474d50a8c672f0464494943ac2d9 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 29 Mar 2025 15:07:28 -0400 Subject: [PATCH 078/233] Update property-nested-internal.hbs --- src/layouts/partials/property-nested-internal.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-nested-internal.hbs b/src/layouts/partials/property-nested-internal.hbs index 7e985636a..c33659d37 100644 --- a/src/layouts/partials/property-nested-internal.hbs +++ b/src/layouts/partials/property-nested-internal.hbs @@ -11,7 +11,7 @@
-Possible enum values: +Enum values: {{#each enumValues}} - `{{this}}` From dee3611a82dce11d80afc0280c7c96e6d9ec8ee0 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sat, 29 Mar 2025 19:08:30 +0000 Subject: [PATCH 079/233] ci: Generate docs --- docs/api/access_codes/README.md | 280 +++++++++--------- docs/api/acs/access_groups/README.md | 22 +- docs/api/acs/credentials/README.md | 78 ++--- docs/api/acs/encoders/README.md | 38 +-- docs/api/acs/entrances/README.md | 86 +++--- docs/api/acs/systems/README.md | 50 ++-- docs/api/acs/users/README.md | 20 +- docs/api/phones/README.md | 30 +- docs/api/thermostats/schedules/README.md | 4 +- .../enrollment_automations/README.md | 12 +- 10 files changed, 310 insertions(+), 310 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 40188cd8f..13c384327 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -470,54 +470,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -530,54 +530,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -590,61 +590,61 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -657,61 +657,61 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -724,54 +724,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -784,54 +784,54 @@ There was an unusually long delay in setting an [access code](https://docs.seam.
-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** String +event_type String
-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).
@@ -844,54 +844,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -904,61 +904,61 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -971,54 +971,54 @@ There was an unusually long delay in removing an [access code](https://docs.seam
-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** String +event_type String
-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).
@@ -1031,54 +1031,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -1091,54 +1091,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -1151,54 +1151,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-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** String +event_type String
-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).
@@ -1211,59 +1211,59 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks
-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** String +event_type String
-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).
@@ -1276,54 +1276,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-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** String +event_type String
-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).
@@ -1336,54 +1336,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-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** String +event_type String
-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).
@@ -1396,54 +1396,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-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** String +event_type String
-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).
@@ -1456,54 +1456,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-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** String +event_type String
-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 14809d1af..38bab56c4 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -103,21 +103,21 @@ Warnings associated with the `acs_access_group`.
-created_at** Datetime +created_at Datetime Date and time at which Seam created the warning.
-message** String +message String Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
-warning_code** String +warning_code String Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
@@ -160,52 +160,52 @@ An ACS access group was deleted.
-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** String +event_type String
-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 8757efe54..5e022672f 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -56,27 +56,27 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
-door_names** List of Strings +door_names List of Strings
-endpoint_id** String +endpoint_id String
-key_id** String +key_id String
-key_issuing_request_id** String +key_issuing_request_id String
-override_guest_acs_entrance_ids** List of Strings +override_guest_acs_entrance_ids List of Strings
--- @@ -117,12 +117,12 @@ Errors associated with the [credential](../../../capability-guides/access-system
-error_code** String +error_code String
-message** String +message String
--- @@ -210,12 +210,12 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
-auto_join** Boolean +auto_join Boolean
-card_function_type** Enum +card_function_type Enum
Possible enum values: @@ -228,32 +228,32 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
-card_id** String +card_id String
-common_acs_entrance_ids** List of UUIDs +common_acs_entrance_ids List of UUIDs
-credential_id** String +credential_id String
-guest_acs_entrance_ids** List of UUIDs +guest_acs_entrance_ids List of UUIDs
-is_valid** Boolean +is_valid Boolean
-joiner_acs_credential_ids** List of UUIDs +joiner_acs_credential_ids List of UUIDs
--- @@ -344,52 +344,52 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-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** String +event_type String
-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).
@@ -402,52 +402,52 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-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** String +event_type String
-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).
@@ -460,52 +460,52 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-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** String +event_type String
-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 7b47fd1ac..daca51fd1 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -52,21 +52,21 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
-created_at** Datetime +created_at Datetime Date and time at which Seam created the error.
-error_code** String +error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-message** String +message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
@@ -100,54 +100,54 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
-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** String +event_type String
-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).
@@ -160,54 +160,54 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
-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** String +event_type String
-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 07f4cba9e..35aa200e4 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -29,17 +29,17 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
-door_name** String +door_name String
-door_number** Number +door_number Number
-door_type** Enum +door_type Enum
Possible enum values: @@ -54,12 +54,12 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
-pms_id** String +pms_id String
-stand_open** Boolean +stand_open Boolean
--- @@ -82,7 +82,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
-access_point_name** String +access_point_name String
--- @@ -93,14 +93,14 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
-error_code** String +error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-message** String +message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
@@ -113,22 +113,22 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
-accessibility_type** String +accessibility_type String
-door_name** String +door_name String
-door_type** String +door_type String
-is_connected** Boolean +is_connected Boolean
--- @@ -139,42 +139,42 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
-battery_level** String +battery_level String
-door_name** String +door_name String
-intrusion_alarm** Boolean +intrusion_alarm Boolean
-left_open_alarm** Boolean +left_open_alarm Boolean
-lock_type** String +lock_type String
-locked_state** String +locked_state String
-online** Boolean +online Boolean
-privacy_mode** Boolean +privacy_mode Boolean
--- @@ -185,17 +185,17 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
-door_description** String +door_description String
-door_name** String +door_name String
-ext_door_id** String +ext_door_id String
--- @@ -206,7 +206,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
-door_category** Enum +door_category Enum
Possible enum values: @@ -222,12 +222,12 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
-door_name** String +door_name String
-profiles** List of Objects +profiles List of Objects - visionline_door_profile_id String @@ -238,7 +238,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
-Possible enum values: +Enum values: - `BLE` - `commonDoor` @@ -274,52 +274,52 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
-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** String +event_type String
-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).
@@ -332,52 +332,52 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
-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** String +event_type String
-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 1ca2d4c95..3f24361a6 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -130,7 +130,7 @@ Indicates whether the `acs_system` is a credential manager.
-time_zone** String +time_zone String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
@@ -182,21 +182,21 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
-lan_address** String +lan_address String IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
-mobile_access_uuid** String +mobile_access_uuid String Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
-system_id** String +system_id String Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
@@ -293,47 +293,47 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-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** String +event_type String
-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).
@@ -346,47 +346,47 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-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** String +event_type String
-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).
@@ -399,47 +399,47 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-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** String +event_type String
-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 5673fe371..2263d087d 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -19,14 +19,14 @@ For details about how to configure `acs_user`s in your access control system, se
-ends_at** Datetime +ends_at Datetime 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.
-starts_at** Datetime +starts_at Datetime Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
@@ -261,52 +261,52 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
-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** String +event_type String
-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 1f9b3c633..dcfc37b1d 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -53,12 +53,12 @@ Errors associated with the `phone`.
-error_code** String +error_code String
-message** String +message String
--- @@ -75,14 +75,14 @@ Properties of the phone.
-assa_abloy_credential_service_metadata** Object +assa_abloy_credential_service_metadata Object ASSA ABLOY Credential Service metadata for the phone.
-assa_abloy_credential_service_metadata.endpoints** List of Objects +assa_abloy_credential_service_metadata.endpoints List of Objects Endpoints associated with the phone. @@ -101,21 +101,21 @@ Endpoints associated with the phone.
-assa_abloy_credential_service_metadata.has_active_endpoint** Boolean +assa_abloy_credential_service_metadata.has_active_endpoint Boolean Indicates whether the credential service has active endpoints associated with the phone.
-salto_space_credential_service_metadata** Object +salto_space_credential_service_metadata Object Salto Space credential service metadata for the phone.
-salto_space_credential_service_metadata.has_active_phone** Boolean +salto_space_credential_service_metadata.has_active_phone Boolean Indicates whether the credential service has an active associated phone.
@@ -128,12 +128,12 @@ Warnings associated with the `phone`.
-message** String +message String
-warning_code** String +warning_code String
--- @@ -165,40 +165,40 @@ A phone device was deactivated.
-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** String +event_type String
-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/schedules/README.md b/docs/api/thermostats/schedules/README.md index 37470849b..e806d3a3b 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -39,14 +39,14 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
-error_code** String +error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
-message** String +message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 31e39601c..bee340225 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -63,40 +63,40 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
-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** String +event_type String
-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).
From ad90a32fd0fc471d0cb14cd00622f1481f6cf67c Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 29 Mar 2025 15:11:42 -0400 Subject: [PATCH 080/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index e0adbb774..3bbbe1855 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -28,7 +28,7 @@ {{#if enumValues}}
-Possible enum values: +Enum values: {{#each enumValues}} - `{{this}}` @@ -41,10 +41,14 @@ This object has no properties. {{else}} +
+ +Child Properties {{#each objectProperties}} {{> property-collapsible this}} {{/each}} +
{{/if}} {{/unless}} {{#if listProperties}} From 0bd6189528c4a9a3a0be393913d1c38ed73e9f5b Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sat, 29 Mar 2025 19:12:43 +0000 Subject: [PATCH 081/233] ci: Generate docs --- docs/api/access_codes/README.md | 4 ++-- docs/api/acs/access_groups/README.md | 4 ++-- docs/api/acs/credentials/README.md | 12 ++++++++-- docs/api/acs/encoders/encode_credential.md | 2 +- docs/api/acs/encoders/scan_credential.md | 2 +- docs/api/acs/entrances/README.md | 24 +++++++++++++++++++ docs/api/acs/systems/README.md | 12 ++++++++-- docs/api/acs/users/README.md | 6 ++++- docs/api/phones/README.md | 6 ++++- .../thermostats/activate_climate_preset.md | 2 +- docs/api/thermostats/cool.md | 2 +- docs/api/thermostats/heat.md | 2 +- docs/api/thermostats/heat_cool.md | 2 +- docs/api/thermostats/off.md | 2 +- docs/api/thermostats/set_fan_mode.md | 2 +- docs/api/thermostats/set_hvac_mode.md | 2 +- 16 files changed, 67 insertions(+), 19 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 13c384327..e5f9f27cb 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -122,7 +122,7 @@ Date and time at which the time-bound access code becomes active.
-Possible enum values: +Enum values: - `setting` - `set` @@ -139,7 +139,7 @@ Nature of the access code. Values are "ongoing" for access codes that are active
-Possible enum values: +Enum values: - `time_bound` - `ongoing` diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 38bab56c4..1d55cfa61 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -20,7 +20,7 @@ To learn whether your access control system supports access groups, see the corr
-Possible enum values: +Enum values: - `pti_unit` - `pti_access_level` @@ -68,7 +68,7 @@ Brand-specific terminology for the access group type.
-Possible enum values: +Enum values: - `pti_unit` - `pti_access_level` diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 5e022672f..1edb29888 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -18,7 +18,7 @@ Access method for the [credential](../../../capability-guides/access-systems/man
-Possible enum values: +Enum values: - `code` - `card` @@ -53,6 +53,9 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). +
+ +Child Properties
@@ -78,6 +81,7 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- override_guest_acs_entrance_ids List of Strings
+
--- **`card_number`** *String* @@ -132,7 +136,7 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces
-Possible enum values: +Enum values: - `pti_card` - `brivo_credential` @@ -207,6 +211,9 @@ Date and time at which the [credential](../../../capability-guides/access-system Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). +
+ +Child Properties
@@ -255,6 +262,7 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc joiner_acs_credential_ids List of UUIDs
+
--- [**`warnings`**](./#warnings-1) *List* *of Objects* diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 1d6e94f74..706371ccc 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -65,7 +65,7 @@ Type of action that the action attempt tracks.
-Possible enum values: +Enum values: - `success` - `pending` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 75064e512..f537d9c9d 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -54,7 +54,7 @@ ID of the action attempt.
-Possible enum values: +Enum values: - `success` - `pending` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 35aa200e4..75a3d5184 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -26,6 +26,9 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
+ +Child Properties
@@ -61,6 +64,7 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa stand_open Boolean
+
--- **`created_at`** *Datetime* @@ -79,11 +83,15 @@ Display name for the [entrance](../../../capability-guides/access-systems/retrie dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
+ +Child Properties
access_point_name String
+
--- **`errors`** *List* *of Objects* @@ -110,6 +118,9 @@ Detailed description of the error. Provides insights into the issue and potentia Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
+ +Child Properties
@@ -130,12 +141,16 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide is_connected Boolean
+
--- **`salto_ks_metadata`** *Object* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
+ +Child Properties
@@ -176,12 +191,16 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu privacy_mode Boolean
+
--- **`salto_space_metadata`** *Object* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
+ +Child Properties
@@ -197,12 +216,16 @@ Salto Space-specific metadata associated with the [entrance](../../../capability ext_door_id String
+
--- **`visionline_metadata`** *Object* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
+ +Child Properties
@@ -246,6 +269,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
+
--- diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 3f24361a6..0f6fbc3b7 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -82,7 +82,7 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/
-Possible enum values: +Enum values: - `pti_site` - `alta_org` @@ -127,6 +127,9 @@ Indicates whether the `acs_system` is a credential manager. --- **`location`** *Object* +
+ +Child Properties
@@ -134,6 +137,7 @@ Indicates whether the `acs_system` is a credential manager. Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
+
--- **`name`** *String* @@ -150,7 +154,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
-Possible enum values: +Enum values: - `pti_site` - `alta_org` @@ -179,6 +183,9 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- **`visionline_metadata`** *Object* +
+ +Child Properties
@@ -200,6 +207,7 @@ Keyset loaded into a reader. Mobile keys and reader administration tools securel Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
+
--- [**`warnings`**](./#warnings-1) *List* *of Objects* diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 2263d087d..bcc854d49 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -16,6 +16,9 @@ For details about how to configure `acs_user`s in your access control system, se `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. +
+ +Child Properties
@@ -30,6 +33,7 @@ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+
--- **`acs_system_id`** *UUID* @@ -82,7 +86,7 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi
-Possible enum values: +Enum values: - `pti_user` - `brivo_user` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index dcfc37b1d..f5285ca53 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -32,7 +32,7 @@ Type of phone.
-Possible enum values: +Enum values: - `ios_phone` - `android_phone` @@ -72,6 +72,9 @@ Optional nickname to describe the phone, settable through Seam. Properties of the phone. +
+ +Child Properties
@@ -119,6 +122,7 @@ Salto Space credential service metadata for the phone. Indicates whether the credential service has an active associated phone.
+
--- **`warnings`** *List* *of Objects* diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index ce1a466bc..ceee6f5fc 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -195,7 +195,7 @@ ID of the action attempt.
-Possible enum values: +Enum values: - `success` - `pending` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index ac14fa6c2..c513204f4 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -205,7 +205,7 @@ ID of the action attempt.
-Possible enum values: +Enum values: - `success` - `pending` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index af646f7a9..9240b7a42 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -205,7 +205,7 @@ ID of the action attempt.
-Possible enum values: +Enum values: - `success` - `pending` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 054eba736..73cdd0c4f 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -229,7 +229,7 @@ ID of the action attempt.
-Possible enum values: +Enum values: - `success` - `pending` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 7be57f83f..34e543648 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -177,7 +177,7 @@ ID of the action attempt.
-Possible enum values: +Enum values: - `success` - `pending` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 5a9e43c02..0e6e60c71 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -205,7 +205,7 @@ ID of the action attempt.
-Possible enum values: +Enum values: - `success` - `pending` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 5d2088739..b6618359c 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -243,7 +243,7 @@ ID of the action attempt.
-Possible enum values: +Enum values: - `success` - `pending` From 671b39732a5f8e738b455ff44963850ab739bbb0 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 29 Mar 2025 15:13:46 -0400 Subject: [PATCH 082/233] Update api-route.hbs --- src/layouts/api-route.hbs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index f9aebf9b9..e66344229 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -8,7 +8,7 @@ The {{title}} route contains the following resources: ## Errors {{#each errors}} -### `{{name}}` +**`{{name}}`** {{description}} @@ -20,7 +20,7 @@ The {{title}} route contains the following resources: ## Warnings {{#each warnings}} -### `{{name}}` +**`{{name}}`** {{description}} @@ -32,7 +32,7 @@ The {{title}} route contains the following resources: ## Endpoints {{#each endpoints}} -### [`{{path}}`](./{{name}}.md) +[**`{{path}}`**](./{{name}}.md) {{description}} {{/each}} @@ -43,7 +43,7 @@ The {{title}} route contains the following resources: ## Events {{#each events}} -### `{{name}}` +**`{{name}}`** {{#if description}} {{description}} From e073d61eababb02f0c0e6dc0b5d73fa6eaecd569 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sat, 29 Mar 2025 19:14:52 +0000 Subject: [PATCH 083/233] ci: Generate docs --- docs/api/access_codes/README.md | 134 +++++++++--------- docs/api/acs/access_groups/README.md | 14 +- docs/api/acs/credentials/README.md | 34 ++--- docs/api/acs/encoders/README.md | 10 +- docs/api/acs/encoders/simulate/README.md | 8 +- docs/api/acs/entrances/README.md | 12 +- docs/api/acs/systems/README.md | 28 ++-- docs/api/acs/users/README.md | 40 +++--- docs/api/phones/README.md | 8 +- docs/api/phones/simulate/README.md | 2 +- docs/api/thermostats/README.md | 26 ++-- docs/api/thermostats/schedules/README.md | 10 +- docs/api/thermostats/simulate/README.md | 4 +- docs/api/user_identities/README.md | 24 ++-- .../enrollment_automations/README.md | 10 +- 15 files changed, 182 insertions(+), 182 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index e5f9f27cb..705d16cf7 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -155,229 +155,229 @@ Collection of warnings associated with the access code, structured in a dictiona --- ## Errors -### `smartthings_failed_to_set_access_code` +**`smartthings_failed_to_set_access_code`** Failed to set code on Smart Things device. --- -### `smartthings_failed_to_set_after_multiple_retries` +**`smartthings_failed_to_set_after_multiple_retries`** Failed to set code after multiple retries. --- -### `smartthings_no_free_slots_available` +**`smartthings_no_free_slots_available`** No free slots available on the device. --- -### `failed_to_set_on_device` +**`failed_to_set_on_device`** Failed to set code on device. --- -### `failed_to_remove_from_device` +**`failed_to_remove_from_device`** Failed to remove code from device. --- -### `duplicate_code_on_device` +**`duplicate_code_on_device`** Duplicate access code detected on device. --- -### `duplicate_code_attempt_prevented` +**`duplicate_code_attempt_prevented`** An attempt to modify this access code was prevented. --- -### `igloohome_bridge_too_many_pending_jobs` +**`igloohome_bridge_too_many_pending_jobs`** Igloohome bridge has too many pending jobs in the queue. --- -### `igloohome_bridge_offline` +**`igloohome_bridge_offline`** Igloohome bridge is offline. --- -### `igloohome_offline_access_code_no_variance_available` +**`igloohome_offline_access_code_no_variance_available`** Lock as reached max amount of codes. --- -### `kwikset_unable_to_confirm_code` +**`kwikset_unable_to_confirm_code`** Unable to confirm the access code is set on Kwikset device. --- -### `kwikset_unable_to_confirm_deletion` +**`kwikset_unable_to_confirm_deletion`** Unable to confirm the deletion of the access code on Kwikset device. --- -### `code_modified_external_to_seam` +**`code_modified_external_to_seam`** Code was modified or removed externally after Seam successfully set it on the device. --- -### `august_lock_invalid_code_length` +**`august_lock_invalid_code_length`** Invalid code length for August lock. --- -### `august_device_programming_delay` +**`august_device_programming_delay`** Access code has not yet been fully moved to the device. --- -### `august_device_slots_full` +**`august_device_slots_full`** All access code slots on the device are full. --- -### `august_lock_missing_keypad` +**`august_lock_missing_keypad`** August lock is missing a keypad. --- -### `august_lock_temporarily_offline` +**`august_lock_temporarily_offline`** August lock is temporarily offline. --- -### `salto_ks_user_not_subscribed` +**`salto_ks_user_not_subscribed`** Salto site user is not subscribed. --- -### `hubitat_device_programming_delay` +**`hubitat_device_programming_delay`** Access code has not yet been fully moved to the device. --- -### `hubitat_no_free_positions_available` +**`hubitat_no_free_positions_available`** No free positions available on the device. --- -### `wyze_duplicate_code_name` +**`wyze_duplicate_code_name`** Duplicate access code name detected. --- -### `wyze_potential_duplicate_code` +**`wyze_potential_duplicate_code`** Potential duplicate access code detected. --- -### `dormakaba_oracode_no_valid_user_level` +**`dormakaba_oracode_no_valid_user_level`** No valid user level for Oracode. --- -### `account_disconnected` +**`account_disconnected`** Account is disconnected --- -### `salto_ks_subscription_limit_exceeded` +**`salto_ks_subscription_limit_exceeded`** Salto site user limit reached. --- -### `device_offline` +**`device_offline`** Device is offline --- -### `device_removed` +**`device_removed`** Device has been removed --- -### `hub_disconnected` +**`hub_disconnected`** Hub is disconnected --- -### `device_disconnected` +**`device_disconnected`** Device is disconnected --- -### `empty_backup_access_code_pool` +**`empty_backup_access_code_pool`** The backup access code pool is empty. --- -### `august_lock_not_authorized` +**`august_lock_not_authorized`** User is not authorized to use the August Lock. --- -### `august_lock_missing_bridge` +**`august_lock_missing_bridge`** Lock is not connected to the Seam Bridge. --- -### `ttlock_lock_not_paired_to_gateway` +**`ttlock_lock_not_paired_to_gateway`** Lock is not paired with a Gateway. --- -### `missing_device_credentials` +**`missing_device_credentials`** Missing device credentials. --- -### `auxiliary_heat_running` +**`auxiliary_heat_running`** The auxiliary heat is running. --- -### `subscription_required` +**`subscription_required`** Subscription required to connect. --- -### `invalid_credentials` +**`invalid_credentials`** Credentials provided were invalid. @@ -385,73 +385,73 @@ Credentials provided were invalid. ## Warnings -### `smartthings_failed_to_set_access_code` +**`smartthings_failed_to_set_access_code`** Failed to set code on Smart Things device. --- -### `schlage_detected_duplicate` +**`schlage_detected_duplicate`** Duplicate access code detected. --- -### `schlage_creation_outage` +**`schlage_creation_outage`** Received an error when attempting to create this code. --- -### `code_modified_external_to_seam` +**`code_modified_external_to_seam`** Code was modified or removed externally after Seam successfully set it on the device. --- -### `delay_in_setting_on_device` +**`delay_in_setting_on_device`** Delay in setting code on device. --- -### `delay_in_removing_from_device` +**`delay_in_removing_from_device`** Delay in removing code from device. --- -### `third_party_integration_detected` +**`third_party_integration_detected`** Third party integration detected that may cause access codes to fail. --- -### `august_device_programming_delay` +**`august_device_programming_delay`** Access code has not yet been fully moved to the device. --- -### `august_lock_temporarily_offline` +**`august_lock_temporarily_offline`** August lock is temporarily offline. --- -### `igloo_algopin_must_be_used_within_24_hours` +**`igloo_algopin_must_be_used_within_24_hours`** Algopins must be used within 24 hours. --- -### `management_transferred` +**`management_transferred`** Management was transferred to another workspace. --- -### `kwikset_unable_to_confirm_code` +**`kwikset_unable_to_confirm_code`** Unable to confirm the access code is set on Kwikset device. @@ -464,7 +464,7 @@ Unable to confirm the access code is set on Kwikset device. ## Events -### `access_code.created` +**`access_code.created`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created. @@ -524,7 +524,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.changed` +**`access_code.changed`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed. @@ -584,7 +584,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.scheduled_on_device` +**`access_code.scheduled_on_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device. @@ -651,7 +651,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.set_on_device` +**`access_code.set_on_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device. @@ -718,7 +718,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.removed_from_device` +**`access_code.removed_from_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device. @@ -778,7 +778,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.delay_in_setting_on_device` +**`access_code.delay_in_setting_on_device`** There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device. @@ -838,7 +838,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.failed_to_set_on_device` +**`access_code.failed_to_set_on_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device. @@ -898,7 +898,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.deleted` +**`access_code.deleted`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted. @@ -965,7 +965,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.delay_in_removing_from_device` +**`access_code.delay_in_removing_from_device`** There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device. @@ -1025,7 +1025,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.failed_to_remove_from_device` +**`access_code.failed_to_remove_from_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device. @@ -1085,7 +1085,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.modified_external_to_seam` +**`access_code.modified_external_to_seam`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam. @@ -1145,7 +1145,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.deleted_external_to_seam` +**`access_code.deleted_external_to_seam`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam. @@ -1205,7 +1205,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.backup_access_code_pulled` +**`access_code.backup_access_code_pulled`** A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device. @@ -1270,7 +1270,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.unmanaged.converted_to_managed` +**`access_code.unmanaged.converted_to_managed`** An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code. @@ -1330,7 +1330,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.unmanaged.failed_to_convert_to_managed` +**`access_code.unmanaged.failed_to_convert_to_managed`** An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code. @@ -1390,7 +1390,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.unmanaged.created` +**`access_code.unmanaged.created`** An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device. @@ -1450,7 +1450,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md). --- -### `access_code.unmanaged.removed` +**`access_code.unmanaged.removed`** An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device. diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 1d55cfa61..a0fcf0a54 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -131,22 +131,22 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Endpoints -### [`/acs/access_groups/add_user`](./add_user.md) +[**`/acs/access_groups/add_user`**](./add_user.md) Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -### [`/acs/access_groups/get`](./get.md) +[**`/acs/access_groups/get`**](./get.md) Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -### [`/acs/access_groups/list`](./list.md) +[**`/acs/access_groups/list`**](./list.md) Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -### [`/acs/access_groups/list_accessible_entrances`](./list_accessible_entrances.md) +[**`/acs/access_groups/list_accessible_entrances`**](./list_accessible_entrances.md) Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -### [`/acs/access_groups/list_users`](./list_users.md) +[**`/acs/access_groups/list_users`**](./list_users.md) Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -### [`/acs/access_groups/remove_user`](./remove_user.md) +[**`/acs/access_groups/remove_user`**](./remove_user.md) Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). @@ -154,7 +154,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc ## Events -### `acs_access_group.deleted` +**`acs_access_group.deleted`** An ACS access group was deleted. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 1edb29888..020e2600e 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -279,37 +279,37 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Warnings -### `waiting_to_be_issued` +**`waiting_to_be_issued`** Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued. --- -### `schedule_externally_modified` +**`schedule_externally_modified`** Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally. --- -### `schedule_modified` +**`schedule_modified`** Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past. --- -### `being_deleted` +**`being_deleted`** Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted. --- -### `unknown_issue_with_acs_credential` +**`unknown_issue_with_acs_credential`** An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential. --- -### `needs_to_be_reissued` +**`needs_to_be_reissued`** Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential. @@ -317,28 +317,28 @@ Access permissions for the [credential](../../../capability-guides/access-system ## Endpoints -### [`/acs/credentials/assign`](./assign.md) +[**`/acs/credentials/assign`**](./assign.md) Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -### [`/acs/credentials/create`](./create.md) +[**`/acs/credentials/create`**](./create.md) Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -### [`/acs/credentials/delete`](./delete.md) +[**`/acs/credentials/delete`**](./delete.md) Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -### [`/acs/credentials/get`](./get.md) +[**`/acs/credentials/get`**](./get.md) Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -### [`/acs/credentials/list`](./list.md) +[**`/acs/credentials/list`**](./list.md) Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). -### [`/acs/credentials/list_accessible_entrances`](./list_accessible_entrances.md) +[**`/acs/credentials/list_accessible_entrances`**](./list_accessible_entrances.md) Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. -### [`/acs/credentials/unassign`](./unassign.md) +[**`/acs/credentials/unassign`**](./unassign.md) Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -### [`/acs/credentials/update`](./update.md) +[**`/acs/credentials/update`**](./update.md) Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -346,7 +346,7 @@ Updates the code and ends at date and time for a specified [credential](../../.. ## Events -### `acs_credential.deleted` +**`acs_credential.deleted`** An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was deleted. @@ -404,7 +404,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md). --- -### `acs_credential.issued` +**`acs_credential.issued`** An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was issued. @@ -462,7 +462,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md). --- -### `acs_credential.reissued` +**`acs_credential.reissued`** An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was reissued. diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index daca51fd1..561e5c9cd 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -80,13 +80,13 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Endpoints -### [`/acs/encoders/encode_credential`](./encode_credential.md) +[**`/acs/encoders/encode_credential`**](./encode_credential.md) Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -### [`/acs/encoders/list`](./list.md) +[**`/acs/encoders/list`**](./list.md) Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -### [`/acs/encoders/scan_credential`](./scan_credential.md) +[**`/acs/encoders/scan_credential`**](./scan_credential.md) Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). @@ -94,7 +94,7 @@ Scans an encoded [acs_credential](../../../capability-guides/access-systems/mana ## Events -### `acs_encoder.added` +**`acs_encoder.added`** An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was added. @@ -154,7 +154,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md). --- -### `acs_encoder.removed` +**`acs_encoder.removed`** An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was removed. diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index 903e4e935..07f9962c1 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -4,15 +4,15 @@ The Encoder Simulations route contains the following resources: ## Endpoints -### [`/acs/encoders/simulate/next_credential_encode_will_fail`](./next_credential_encode_will_fail.md) +[**`/acs/encoders/simulate/next_credential_encode_will_fail`**](./next_credential_encode_will_fail.md) Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -### [`/acs/encoders/simulate/next_credential_encode_will_succeed`](./next_credential_encode_will_succeed.md) +[**`/acs/encoders/simulate/next_credential_encode_will_succeed`**](./next_credential_encode_will_succeed.md) Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -### [`/acs/encoders/simulate/next_credential_scan_will_fail`](./next_credential_scan_will_fail.md) +[**`/acs/encoders/simulate/next_credential_scan_will_fail`**](./next_credential_scan_will_fail.md) Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -### [`/acs/encoders/simulate/next_credential_scan_will_succeed`](./next_credential_scan_will_succeed.md) +[**`/acs/encoders/simulate/next_credential_scan_will_succeed`**](./next_credential_scan_will_succeed.md) Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 75a3d5184..218c0310d 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -275,16 +275,16 @@ Visionline-specific metadata associated with the [entrance](../../../capability- --- ## Endpoints -### [`/acs/entrances/get`](./get.md) +[**`/acs/entrances/get`**](./get.md) Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -### [`/acs/entrances/grant_access`](./grant_access.md) +[**`/acs/entrances/grant_access`**](./grant_access.md) -### [`/acs/entrances/list`](./list.md) +[**`/acs/entrances/list`**](./list.md) Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). -### [`/acs/entrances/list_credentials_with_access`](./list_credentials_with_access.md) +[**`/acs/entrances/list_credentials_with_access`**](./list_credentials_with_access.md) Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -292,7 +292,7 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/ma ## Events -### `acs_entrance.added` +**`acs_entrance.added`** An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added. @@ -350,7 +350,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md). --- -### `acs_entrance.removed` +**`acs_entrance.removed`** An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed. diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 0f6fbc3b7..02914b0dd 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -224,7 +224,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Errors -### `seam_bridge_disconnected` +**`seam_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. This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md). @@ -232,7 +232,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab --- -### `visionline_instance_unreachable` +**`visionline_instance_unreachable`** Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../../../core-concepts/workspaces/README.md). @@ -240,25 +240,25 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct --- -### `salto_ks_subscription_limit_exceeded` +**`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. --- -### `acs_system_disconnected` +**`acs_system_disconnected`** Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue. --- -### `account_disconnected` +**`account_disconnected`** Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access. --- -### `salto_ks_certification_expired` +**`salto_ks_certification_expired`** Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. @@ -266,13 +266,13 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit ## Warnings -### `salto_ks_subscription_limit_almost_reached` +**`salto_ks_subscription_limit_almost_reached`** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue. --- -### `time_zone_does_not_match_location` +**`time_zone_does_not_match_location`** Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -280,13 +280,13 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui ## Endpoints -### [`/acs/systems/get`](./get.md) +[**`/acs/systems/get`**](./get.md) Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -### [`/acs/systems/list`](./list.md) +[**`/acs/systems/list`**](./list.md) Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). -### [`/acs/systems/list_compatible_credential_manager_acs_systems`](./list_compatible_credential_manager_acs_systems.md) +[**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md) Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -295,7 +295,7 @@ Returns a list of all credential manager ACS systems that are compatible with a ## Events -### `acs_system.connected` +**`acs_system.connected`** An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected. @@ -348,7 +348,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md). --- -### `acs_system.added` +**`acs_system.added`** An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added. @@ -401,7 +401,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md). --- -### `acs_system.disconnected` +**`acs_system.disconnected`** An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected. diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index bcc854d49..d9cd8fc68 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -169,31 +169,31 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Errors -### `deleted_externally` +**`deleted_externally`** Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam. --- -### `salto_ks_subscription_limit_exceeded` +**`salto_ks_subscription_limit_exceeded`** Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. --- -### `failed_to_create_on_acs_system` +**`failed_to_create_on_acs_system`** Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). --- -### `failed_to_update_on_acs_system` +**`failed_to_update_on_acs_system`** Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). --- -### `failed_to_delete_on_acs_system` +**`failed_to_delete_on_acs_system`** Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). @@ -201,19 +201,19 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce ## Warnings -### `being_deleted` +**`being_deleted`** Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly. --- -### `salto_ks_user_not_subscribed` +**`salto_ks_user_not_subscribed`** Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. --- -### `unknown_issue_with_acs_user` +**`unknown_issue_with_acs_user`** An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. @@ -221,37 +221,37 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc ## Endpoints -### [`/acs/users/add_to_access_group`](./add_to_access_group.md) +[**`/acs/users/add_to_access_group`**](./add_to_access_group.md) Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -### [`/acs/users/create`](./create.md) +[**`/acs/users/create`**](./create.md) Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -### [`/acs/users/delete`](./delete.md) +[**`/acs/users/delete`**](./delete.md) Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). -### [`/acs/users/get`](./get.md) +[**`/acs/users/get`**](./get.md) Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -### [`/acs/users/list`](./list.md) +[**`/acs/users/list`**](./list.md) Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -### [`/acs/users/list_accessible_entrances`](./list_accessible_entrances.md) +[**`/acs/users/list_accessible_entrances`**](./list_accessible_entrances.md) Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. -### [`/acs/users/remove_from_access_group`](./remove_from_access_group.md) +[**`/acs/users/remove_from_access_group`**](./remove_from_access_group.md) Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -### [`/acs/users/revoke_access_to_all_entrances`](./revoke_access_to_all_entrances.md) +[**`/acs/users/revoke_access_to_all_entrances`**](./revoke_access_to_all_entrances.md) Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -### [`/acs/users/suspend`](./suspend.md) +[**`/acs/users/suspend`**](./suspend.md) [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. -### [`/acs/users/unsuspend`](./unsuspend.md) +[**`/acs/users/unsuspend`**](./unsuspend.md) [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. -### [`/acs/users/update`](./update.md) +[**`/acs/users/update`**](./update.md) Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). @@ -259,7 +259,7 @@ Updates the properties of a specified [ACS user](https://docs.seam.co/latest/cap ## Events -### `acs_user.deleted` +**`acs_user.deleted`** An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted. diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index f5285ca53..ad479234e 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -149,13 +149,13 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th --- ## Endpoints -### [`/phones/deactivate`](./deactivate.md) +[**`/phones/deactivate`**](./deactivate.md) Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). -### [`/phones/get`](./get.md) +[**`/phones/get`**](./get.md) Returns a single phone entry matching the provided `device_id`. -### [`/phones/list`](./list.md) +[**`/phones/list`**](./list.md) Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. @@ -163,7 +163,7 @@ Returns a list of all phones. To filter the list of returned phones by a specifi ## Events -### `phone.deactivated` +**`phone.deactivated`** A phone device was deactivated. diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index 0e26ab5a1..a30fed7e3 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -4,6 +4,6 @@ The Phone Simulations route contains the following resources: ## Endpoints -### [`/phones/simulate/create_sandbox_phone`](./create_sandbox_phone.md) +[**`/phones/simulate/create_sandbox_phone`**](./create_sandbox_phone.md) Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index fca49b1bc..ee64d862b 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -4,42 +4,42 @@ The Thermostats route contains the following resources: ## Endpoints -### [`/thermostats/activate_climate_preset`](./activate_climate_preset.md) +[**`/thermostats/activate_climate_preset`**](./activate_climate_preset.md) Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/cool`](./cool.md) +[**`/thermostats/cool`**](./cool.md) Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -### [`/thermostats/create_climate_preset`](./create_climate_preset.md) +[**`/thermostats/create_climate_preset`**](./create_climate_preset.md) Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/delete_climate_preset`](./delete_climate_preset.md) +[**`/thermostats/delete_climate_preset`**](./delete_climate_preset.md) Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/heat`](./heat.md) +[**`/thermostats/heat`**](./heat.md) Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -### [`/thermostats/heat_cool`](./heat_cool.md) +[**`/thermostats/heat_cool`**](./heat_cool.md) Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -### [`/thermostats/list`](./list.md) +[**`/thermostats/list`**](./list.md) Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/off`](./off.md) +[**`/thermostats/off`**](./off.md) Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -### [`/thermostats/set_fallback_climate_preset`](./set_fallback_climate_preset.md) +[**`/thermostats/set_fallback_climate_preset`**](./set_fallback_climate_preset.md) Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/set_fan_mode`](./set_fan_mode.md) +[**`/thermostats/set_fan_mode`**](./set_fan_mode.md) Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/set_hvac_mode`](./set_hvac_mode.md) +[**`/thermostats/set_hvac_mode`**](./set_hvac_mode.md) Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/set_temperature_threshold`](./set_temperature_threshold.md) +[**`/thermostats/set_temperature_threshold`**](./set_temperature_threshold.md) Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. -### [`/thermostats/update_climate_preset`](./update_climate_preset.md) +[**`/thermostats/update_climate_preset`**](./update_climate_preset.md) Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index e806d3a3b..b5e6c1bc4 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -78,18 +78,18 @@ ID of the [thermostat schedule](../../../capability-guides/thermostats/creating- --- ## Endpoints -### [`/thermostats/schedules/create`](./create.md) +[**`/thermostats/schedules/create`**](./create.md) Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/schedules/delete`](./delete.md) +[**`/thermostats/schedules/delete`**](./delete.md) Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/schedules/get`](./get.md) +[**`/thermostats/schedules/get`**](./get.md) Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -### [`/thermostats/schedules/list`](./list.md) +[**`/thermostats/schedules/list`**](./list.md) Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -### [`/thermostats/schedules/update`](./update.md) +[**`/thermostats/schedules/update`**](./update.md) Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index 51f7e82e7..768c0f026 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -4,9 +4,9 @@ The Thermostat Simulations route contains the following resources: ## Endpoints -### [`/thermostats/simulate/hvac_mode_adjusted`](./hvac_mode_adjusted.md) +[**`/thermostats/simulate/hvac_mode_adjusted`**](./hvac_mode_adjusted.md) Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). -### [`/thermostats/simulate/temperature_reached`](./temperature_reached.md) +[**`/thermostats/simulate/temperature_reached`**](./temperature_reached.md) Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 63204399e..bc8520aa5 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -54,39 +54,39 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th --- ## Endpoints -### [`/user_identities/add_acs_user`](./add_acs_user.md) +[**`/user_identities/add_acs_user`**](./add_acs_user.md) Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -### [`/user_identities/create`](./create.md) +[**`/user_identities/create`**](./create.md) Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -### [`/user_identities/delete`](./delete.md) +[**`/user_identities/delete`**](./delete.md) Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. -### [`/user_identities/get`](./get.md) +[**`/user_identities/get`**](./get.md) Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -### [`/user_identities/grant_access_to_device`](./grant_access_to_device.md) +[**`/user_identities/grant_access_to_device`**](./grant_access_to_device.md) Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). -### [`/user_identities/list`](./list.md) +[**`/user_identities/list`**](./list.md) Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -### [`/user_identities/list_accessible_devices`](./list_accessible_devices.md) +[**`/user_identities/list_accessible_devices`**](./list_accessible_devices.md) Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -### [`/user_identities/list_acs_systems`](./list_acs_systems.md) +[**`/user_identities/list_acs_systems`**](./list_acs_systems.md) Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -### [`/user_identities/list_acs_users`](./list_acs_users.md) +[**`/user_identities/list_acs_users`**](./list_acs_users.md) Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -### [`/user_identities/remove_acs_user`](./remove_acs_user.md) +[**`/user_identities/remove_acs_user`**](./remove_acs_user.md) Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -### [`/user_identities/revoke_access_to_device`](./revoke_access_to_device.md) +[**`/user_identities/revoke_access_to_device`**](./revoke_access_to_device.md) Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -### [`/user_identities/update`](./update.md) +[**`/user_identities/update`**](./update.md) diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index bee340225..286fcf4ba 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -40,16 +40,16 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Endpoints -### [`/user_identities/enrollment_automations/delete`](./delete.md) +[**`/user_identities/enrollment_automations/delete`**](./delete.md) Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). -### [`/user_identities/enrollment_automations/get`](./get.md) +[**`/user_identities/enrollment_automations/get`**](./get.md) Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -### [`/user_identities/enrollment_automations/launch`](./launch.md) +[**`/user_identities/enrollment_automations/launch`**](./launch.md) Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -### [`/user_identities/enrollment_automations/list`](./list.md) +[**`/user_identities/enrollment_automations/list`**](./list.md) Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). @@ -57,7 +57,7 @@ Returns a list of all [enrollment automations](https://docs.seam.co/latest/capab ## Events -### `enrollment_automation.deleted` +**`enrollment_automation.deleted`** An [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) was deleted. From ce786ef8ee746010814fe6d81d9229228417bd27 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:40:57 -0400 Subject: [PATCH 084/233] Update property-nested.hbs --- src/layouts/partials/property-nested.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs index c9f0e4479..4a537daf5 100644 --- a/src/layouts/partials/property-nested.hbs +++ b/src/layouts/partials/property-nested.hbs @@ -1,4 +1,5 @@ {{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} +PROPERTY NESTED {{> property-nested-internal}} {{#if listProperties}} {{#each listProperties}} From 0d0e09400fb66984a0d579f31006b1ccb9d79964 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:41:15 -0400 Subject: [PATCH 085/233] Update property-nested-internal.hbs --- src/layouts/partials/property-nested-internal.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/partials/property-nested-internal.hbs b/src/layouts/partials/property-nested-internal.hbs index c33659d37..3f0eb04f3 100644 --- a/src/layouts/partials/property-nested-internal.hbs +++ b/src/layouts/partials/property-nested-internal.hbs @@ -1,4 +1,5 @@ {{#if description}} +PROPERTY NESTED INTERNAL {{description}} {{/if}} From 30866f34c82526d37947280bcdfa768b8906780d Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:41:33 -0400 Subject: [PATCH 086/233] Update property-content.hbs --- src/layouts/partials/property-content.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs index aa3ab81a3..e056c82c1 100644 --- a/src/layouts/partials/property-content.hbs +++ b/src/layouts/partials/property-content.hbs @@ -1,4 +1,5 @@ {{#if description}} +PROPERTY CONTENT {{description}} {{/if}} From 772865154f34ccde2df67cc344e6b85821ff4f9f Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:41:59 -0400 Subject: [PATCH 087/233] Update property-collapsible.hbs --- src/layouts/partials/property-collapsible.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs index 174e0f618..c80b64d77 100644 --- a/src/layouts/partials/property-collapsible.hbs +++ b/src/layouts/partials/property-collapsible.hbs @@ -1,5 +1,6 @@
{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} +PROPERTY COLLAPSIBLE {{> property-content}}
From 98ab9b966eb02fc747525e1de4edad599f52d321 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 16:43:04 +0000 Subject: [PATCH 088/233] ci: Generate docs --- docs/api/access_codes/README.md | 262 ++++++++++++++++++ docs/api/acs/access_groups/README.md | 20 ++ docs/api/acs/credentials/README.md | 57 ++++ docs/api/acs/encoders/README.md | 36 +++ docs/api/acs/entrances/README.md | 58 ++++ docs/api/acs/systems/README.md | 47 ++++ docs/api/acs/users/README.md | 18 ++ docs/api/phones/README.md | 29 ++ docs/api/thermostats/schedules/README.md | 4 + .../enrollment_automations/README.md | 11 + 10 files changed, 542 insertions(+) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 705d16cf7..b8472d131 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -471,6 +471,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -478,6 +480,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -485,6 +489,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -492,6 +498,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -499,6 +507,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -506,11 +516,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -518,6 +531,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -531,6 +546,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -538,6 +555,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -545,6 +564,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -552,6 +573,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -559,6 +582,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -566,11 +591,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -578,6 +606,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -591,6 +621,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -598,6 +630,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
code String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -605,6 +639,8 @@ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-l
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -612,6 +648,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -619,6 +657,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -626,6 +666,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -633,11 +675,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -645,6 +690,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -658,6 +705,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -665,6 +714,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
code String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -672,6 +723,8 @@ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-l
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -679,6 +732,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -686,6 +741,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -693,6 +750,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -700,11 +759,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -712,6 +774,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -725,6 +789,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -732,6 +798,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -739,6 +807,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -746,6 +816,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -753,6 +825,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -760,11 +834,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -772,6 +849,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -785,6 +864,8 @@ There was an unusually long delay in setting an [access code](https://docs.seam.
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -792,6 +873,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -799,6 +882,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -806,6 +891,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -813,6 +900,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -820,11 +909,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -832,6 +924,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -845,6 +939,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -852,6 +948,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -859,6 +957,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -866,6 +966,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -873,6 +975,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -880,11 +984,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -892,6 +999,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -905,6 +1014,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -912,6 +1023,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
code String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -919,6 +1032,8 @@ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-l
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -926,6 +1041,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -933,6 +1050,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -940,6 +1059,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -947,11 +1068,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -959,6 +1083,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -972,6 +1098,8 @@ There was an unusually long delay in removing an [access code](https://docs.seam
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -979,6 +1107,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -986,6 +1116,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -993,6 +1125,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1000,6 +1134,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -1007,11 +1143,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -1019,6 +1158,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1032,6 +1173,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1039,6 +1182,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1046,6 +1191,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -1053,6 +1200,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1060,6 +1209,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -1067,11 +1218,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -1079,6 +1233,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1092,6 +1248,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1099,6 +1257,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1106,6 +1266,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -1113,6 +1275,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1120,6 +1284,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -1127,11 +1293,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -1139,6 +1308,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1152,6 +1323,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1159,6 +1332,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1166,6 +1341,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -1173,6 +1350,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1180,6 +1359,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -1187,11 +1368,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -1199,6 +1383,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1212,6 +1398,8 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1219,11 +1407,14 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
backup_access_code_id String +PROPERTY COLLAPSIBLE
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1231,6 +1422,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -1238,6 +1431,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1245,6 +1440,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -1252,11 +1449,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -1264,6 +1464,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1277,6 +1479,8 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1284,6 +1488,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1291,6 +1497,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -1298,6 +1506,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1305,6 +1515,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -1312,11 +1524,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -1324,6 +1539,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1337,6 +1554,8 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1344,6 +1563,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1351,6 +1572,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -1358,6 +1581,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1365,6 +1590,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -1372,11 +1599,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -1384,6 +1614,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1397,6 +1629,8 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1404,6 +1638,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1411,6 +1647,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -1418,6 +1656,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1425,6 +1665,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -1432,11 +1674,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -1444,6 +1689,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1457,6 +1704,8 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
access_code_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1464,6 +1713,8 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1471,6 +1722,8 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -1478,6 +1731,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1485,6 +1740,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -1492,11 +1749,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -1504,6 +1764,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT 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 a0fcf0a54..a6d76bb97 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -104,6 +104,8 @@ Warnings associated with the `acs_access_group`.
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which Seam created the warning.
@@ -111,6 +113,8 @@ Date and time at which Seam created the warning.
message String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
@@ -118,6 +122,8 @@ Detailed description of the warning. Provides insights into the issue and potent
warning_code String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
@@ -161,11 +167,14 @@ An ACS access group was deleted.
acs_access_group_id UUID +PROPERTY COLLAPSIBLE
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -173,6 +182,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -180,6 +191,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -187,6 +200,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -194,11 +209,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -206,6 +224,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT 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 020e2600e..030ba4fcc 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -60,26 +60,31 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
door_names List of Strings +PROPERTY COLLAPSIBLE
endpoint_id String +PROPERTY COLLAPSIBLE
key_id String +PROPERTY COLLAPSIBLE
key_issuing_request_id String +PROPERTY COLLAPSIBLE
override_guest_acs_entrance_ids List of Strings +PROPERTY COLLAPSIBLE
@@ -122,11 +127,13 @@ Errors associated with the [credential](../../../capability-guides/access-system
error_code String +PROPERTY COLLAPSIBLE
message String +PROPERTY COLLAPSIBLE
--- @@ -218,11 +225,13 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
auto_join Boolean +PROPERTY COLLAPSIBLE
card_function_type Enum +PROPERTY COLLAPSIBLE
Possible enum values: @@ -236,31 +245,37 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
card_id String +PROPERTY COLLAPSIBLE
common_acs_entrance_ids List of UUIDs +PROPERTY COLLAPSIBLE
credential_id String +PROPERTY COLLAPSIBLE
guest_acs_entrance_ids List of UUIDs +PROPERTY COLLAPSIBLE
is_valid Boolean +PROPERTY COLLAPSIBLE
joiner_acs_credential_ids List of UUIDs +PROPERTY COLLAPSIBLE
@@ -353,11 +368,14 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id UUID +PROPERTY COLLAPSIBLE
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -365,6 +383,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -372,6 +392,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -379,6 +401,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -386,11 +410,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -398,6 +425,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -411,11 +440,14 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id UUID +PROPERTY COLLAPSIBLE
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -423,6 +455,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -430,6 +464,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -437,6 +473,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -444,11 +482,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -456,6 +497,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -469,11 +512,14 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id UUID +PROPERTY COLLAPSIBLE
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -481,6 +527,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -488,6 +536,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -495,6 +545,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -502,11 +554,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -514,6 +569,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT 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 561e5c9cd..3c3087066 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -53,6 +53,8 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which Seam created the error.
@@ -60,6 +62,8 @@ Date and time at which Seam created the error.
error_code String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -67,6 +71,8 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
message String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
@@ -101,6 +107,8 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
@@ -108,6 +116,8 @@ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-c
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -115,6 +125,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -122,6 +134,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -129,6 +143,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -136,11 +152,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -148,6 +167,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -161,6 +182,8 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
@@ -168,6 +191,8 @@ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-c
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -175,6 +200,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -182,6 +209,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -189,6 +218,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -196,11 +227,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -208,6 +242,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT 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 218c0310d..43917f4c1 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -33,16 +33,19 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
door_name String +PROPERTY COLLAPSIBLE
door_number Number +PROPERTY COLLAPSIBLE
door_type Enum +PROPERTY COLLAPSIBLE
Possible enum values: @@ -58,11 +61,13 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
pms_id String +PROPERTY COLLAPSIBLE
stand_open Boolean +PROPERTY COLLAPSIBLE
@@ -90,6 +95,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
access_point_name String +PROPERTY COLLAPSIBLE
@@ -102,6 +108,8 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
error_code String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -109,6 +117,8 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
message String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
@@ -125,21 +135,25 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
accessibility_type String +PROPERTY COLLAPSIBLE
door_name String +PROPERTY COLLAPSIBLE
door_type String +PROPERTY COLLAPSIBLE
is_connected Boolean +PROPERTY COLLAPSIBLE
@@ -155,41 +169,49 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
battery_level String +PROPERTY COLLAPSIBLE
door_name String +PROPERTY COLLAPSIBLE
intrusion_alarm Boolean +PROPERTY COLLAPSIBLE
left_open_alarm Boolean +PROPERTY COLLAPSIBLE
lock_type String +PROPERTY COLLAPSIBLE
locked_state String +PROPERTY COLLAPSIBLE
online Boolean +PROPERTY COLLAPSIBLE
privacy_mode Boolean +PROPERTY COLLAPSIBLE
@@ -205,16 +227,19 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
door_description String +PROPERTY COLLAPSIBLE
door_name String +PROPERTY COLLAPSIBLE
ext_door_id String +PROPERTY COLLAPSIBLE
@@ -230,6 +255,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
door_category Enum +PROPERTY COLLAPSIBLE
Possible enum values: @@ -246,17 +272,21 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
door_name String +PROPERTY COLLAPSIBLE
profiles List of Objects +PROPERTY COLLAPSIBLE - visionline_door_profile_id String +PROPERTY NESTED - visionline_door_profile_type Enum +PROPERTY NESTED
@@ -299,11 +329,14 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id UUID +PROPERTY COLLAPSIBLE
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -311,6 +344,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -318,6 +353,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -325,6 +362,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -332,11 +371,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -344,6 +386,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -357,11 +401,14 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id UUID +PROPERTY COLLAPSIBLE
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -369,6 +416,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -376,6 +425,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -383,6 +434,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -390,11 +443,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -402,6 +458,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT 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 02914b0dd..27f668842 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -134,6 +134,8 @@ Indicates whether the `acs_system` is a credential manager.
time_zone String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
@@ -190,6 +192,8 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
lan_address String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
@@ -197,6 +201,8 @@ IP address or hostname of the main Visionline server relative to [Seam Bridge](.
mobile_access_uuid String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
@@ -204,6 +210,8 @@ Keyset loaded into a reader. Mobile keys and reader administration tools securel
system_id String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
@@ -302,6 +310,8 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -309,6 +319,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -316,6 +328,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -323,6 +337,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -330,11 +346,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -342,6 +361,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -355,6 +376,8 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -362,6 +385,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -369,6 +394,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -376,6 +403,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -383,11 +412,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -395,6 +427,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -408,6 +442,8 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -415,6 +451,8 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -422,6 +460,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -429,6 +469,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -436,11 +478,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -448,6 +493,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT 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 d9cd8fc68..c196f207e 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -23,6 +23,8 @@ For details about how to configure `acs_user`s in your access control system, se
ends_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT 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.
@@ -30,6 +32,8 @@ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org
starts_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
@@ -266,6 +270,8 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
acs_system_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -273,11 +279,14 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
acs_user_id UUID +PROPERTY COLLAPSIBLE
connected_account_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -285,6 +294,8 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -292,6 +303,8 @@ Date and time at which the event was created.
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -299,11 +312,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -311,6 +327,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index ad479234e..6be3c5f0f 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -54,11 +54,13 @@ Errors associated with the `phone`.
error_code String +PROPERTY COLLAPSIBLE
message String +PROPERTY COLLAPSIBLE
--- @@ -79,6 +81,8 @@ Properties of the phone.
assa_abloy_credential_service_metadata Object +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ASSA ABLOY Credential Service metadata for the phone.
@@ -86,16 +90,22 @@ ASSA ABLOY Credential Service metadata for the phone.
assa_abloy_credential_service_metadata.endpoints List of Objects +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Endpoints associated with the phone. - endpoint_id String +PROPERTY NESTED +PROPERTY NESTED INTERNAL ID of the associated endpoint. - is_active Boolean +PROPERTY NESTED +PROPERTY NESTED INTERNAL Indicated whether the endpoint is active. @@ -105,6 +115,8 @@ Endpoints associated with the phone.
assa_abloy_credential_service_metadata.has_active_endpoint Boolean +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Indicates whether the credential service has active endpoints associated with the phone.
@@ -112,6 +124,8 @@ Indicates whether the credential service has active endpoints associated with th
salto_space_credential_service_metadata Object +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Salto Space credential service metadata for the phone.
@@ -119,6 +133,8 @@ Salto Space credential service metadata for the phone.
salto_space_credential_service_metadata.has_active_phone Boolean +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Indicates whether the credential service has an active associated phone.
@@ -133,11 +149,13 @@ Warnings associated with the `phone`.
message String +PROPERTY COLLAPSIBLE
warning_code String +PROPERTY COLLAPSIBLE
--- @@ -170,6 +188,8 @@ A phone device was deactivated.
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -177,6 +197,8 @@ Date and time at which the event was created.
device_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -184,6 +206,8 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -191,11 +215,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -203,6 +230,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index b5e6c1bc4..117f224d4 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -40,6 +40,8 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
error_code String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -47,6 +49,8 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
message String +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 286fcf4ba..c194da9bc 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -64,6 +64,8 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
created_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event was created.
@@ -71,6 +73,8 @@ Date and time at which the event was created.
enrollment_automation_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT 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).
@@ -78,6 +82,8 @@ ID of the [enrollment automation](../../../capability-guides/mobile-access/issui
event_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the event.
@@ -85,11 +91,14 @@ ID of the event.
event_type String +PROPERTY COLLAPSIBLE
occurred_at Datetime +PROPERTY COLLAPSIBLE +PROPERTY CONTENT Date and time at which the event occurred.
@@ -97,6 +106,8 @@ Date and time at which the event occurred.
workspace_id UUID +PROPERTY COLLAPSIBLE +PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
From 2d975585a4ba68e8ba9c5c7d0b72e08fa09b1430 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:46:05 -0400 Subject: [PATCH 089/233] Update api-route.hbs --- src/layouts/api-route.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index e66344229..5191bd337 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -35,6 +35,7 @@ The {{title}} route contains the following resources: [**`{{path}}`**](./{{name}}.md) {{description}} + {{/each}} {{#if events.length}} From 5d1c53d0d7284c1f27aaf45030a39f18149c43fb Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:46:52 -0400 Subject: [PATCH 090/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 3bbbe1855..445acc79b 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -49,6 +49,7 @@ This object has no properties. {{> property-collapsible this}} {{/each}}
+ {{/if}} {{/unless}} {{#if listProperties}} From cd95cbb1291e025f725b51a1909fcfc4eee01a3d Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:47:20 -0400 Subject: [PATCH 091/233] Update property-collapsible.hbs --- src/layouts/partials/property-collapsible.hbs | 1 - 1 file changed, 1 deletion(-) diff --git a/src/layouts/partials/property-collapsible.hbs b/src/layouts/partials/property-collapsible.hbs index c80b64d77..174e0f618 100644 --- a/src/layouts/partials/property-collapsible.hbs +++ b/src/layouts/partials/property-collapsible.hbs @@ -1,6 +1,5 @@
{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} -PROPERTY COLLAPSIBLE {{> property-content}}
From 3ae17f506a80607cea7cc8aee83965f9b153d9bc Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:48:05 -0400 Subject: [PATCH 092/233] Update property-content.hbs --- src/layouts/partials/property-content.hbs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs index e056c82c1..7c392d42a 100644 --- a/src/layouts/partials/property-content.hbs +++ b/src/layouts/partials/property-content.hbs @@ -1,5 +1,4 @@ {{#if description}} -PROPERTY CONTENT {{description}} {{/if}} @@ -10,7 +9,7 @@ PROPERTY CONTENT {{#if enumValues}}
-Possible enum values: +Enum values: {{#each enumValues}} - `{{this}}` From 03b65e4421a18adf4744b4b14d8bdaaf621fbd3a Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:48:21 -0400 Subject: [PATCH 093/233] Update property-nested-internal.hbs --- src/layouts/partials/property-nested-internal.hbs | 1 - 1 file changed, 1 deletion(-) diff --git a/src/layouts/partials/property-nested-internal.hbs b/src/layouts/partials/property-nested-internal.hbs index 3f0eb04f3..c33659d37 100644 --- a/src/layouts/partials/property-nested-internal.hbs +++ b/src/layouts/partials/property-nested-internal.hbs @@ -1,5 +1,4 @@ {{#if description}} -PROPERTY NESTED INTERNAL {{description}} {{/if}} From b5a6521f0565b513d931cc1252a7727ed0c2ce25 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:48:38 -0400 Subject: [PATCH 094/233] Update property-nested.hbs --- src/layouts/partials/property-nested.hbs | 1 - 1 file changed, 1 deletion(-) diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs index 4a537daf5..c9f0e4479 100644 --- a/src/layouts/partials/property-nested.hbs +++ b/src/layouts/partials/property-nested.hbs @@ -1,5 +1,4 @@ {{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} -PROPERTY NESTED {{> property-nested-internal}} {{#if listProperties}} {{#each listProperties}} From 3bdaed81ea2617f7972bbac1a28ad346e02e828d Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 16:49:36 +0000 Subject: [PATCH 095/233] ci: Generate docs --- docs/api/access_codes/README.md | 262 ------------------ docs/api/acs/access_groups/README.md | 26 +- docs/api/acs/credentials/README.md | 69 +---- docs/api/acs/encoders/README.md | 39 +-- docs/api/acs/encoders/simulate/README.md | 4 + docs/api/acs/entrances/README.md | 72 +---- docs/api/acs/systems/README.md | 52 +--- docs/api/acs/users/README.md | 30 +- docs/api/phones/README.md | 33 +-- docs/api/phones/simulate/README.md | 1 + docs/api/thermostats/README.md | 13 + docs/api/thermostats/schedules/README.md | 9 +- docs/api/thermostats/simulate/README.md | 2 + docs/api/user_identities/README.md | 12 + .../enrollment_automations/README.md | 15 +- 15 files changed, 94 insertions(+), 545 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index b8472d131..705d16cf7 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -471,8 +471,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -480,8 +478,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -489,8 +485,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -498,8 +492,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -507,8 +499,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -516,14 +506,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -531,8 +518,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -546,8 +531,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -555,8 +538,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -564,8 +545,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -573,8 +552,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -582,8 +559,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -591,14 +566,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -606,8 +578,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -621,8 +591,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -630,8 +598,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
code String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -639,8 +605,6 @@ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-l
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -648,8 +612,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -657,8 +619,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -666,8 +626,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -675,14 +633,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -690,8 +645,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -705,8 +658,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -714,8 +665,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
code String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -723,8 +672,6 @@ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-l
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -732,8 +679,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -741,8 +686,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -750,8 +693,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -759,14 +700,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -774,8 +712,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -789,8 +725,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -798,8 +732,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -807,8 +739,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -816,8 +746,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -825,8 +753,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -834,14 +760,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -849,8 +772,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -864,8 +785,6 @@ There was an unusually long delay in setting an [access code](https://docs.seam.
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -873,8 +792,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -882,8 +799,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -891,8 +806,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -900,8 +813,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -909,14 +820,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -924,8 +832,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -939,8 +845,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -948,8 +852,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -957,8 +859,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -966,8 +866,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -975,8 +873,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -984,14 +880,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -999,8 +892,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1014,8 +905,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1023,8 +912,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
code String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1032,8 +919,6 @@ Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-l
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1041,8 +926,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1050,8 +933,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1059,8 +940,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1068,14 +947,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1083,8 +959,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1098,8 +972,6 @@ There was an unusually long delay in removing an [access code](https://docs.seam
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1107,8 +979,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1116,8 +986,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1125,8 +993,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1134,8 +1000,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1143,14 +1007,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1158,8 +1019,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1173,8 +1032,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1182,8 +1039,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1191,8 +1046,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1200,8 +1053,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1209,8 +1060,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1218,14 +1067,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1233,8 +1079,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1248,8 +1092,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1257,8 +1099,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1266,8 +1106,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1275,8 +1113,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1284,8 +1120,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1293,14 +1127,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1308,8 +1139,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1323,8 +1152,6 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1332,8 +1159,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1341,8 +1166,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1350,8 +1173,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1359,8 +1180,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1368,14 +1187,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1383,8 +1199,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1398,8 +1212,6 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1407,14 +1219,11 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
backup_access_code_id String -PROPERTY COLLAPSIBLE
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1422,8 +1231,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1431,8 +1238,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1440,8 +1245,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1449,14 +1252,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1464,8 +1264,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1479,8 +1277,6 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1488,8 +1284,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1497,8 +1291,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1506,8 +1298,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1515,8 +1305,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1524,14 +1312,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1539,8 +1324,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1554,8 +1337,6 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1563,8 +1344,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1572,8 +1351,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1581,8 +1358,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1590,8 +1365,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1599,14 +1372,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1614,8 +1384,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1629,8 +1397,6 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1638,8 +1404,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1647,8 +1411,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1656,8 +1418,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1665,8 +1425,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1674,14 +1432,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1689,8 +1444,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
@@ -1704,8 +1457,6 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
access_code_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
@@ -1713,8 +1464,6 @@ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-lock
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../core-concepts/connected-accounts/README.md).
@@ -1722,8 +1471,6 @@ ID of the [connected account](../../core-concepts/connected-accounts/README.md).
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -1731,8 +1478,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -1740,8 +1485,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -1749,14 +1492,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -1764,8 +1504,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT 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 a6d76bb97..ab7a78eeb 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -104,8 +104,6 @@ Warnings associated with the `acs_access_group`.
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which Seam created the warning.
@@ -113,8 +111,6 @@ Date and time at which Seam created the warning.
message String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
@@ -122,8 +118,6 @@ Detailed description of the warning. Provides insights into the issue and potent
warning_code String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
@@ -140,22 +134,28 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains [**`/acs/access_groups/add_user`**](./add_user.md) Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + [**`/acs/access_groups/get`**](./get.md) Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + [**`/acs/access_groups/list`**](./list.md) Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + [**`/acs/access_groups/list_accessible_entrances`**](./list_accessible_entrances.md) Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + [**`/acs/access_groups/list_users`**](./list_users.md) Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + [**`/acs/access_groups/remove_user`**](./remove_user.md) Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + --- ## Events @@ -167,14 +167,11 @@ An ACS access group was deleted.
acs_access_group_id UUID -PROPERTY COLLAPSIBLE
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -182,8 +179,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -191,8 +186,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -200,8 +193,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -209,14 +200,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -224,8 +212,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT 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 030ba4fcc..666df7805 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -60,34 +60,30 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
door_names List of Strings -PROPERTY COLLAPSIBLE
endpoint_id String -PROPERTY COLLAPSIBLE
key_id String -PROPERTY COLLAPSIBLE
key_issuing_request_id String -PROPERTY COLLAPSIBLE
override_guest_acs_entrance_ids List of Strings -PROPERTY COLLAPSIBLE
+ --- **`card_number`** *String* @@ -127,13 +123,11 @@ Errors associated with the [credential](../../../capability-guides/access-system
error_code String -PROPERTY COLLAPSIBLE
message String -PROPERTY COLLAPSIBLE
--- @@ -225,16 +219,14 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
auto_join Boolean -PROPERTY COLLAPSIBLE
card_function_type Enum -PROPERTY COLLAPSIBLE
-Possible enum values: +Enum values: - `guest` - `staff` @@ -245,40 +237,35 @@ PROPERTY COLLAPSIBLE
card_id String -PROPERTY COLLAPSIBLE
common_acs_entrance_ids List of UUIDs -PROPERTY COLLAPSIBLE
credential_id String -PROPERTY COLLAPSIBLE
guest_acs_entrance_ids List of UUIDs -PROPERTY COLLAPSIBLE
is_valid Boolean -PROPERTY COLLAPSIBLE
joiner_acs_credential_ids List of UUIDs -PROPERTY COLLAPSIBLE
+ --- [**`warnings`**](./#warnings-1) *List* *of Objects* @@ -335,28 +322,36 @@ Access permissions for the [credential](../../../capability-guides/access-system [**`/acs/credentials/assign`**](./assign.md) Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + [**`/acs/credentials/create`**](./create.md) Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + [**`/acs/credentials/delete`**](./delete.md) Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + [**`/acs/credentials/get`**](./get.md) Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + [**`/acs/credentials/list`**](./list.md) Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). + [**`/acs/credentials/list_accessible_entrances`**](./list_accessible_entrances.md) Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. + [**`/acs/credentials/unassign`**](./unassign.md) Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + [**`/acs/credentials/update`**](./update.md) Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + --- ## Events @@ -368,14 +363,11 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id UUID -PROPERTY COLLAPSIBLE
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -383,8 +375,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -392,8 +382,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -401,8 +389,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -410,14 +396,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -425,8 +408,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -440,14 +421,11 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id UUID -PROPERTY COLLAPSIBLE
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -455,8 +433,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -464,8 +440,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -473,8 +447,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -482,14 +454,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -497,8 +466,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -512,14 +479,11 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
acs_credential_id UUID -PROPERTY COLLAPSIBLE
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -527,8 +491,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -536,8 +498,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -545,8 +505,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -554,14 +512,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -569,8 +524,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT 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 3c3087066..3b981c22c 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -53,8 +53,6 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which Seam created the error.
@@ -62,8 +60,6 @@ Date and time at which Seam created the error.
error_code String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -71,8 +67,6 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
message String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
@@ -89,13 +83,16 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains [**`/acs/encoders/encode_credential`**](./encode_credential.md) Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + [**`/acs/encoders/list`**](./list.md) Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + [**`/acs/encoders/scan_credential`**](./scan_credential.md) Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + --- ## Events @@ -107,8 +104,6 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
@@ -116,8 +111,6 @@ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-c
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -125,8 +118,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -134,8 +125,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -143,8 +132,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -152,14 +139,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -167,8 +151,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -182,8 +164,6 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
acs_encoder_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
@@ -191,8 +171,6 @@ ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-c
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -200,8 +178,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -209,8 +185,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -218,8 +192,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -227,14 +199,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -242,8 +211,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index 07f9962c1..83917ca8e 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -7,12 +7,16 @@ The Encoder Simulations route contains the following resources: [**`/acs/encoders/simulate/next_credential_encode_will_fail`**](./next_credential_encode_will_fail.md) Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + [**`/acs/encoders/simulate/next_credential_encode_will_succeed`**](./next_credential_encode_will_succeed.md) Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + [**`/acs/encoders/simulate/next_credential_scan_will_fail`**](./next_credential_scan_will_fail.md) Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + [**`/acs/encoders/simulate/next_credential_scan_will_succeed`**](./next_credential_scan_will_succeed.md) Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 43917f4c1..d2daf32fb 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -33,22 +33,19 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
door_name String -PROPERTY COLLAPSIBLE
door_number Number -PROPERTY COLLAPSIBLE
door_type Enum -PROPERTY COLLAPSIBLE
-Possible enum values: +Enum values: - `CommonDoor` - `EntranceDoor` @@ -61,16 +58,15 @@ PROPERTY COLLAPSIBLE
pms_id String -PROPERTY COLLAPSIBLE
stand_open Boolean -PROPERTY COLLAPSIBLE
+ --- **`created_at`** *Datetime* @@ -95,10 +91,10 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
access_point_name String -PROPERTY COLLAPSIBLE
+ --- **`errors`** *List* *of Objects* @@ -108,8 +104,6 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
error_code String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -117,8 +111,6 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
message String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
@@ -135,28 +127,25 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
accessibility_type String -PROPERTY COLLAPSIBLE
door_name String -PROPERTY COLLAPSIBLE
door_type String -PROPERTY COLLAPSIBLE
is_connected Boolean -PROPERTY COLLAPSIBLE
+ --- **`salto_ks_metadata`** *Object* @@ -169,52 +158,45 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
battery_level String -PROPERTY COLLAPSIBLE
door_name String -PROPERTY COLLAPSIBLE
intrusion_alarm Boolean -PROPERTY COLLAPSIBLE
left_open_alarm Boolean -PROPERTY COLLAPSIBLE
lock_type String -PROPERTY COLLAPSIBLE
locked_state String -PROPERTY COLLAPSIBLE
online Boolean -PROPERTY COLLAPSIBLE
privacy_mode Boolean -PROPERTY COLLAPSIBLE
+ --- **`salto_space_metadata`** *Object* @@ -227,22 +209,20 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
door_description String -PROPERTY COLLAPSIBLE
door_name String -PROPERTY COLLAPSIBLE
ext_door_id String -PROPERTY COLLAPSIBLE
+ --- **`visionline_metadata`** *Object* @@ -255,10 +235,9 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
door_category Enum -PROPERTY COLLAPSIBLE
-Possible enum values: +Enum values: - `entrance` - `guest` @@ -272,21 +251,17 @@ PROPERTY COLLAPSIBLE
door_name String -PROPERTY COLLAPSIBLE
profiles List of Objects -PROPERTY COLLAPSIBLE - visionline_door_profile_id String -PROPERTY NESTED - visionline_door_profile_type Enum -PROPERTY NESTED
@@ -302,22 +277,27 @@ PROPERTY NESTED
+ --- ## Endpoints [**`/acs/entrances/get`**](./get.md) Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + [**`/acs/entrances/grant_access`**](./grant_access.md) + [**`/acs/entrances/list`**](./list.md) Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). + [**`/acs/entrances/list_credentials_with_access`**](./list_credentials_with_access.md) Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + --- ## Events @@ -329,14 +309,11 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id UUID -PROPERTY COLLAPSIBLE
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -344,8 +321,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -353,8 +328,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -362,8 +335,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -371,14 +342,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -386,8 +354,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -401,14 +367,11 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
acs_entrance_id UUID -PROPERTY COLLAPSIBLE
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -416,8 +379,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -425,8 +386,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -434,8 +393,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -443,14 +400,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -458,8 +412,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT 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 27f668842..4257bbb45 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -134,13 +134,12 @@ Indicates whether the `acs_system` is a credential manager.
time_zone String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located.
+ --- **`name`** *String* @@ -192,8 +191,6 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
lan_address String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network.
@@ -201,8 +198,6 @@ IP address or hostname of the main Visionline server relative to [Seam Bridge](.
mobile_access_uuid String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset.
@@ -210,13 +205,12 @@ Keyset loaded into a reader. Mobile keys and reader administration tools securel
system_id String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager.
+ --- [**`warnings`**](./#warnings-1) *List* *of Objects* @@ -291,14 +285,17 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui [**`/acs/systems/get`**](./get.md) Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + [**`/acs/systems/list`**](./list.md) Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). + [**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md) Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + --- ## Events @@ -310,8 +307,6 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -319,8 +314,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -328,8 +321,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -337,8 +328,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -346,14 +335,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -361,8 +347,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -376,8 +360,6 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -385,8 +367,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -394,8 +374,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -403,8 +381,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -412,14 +388,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -427,8 +400,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
@@ -442,8 +413,6 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -451,8 +420,6 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -460,8 +427,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -469,8 +434,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -478,14 +441,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -493,8 +453,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT 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 c196f207e..0394e94db 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -23,8 +23,6 @@ For details about how to configure `acs_user`s in your access control system, se
ends_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT 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.
@@ -32,13 +30,12 @@ Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org
starts_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+ --- **`acs_system_id`** *UUID* @@ -228,37 +225,48 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc [**`/acs/users/add_to_access_group`**](./add_to_access_group.md) Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + [**`/acs/users/create`**](./create.md) Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + [**`/acs/users/delete`**](./delete.md) Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). + [**`/acs/users/get`**](./get.md) Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + [**`/acs/users/list`**](./list.md) Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + [**`/acs/users/list_accessible_entrances`**](./list_accessible_entrances.md) Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. + [**`/acs/users/remove_from_access_group`**](./remove_from_access_group.md) Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + [**`/acs/users/revoke_access_to_all_entrances`**](./revoke_access_to_all_entrances.md) Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + [**`/acs/users/suspend`**](./suspend.md) [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + [**`/acs/users/unsuspend`**](./unsuspend.md) [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + [**`/acs/users/update`**](./update.md) Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + --- ## Events @@ -270,8 +278,6 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
acs_system_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems).
@@ -279,14 +285,11 @@ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-syst
acs_user_id UUID -PROPERTY COLLAPSIBLE
connected_account_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [connected account](../../../core-concepts/connected-accounts/README.md).
@@ -294,8 +297,6 @@ ID of the [connected account](../../../core-concepts/connected-accounts/README.m
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -303,8 +304,6 @@ Date and time at which the event was created.
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -312,14 +311,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -327,8 +323,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 6be3c5f0f..fe2c20347 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -54,13 +54,11 @@ Errors associated with the `phone`.
error_code String -PROPERTY COLLAPSIBLE
message String -PROPERTY COLLAPSIBLE
--- @@ -81,8 +79,6 @@ Properties of the phone.
assa_abloy_credential_service_metadata Object -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ASSA ABLOY Credential Service metadata for the phone.
@@ -90,22 +86,16 @@ ASSA ABLOY Credential Service metadata for the phone.
assa_abloy_credential_service_metadata.endpoints List of Objects -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Endpoints associated with the phone. - endpoint_id String -PROPERTY NESTED -PROPERTY NESTED INTERNAL ID of the associated endpoint. - is_active Boolean -PROPERTY NESTED -PROPERTY NESTED INTERNAL Indicated whether the endpoint is active. @@ -115,8 +105,6 @@ PROPERTY NESTED INTERNAL
assa_abloy_credential_service_metadata.has_active_endpoint Boolean -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Indicates whether the credential service has active endpoints associated with the phone.
@@ -124,8 +112,6 @@ Indicates whether the credential service has active endpoints associated with th
salto_space_credential_service_metadata Object -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Salto Space credential service metadata for the phone.
@@ -133,13 +119,12 @@ Salto Space credential service metadata for the phone.
salto_space_credential_service_metadata.has_active_phone Boolean -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Indicates whether the credential service has an active associated phone.
+ --- **`warnings`** *List* *of Objects* @@ -149,13 +134,11 @@ Warnings associated with the `phone`.
message String -PROPERTY COLLAPSIBLE
warning_code String -PROPERTY COLLAPSIBLE
--- @@ -170,13 +153,16 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th [**`/phones/deactivate`**](./deactivate.md) Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). + [**`/phones/get`**](./get.md) Returns a single phone entry matching the provided `device_id`. + [**`/phones/list`**](./list.md) Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. + --- ## Events @@ -188,8 +174,6 @@ A phone device was deactivated.
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -197,8 +181,6 @@ Date and time at which the event was created.
device_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [device](../../core-concepts/devices/README.md).
@@ -206,8 +188,6 @@ ID of the [device](../../core-concepts/devices/README.md).
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -215,14 +195,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -230,8 +207,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../core-concepts/workspaces/README.md).
diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index a30fed7e3..78973f68f 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -7,3 +7,4 @@ The Phone Simulations route contains the following resources: [**`/phones/simulate/create_sandbox_phone`**](./create_sandbox_phone.md) Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). + diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index ee64d862b..4c70a788f 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -7,39 +7,52 @@ The Thermostats route contains the following resources: [**`/thermostats/activate_climate_preset`**](./activate_climate_preset.md) Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/cool`**](./cool.md) Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + [**`/thermostats/create_climate_preset`**](./create_climate_preset.md) Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/delete_climate_preset`**](./delete_climate_preset.md) Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/heat`**](./heat.md) Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + [**`/thermostats/heat_cool`**](./heat_cool.md) Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + [**`/thermostats/list`**](./list.md) Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/off`**](./off.md) Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + [**`/thermostats/set_fallback_climate_preset`**](./set_fallback_climate_preset.md) Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/set_fan_mode`**](./set_fan_mode.md) Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/set_hvac_mode`**](./set_hvac_mode.md) Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/set_temperature_threshold`**](./set_temperature_threshold.md) Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. + [**`/thermostats/update_climate_preset`**](./update_climate_preset.md) Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 117f224d4..89f540588 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -40,8 +40,6 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
error_code String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -49,8 +47,6 @@ Unique identifier of the type of error. Enables quick recognition and categoriza
message String -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
@@ -85,15 +81,20 @@ ID of the [thermostat schedule](../../../capability-guides/thermostats/creating- [**`/thermostats/schedules/create`**](./create.md) Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/schedules/delete`**](./delete.md) Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/schedules/get`**](./get.md) Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + [**`/thermostats/schedules/list`**](./list.md) Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + [**`/thermostats/schedules/update`**](./update.md) Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index 768c0f026..b80818871 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -7,6 +7,8 @@ The Thermostat Simulations route contains the following resources: [**`/thermostats/simulate/hvac_mode_adjusted`**](./hvac_mode_adjusted.md) Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). + [**`/thermostats/simulate/temperature_reached`**](./temperature_reached.md) Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). + diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index bc8520aa5..ed7a516d1 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -57,36 +57,48 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th [**`/user_identities/add_acs_user`**](./add_acs_user.md) Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + [**`/user_identities/create`**](./create.md) Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + [**`/user_identities/delete`**](./delete.md) Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. + [**`/user_identities/get`**](./get.md) Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + [**`/user_identities/grant_access_to_device`**](./grant_access_to_device.md) Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). + [**`/user_identities/list`**](./list.md) Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + [**`/user_identities/list_accessible_devices`**](./list_accessible_devices.md) Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + [**`/user_identities/list_acs_systems`**](./list_acs_systems.md) Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + [**`/user_identities/list_acs_users`**](./list_acs_users.md) Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + [**`/user_identities/remove_acs_user`**](./remove_acs_user.md) Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + [**`/user_identities/revoke_access_to_device`**](./revoke_access_to_device.md) Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + [**`/user_identities/update`**](./update.md) + diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index c194da9bc..1ebda48b6 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -43,16 +43,20 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains [**`/user_identities/enrollment_automations/delete`**](./delete.md) Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). + [**`/user_identities/enrollment_automations/get`**](./get.md) Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + [**`/user_identities/enrollment_automations/launch`**](./launch.md) Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + [**`/user_identities/enrollment_automations/list`**](./list.md) Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + --- ## Events @@ -64,8 +68,6 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
created_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event was created.
@@ -73,8 +75,6 @@ Date and time at which the event was created.
enrollment_automation_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT 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).
@@ -82,8 +82,6 @@ ID of the [enrollment automation](../../../capability-guides/mobile-access/issui
event_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the event.
@@ -91,14 +89,11 @@ ID of the event.
event_type String -PROPERTY COLLAPSIBLE
occurred_at Datetime -PROPERTY COLLAPSIBLE -PROPERTY CONTENT Date and time at which the event occurred.
@@ -106,8 +101,6 @@ Date and time at which the event occurred.
workspace_id UUID -PROPERTY COLLAPSIBLE -PROPERTY CONTENT ID of the [workspace](../../../core-concepts/workspaces/README.md).
From 5c2383c37161288007b76739ba4759027ac69564 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:53:13 -0400 Subject: [PATCH 096/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 445acc79b..1713967a0 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -46,7 +46,7 @@ This object has no properties. Child Properties {{#each objectProperties}} -{{> property-collapsible this}} +{{> property-nested this}} {{/each}}
@@ -55,7 +55,7 @@ This object has no properties. {{#if listProperties}} {{#each listProperties}} -{{> property-collapsible this}} +{{> property-nested this}} {{/each}} {{/if}} From 1b9380b4b2b400bf61e4cfc4748a53203add6fe4 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 16:54:15 +0000 Subject: [PATCH 097/233] ci: Generate docs --- docs/api/acs/access_groups/README.md | 18 ++-- docs/api/acs/credentials/README.md | 65 ++++-------- docs/api/acs/encoders/README.md | 18 ++-- docs/api/acs/entrances/README.md | 128 +++++++---------------- docs/api/acs/systems/README.md | 24 ++--- docs/api/acs/users/README.md | 12 +-- docs/api/phones/README.md | 46 +++----- docs/api/thermostats/schedules/README.md | 12 +-- 8 files changed, 99 insertions(+), 224 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index ab7a78eeb..1eb1a45b0 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -101,26 +101,20 @@ Name of the access group. Warnings associated with the `acs_access_group`. -
+created_at Datetime -created_at Datetime + Date and time at which Seam created the warning. -Date and time at which Seam created the warning. -
-
+message String -message String + Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. -Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. -
-
+warning_code String -warning_code String + Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. -Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. -
--- **`workspace_id`** *UUID* diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 666df7805..15a3e0ee5 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -57,30 +57,20 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- Child Properties -
+door_names List of Strings -door_names List of Strings -
-
+endpoint_id String -endpoint_id String -
-
+key_id String -key_id String -
-
+key_issuing_request_id String -key_issuing_request_id String -
-
+override_guest_acs_entrance_ids List of Strings -override_guest_acs_entrance_ids List of Strings -
@@ -120,15 +110,11 @@ Date and time at which the [credential](../../../capability-guides/access-system Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). -
+error_code String -error_code String -
-
+message String -message String -
--- **`external_type`** *Enum* @@ -216,53 +202,38 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc Child Properties -
+auto_join Boolean -auto_join Boolean -
-
+card_function_type Enum + -card_function_type Enum
Enum values: -- `guest` -- `staff` + - `guest` + - `staff`
-
-
+card_id String -card_id String -
-
+common_acs_entrance_ids List of UUIDs -common_acs_entrance_ids List of UUIDs -
-
+credential_id String -credential_id String -
-
+guest_acs_entrance_ids List of UUIDs -guest_acs_entrance_ids List of UUIDs -
-
+is_valid Boolean -is_valid Boolean -
-
+joiner_acs_credential_ids List of UUIDs -joiner_acs_credential_ids List of UUIDs -
diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 3b981c22c..e015419eb 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -50,26 +50,20 @@ Display name for the [encoder](../../../capability-guides/access-systems/working Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -
+created_at Datetime -created_at Datetime + Date and time at which Seam created the error. -Date and time at which Seam created the error. -
-
+error_code String -error_code String + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -
-
+message String -message String + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
--- **`workspace_id`** *UUID* diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index d2daf32fb..288fc36c9 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -30,40 +30,31 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa Child Properties -
+door_name String -door_name String -
-
+door_number Number -door_number Number -
-
+door_type Enum + -door_type Enum
Enum values: -- `CommonDoor` -- `EntranceDoor` -- `GuestDoor` -- `Elevator` + - `CommonDoor` + - `EntranceDoor` + - `GuestDoor` + - `Elevator`
-
-
+pms_id String -pms_id String -
-
+stand_open Boolean -stand_open Boolean -
@@ -88,10 +79,8 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca Child Properties -
+access_point_name String -access_point_name String -
@@ -101,19 +90,15 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -
+error_code String -error_code String + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -
-
+message String -message String + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
--- **`latch_metadata`** *Object* @@ -124,25 +109,17 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide Child Properties -
+accessibility_type String -accessibility_type String -
-
+door_name String -door_name String -
-
+door_type String -door_type String -
-
+is_connected Boolean -is_connected Boolean -
@@ -155,45 +132,29 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu Child Properties -
+battery_level String -battery_level String -
-
+door_name String -door_name String -
-
+intrusion_alarm Boolean -intrusion_alarm Boolean -
-
+left_open_alarm Boolean -left_open_alarm Boolean -
-
+lock_type String -lock_type String -
-
+locked_state String -locked_state String -
-
+online Boolean -online Boolean -
-
+privacy_mode Boolean -privacy_mode Boolean -
@@ -206,20 +167,14 @@ Salto Space-specific metadata associated with the [entrance](../../../capability Child Properties -
+door_description String -door_description String -
-
+door_name String -door_name String -
-
+ext_door_id String -ext_door_id String -
@@ -232,30 +187,26 @@ Visionline-specific metadata associated with the [entrance](../../../capability- Child Properties -
+door_category Enum + -door_category Enum
Enum values: -- `entrance` -- `guest` -- `elevator reader` -- `common` -- `common (PMS)` + - `entrance` + - `guest` + - `elevator reader` + - `common` + - `common (PMS)`
-
-
+door_name String -door_name String -
-
+profiles List of Objects -profiles List of Objects - visionline_door_profile_id String @@ -274,7 +225,6 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
-
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 4257bbb45..39f7fddc9 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -131,12 +131,10 @@ Indicates whether the `acs_system` is a credential manager. Child Properties -
+time_zone String -time_zone String + 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/latest/capability-guides/access-systems) is located. -
@@ -188,26 +186,20 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide Child Properties -
+lan_address String -lan_address String + IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network. -IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network. -
-
+mobile_access_uuid String -mobile_access_uuid String + Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. -Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. -
-
+system_id String -system_id String + Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. -Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. -
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 0394e94db..cf4c37a4d 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -20,19 +20,15 @@ For details about how to configure `acs_user`s in your access control system, se Child Properties -
+ends_at Datetime -ends_at Datetime + 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. -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. -
-
+starts_at Datetime -starts_at Datetime + Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. -
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index fe2c20347..3f581f8e0 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -51,15 +51,11 @@ Display name of the phone. Defaults to `nickname` (if it is set) or `properties. Errors associated with the `phone`. -
+error_code String -error_code String -
-
+message String -message String -
--- **`nickname`** *String* @@ -76,18 +72,15 @@ Properties of the phone. Child Properties -
+assa_abloy_credential_service_metadata Object -assa_abloy_credential_service_metadata Object + ASSA ABLOY Credential Service metadata for the phone. -ASSA ABLOY Credential Service metadata for the phone. -
-
+assa_abloy_credential_service_metadata.endpoints List of Objects -assa_abloy_credential_service_metadata.endpoints List of Objects + Endpoints associated with the phone. -Endpoints associated with the phone. - endpoint_id String @@ -100,28 +93,21 @@ Endpoints associated with the phone. Indicated whether the endpoint is active. -
-
+assa_abloy_credential_service_metadata.has_active_endpoint Boolean -assa_abloy_credential_service_metadata.has_active_endpoint Boolean + Indicates whether the credential service has active endpoints associated with the phone. -Indicates whether the credential service has active endpoints associated with the phone. -
-
+salto_space_credential_service_metadata Object -salto_space_credential_service_metadata Object + Salto Space credential service metadata for the phone. -Salto Space credential service metadata for the phone. -
-
+salto_space_credential_service_metadata.has_active_phone Boolean -salto_space_credential_service_metadata.has_active_phone Boolean + Indicates whether the credential service has an active associated phone. -Indicates whether the credential service has an active associated phone. -
@@ -131,15 +117,11 @@ Indicates whether the credential service has an active associated phone. Warnings associated with the `phone`. -
+message String -message String -
-
+warning_code String -warning_code String -
--- **`workspace_id`** *UUID* diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 89f540588..8d055c4fc 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -37,19 +37,15 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -
+error_code String -error_code String + Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -
-
+message String -message String + Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -Detailed description of the error. Provides insights into the issue and potentially how to rectify it. -
--- **`max_override_period_minutes`** *Number* From fe36c632f7c080ec367273c5de97e3ace51c6c61 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:58:28 -0400 Subject: [PATCH 098/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 1713967a0..47c0596bd 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -28,7 +28,7 @@ {{#if enumValues}}
-Enum values: +Enum values {{#each enumValues}} - `{{this}}` From 7d353ba209c713b14503f120b5cd083333f73094 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 12:58:57 -0400 Subject: [PATCH 099/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 47c0596bd..8672632a5 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -46,7 +46,7 @@ This object has no properties. Child Properties {{#each objectProperties}} -{{> property-nested this}} +- {{> property-nested this}} {{/each}}
@@ -55,7 +55,7 @@ This object has no properties. {{#if listProperties}} {{#each listProperties}} -{{> property-nested this}} +- {{> property-nested this}} {{/each}} {{/if}} From 2ab3a2b20696b9ef8f518179ff7dea70e526dfcf Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 17:00:01 +0000 Subject: [PATCH 100/233] ci: Generate docs --- docs/api/access_codes/README.md | 4 +- docs/api/acs/access_groups/README.md | 13 ++-- docs/api/acs/credentials/README.md | 49 ++++++++---- docs/api/acs/encoders/README.md | 9 ++- docs/api/acs/encoders/encode_credential.md | 2 +- docs/api/acs/encoders/scan_credential.md | 2 +- docs/api/acs/entrances/README.md | 78 ++++++++++++------- docs/api/acs/systems/README.md | 16 ++-- docs/api/acs/users/README.md | 8 +- docs/api/phones/README.md | 29 ++++--- .../thermostats/activate_climate_preset.md | 2 +- docs/api/thermostats/cool.md | 2 +- docs/api/thermostats/heat.md | 2 +- docs/api/thermostats/heat_cool.md | 2 +- docs/api/thermostats/off.md | 2 +- docs/api/thermostats/schedules/README.md | 6 +- docs/api/thermostats/set_fan_mode.md | 2 +- docs/api/thermostats/set_hvac_mode.md | 2 +- 18 files changed, 147 insertions(+), 83 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 705d16cf7..d46b76c50 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -122,7 +122,7 @@ Date and time at which the time-bound access code becomes active.
-Enum values: +Enum values - `setting` - `set` @@ -139,7 +139,7 @@ Nature of the access code. Values are "ongoing" for access codes that are active
-Enum values: +Enum values - `time_bound` - `ongoing` diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 1eb1a45b0..68ff3ed56 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -20,7 +20,7 @@ To learn whether your access control system supports access groups, see the corr
-Enum values: +Enum values - `pti_unit` - `pti_access_level` @@ -68,7 +68,7 @@ Brand-specific terminology for the access group type.
-Enum values: +Enum values - `pti_unit` - `pti_access_level` @@ -101,21 +101,24 @@ Name of the access group. Warnings associated with the `acs_access_group`. -created_at Datetime +- created_at Datetime Date and time at which Seam created the warning. -message String + +- message String Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. -warning_code String + +- warning_code String Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. + --- **`workspace_id`** *UUID* diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 15a3e0ee5..56f6073b4 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -18,7 +18,7 @@ Access method for the [credential](../../../capability-guides/access-systems/man
-Enum values: +Enum values - `code` - `card` @@ -57,19 +57,24 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- Child Properties -door_names List of Strings +- door_names List of Strings + + + +- endpoint_id String + -endpoint_id String +- key_id String -key_id String +- key_issuing_request_id String -key_issuing_request_id String -override_guest_acs_entrance_ids List of Strings +- override_guest_acs_entrance_ids List of Strings +
@@ -110,10 +115,12 @@ Date and time at which the [credential](../../../capability-guides/access-system Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). -error_code String +- error_code String + -message String +- message String + --- @@ -123,7 +130,7 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces
-Enum values: +Enum values - `pti_card` - `brivo_credential` @@ -202,10 +209,11 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc Child Properties -auto_join Boolean +- auto_join Boolean -card_function_type Enum + +- card_function_type Enum
@@ -217,22 +225,29 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
-card_id String + +- card_id String + + + +- common_acs_entrance_ids List of UUIDs + + + +- credential_id String -common_acs_entrance_ids List of UUIDs +- guest_acs_entrance_ids List of UUIDs -credential_id String -guest_acs_entrance_ids List of UUIDs +- is_valid Boolean -is_valid Boolean +- joiner_acs_credential_ids List of UUIDs -joiner_acs_credential_ids List of UUIDs
diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index e015419eb..d260a46e4 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -50,21 +50,24 @@ Display name for the [encoder](../../../capability-guides/access-systems/working Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -created_at Datetime +- created_at Datetime Date and time at which Seam created the error. -error_code String + +- error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -message String + +- message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + --- **`workspace_id`** *UUID* diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 706371ccc..1e4519912 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -65,7 +65,7 @@ Type of action that the action attempt tracks.
-Enum values: +Enum values - `success` - `pending` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index f537d9c9d..c072306d6 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -54,7 +54,7 @@ ID of the action attempt.
-Enum values: +Enum values - `success` - `pending` diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 288fc36c9..568f596e8 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -30,13 +30,15 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa Child Properties -door_name String +- door_name String -door_number Number +- door_number Number -door_type Enum + + +- door_type Enum
@@ -50,10 +52,13 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
-pms_id String + +- pms_id String + -stand_open Boolean +- stand_open Boolean +
@@ -79,7 +84,8 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca Child Properties -access_point_name String +- access_point_name String +
@@ -90,16 +96,18 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -error_code String +- error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -message String + +- message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + --- **`latch_metadata`** *Object* @@ -109,16 +117,20 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide Child Properties -accessibility_type String +- accessibility_type String + + +- door_name String -door_name String -door_type String +- door_type String -is_connected Boolean + +- is_connected Boolean +
@@ -132,28 +144,36 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu Child Properties -battery_level String +- battery_level String + -door_name String +- door_name String -intrusion_alarm Boolean +- intrusion_alarm Boolean -left_open_alarm Boolean -lock_type String +- left_open_alarm Boolean -locked_state String +- lock_type String -online Boolean -privacy_mode Boolean +- locked_state String + + + +- online Boolean + + + +- privacy_mode Boolean +
@@ -167,13 +187,16 @@ Salto Space-specific metadata associated with the [entrance](../../../capability Child Properties -door_description String +- door_description String -door_name String +- door_name String + + + +- ext_door_id String -ext_door_id String
@@ -187,7 +210,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability- Child Properties -door_category Enum +- door_category Enum
@@ -202,10 +225,12 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
-door_name String +- door_name String -profiles List of Objects + + +- profiles List of Objects - visionline_door_profile_id String @@ -225,6 +250,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
+
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 39f7fddc9..6d8ddba9e 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -82,7 +82,7 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/
-Enum values: +Enum values - `pti_site` - `alta_org` @@ -131,10 +131,11 @@ Indicates whether the `acs_system` is a credential manager. Child Properties -time_zone String +- time_zone String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. +
@@ -153,7 +154,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
-Enum values: +Enum values - `pti_site` - `alta_org` @@ -186,20 +187,23 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide Child Properties -lan_address String +- lan_address String IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network. -mobile_access_uuid String + +- mobile_access_uuid String Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. -system_id String + +- system_id String Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. +
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index cf4c37a4d..d4270a212 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -20,15 +20,17 @@ For details about how to configure `acs_user`s in your access control system, se Child Properties -ends_at Datetime +- ends_at Datetime 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. -starts_at Datetime + +- starts_at Datetime Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. +
@@ -83,7 +85,7 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi
-Enum values: +Enum values - `pti_user` - `brivo_user` diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 3f581f8e0..fab668a81 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -32,7 +32,7 @@ Type of phone.
-Enum values: +Enum values - `ios_phone` - `android_phone` @@ -51,10 +51,12 @@ Display name of the phone. Defaults to `nickname` (if it is set) or `properties. Errors associated with the `phone`. -error_code String +- error_code String -message String + +- message String + --- @@ -72,12 +74,13 @@ Properties of the phone. Child Properties -assa_abloy_credential_service_metadata Object +- assa_abloy_credential_service_metadata Object ASSA ABLOY Credential Service metadata for the phone. -assa_abloy_credential_service_metadata.endpoints List of Objects + +- assa_abloy_credential_service_metadata.endpoints List of Objects Endpoints associated with the phone. @@ -94,20 +97,24 @@ Properties of the phone. -assa_abloy_credential_service_metadata.has_active_endpoint Boolean + +- assa_abloy_credential_service_metadata.has_active_endpoint Boolean Indicates whether the credential service has active endpoints associated with the phone. -salto_space_credential_service_metadata Object + +- salto_space_credential_service_metadata Object Salto Space credential service metadata for the phone. -salto_space_credential_service_metadata.has_active_phone Boolean + +- salto_space_credential_service_metadata.has_active_phone Boolean Indicates whether the credential service has an active associated phone. +
@@ -117,10 +124,12 @@ Properties of the phone. Warnings associated with the `phone`. -message String +- message String + + +- warning_code String -warning_code String --- diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index ceee6f5fc..766efbc2e 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -195,7 +195,7 @@ ID of the action attempt.
-Enum values: +Enum values - `success` - `pending` diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index c513204f4..9714724f9 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -205,7 +205,7 @@ ID of the action attempt.
-Enum values: +Enum values - `success` - `pending` diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 9240b7a42..53d61b159 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -205,7 +205,7 @@ ID of the action attempt.
-Enum values: +Enum values - `success` - `pending` diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 73cdd0c4f..38369cc18 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -229,7 +229,7 @@ ID of the action attempt.
-Enum values: +Enum values - `success` - `pending` diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 34e543648..f232c9ee2 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -177,7 +177,7 @@ ID of the action attempt.
-Enum values: +Enum values - `success` - `pending` diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 8d055c4fc..7017669ba 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -37,16 +37,18 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -error_code String +- error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -message String + +- message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. + --- **`max_override_period_minutes`** *Number* diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 0e6e60c71..50d134425 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -205,7 +205,7 @@ ID of the action attempt.
-Enum values: +Enum values - `success` - `pending` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index b6618359c..cb0edbf8d 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -243,7 +243,7 @@ ID of the action attempt.
-Enum values: +Enum values - `success` - `pending` From edebc6f10941409cb5e8aa0aec487348fa05515a Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 13:03:12 -0400 Subject: [PATCH 101/233] Update api-route.hbs --- src/layouts/api-route.hbs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 5191bd337..c254e58ec 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -50,11 +50,14 @@ The {{title}} route contains the following resources: {{description}} {{/if}} +
+ +Properties {{#each properties}} -{{> property-collapsible this}} +- {{> property-nested this}} {{/each}} ---- +
{{/each}} {{/if}} From 0547025856ddbb00a7bc5e021ec631e56460f015 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 17:04:12 +0000 Subject: [PATCH 102/233] ci: Generate docs --- docs/api/access_codes/README.md | 995 ++++++++---------- docs/api/acs/access_groups/README.md | 55 +- docs/api/acs/credentials/README.md | 165 ++- docs/api/acs/encoders/README.md | 114 +- docs/api/acs/entrances/README.md | 110 +- docs/api/acs/systems/README.md | 150 ++- docs/api/acs/users/README.md | 55 +- docs/api/phones/README.md | 43 +- .../enrollment_automations/README.md | 43 +- 9 files changed, 789 insertions(+), 941 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index d46b76c50..2c65b83fe 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -470,59 +470,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.changed`** @@ -530,59 +525,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String + ---- + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.scheduled_on_device`** @@ -590,66 +580,60 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -code String -Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
-
+- code String -connected_account_id UUID + Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-device_id UUID -ID of the [device](../../core-concepts/devices/README.md). -
+- created_at Datetime -
+ Date and time at which the event was created. -event_id UUID -ID of the event. -
-
+- device_id UUID -event_type String -
+ ID of the [device](../../core-concepts/devices/README.md). -
-occurred_at Datetime -Date and time at which the event occurred. -
+- event_id UUID -
+ ID of the event. -workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
---- +- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.set_on_device`** @@ -657,66 +641,60 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -code String -Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
-
+- code String -connected_account_id UUID + Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-device_id UUID -ID of the [device](../../core-concepts/devices/README.md). -
+- created_at Datetime -
+ Date and time at which the event was created. -event_id UUID -ID of the event. -
-
+- device_id UUID -event_type String -
+ ID of the [device](../../core-concepts/devices/README.md). -
-occurred_at Datetime -Date and time at which the event occurred. -
+- event_id UUID -
+ ID of the event. -workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
---- +- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.removed_from_device`** @@ -724,59 +702,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.delay_in_setting_on_device`** @@ -784,59 +757,54 @@ There was an unusually long delay in setting an [access code](https://docs.seam.
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. + ---- + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.failed_to_set_on_device`** @@ -844,59 +812,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.deleted`** @@ -904,66 +867,60 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -code String -Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
-
+- code String -connected_account_id UUID + Code for the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-device_id UUID -ID of the [device](../../core-concepts/devices/README.md). -
+- created_at Datetime -
+ Date and time at which the event was created. -event_id UUID -ID of the event. -
-
+- device_id UUID -event_type String -
+ ID of the [device](../../core-concepts/devices/README.md). -
-occurred_at Datetime -Date and time at which the event occurred. -
+- event_id UUID -
+ ID of the event. -workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
---- +- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.delay_in_removing_from_device`** @@ -971,59 +928,54 @@ There was an unusually long delay in removing an [access code](https://docs.seam
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.failed_to_remove_from_device`** @@ -1031,59 +983,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. ---- + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.modified_external_to_seam`** @@ -1091,59 +1038,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.deleted_external_to_seam`** @@ -1151,59 +1093,54 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.backup_access_code_pulled`** @@ -1211,64 +1148,58 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- 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 -
-
-connected_account_id UUID +- backup_access_code_id String -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-device_id UUID -ID of the [device](../../core-concepts/devices/README.md). -
+- created_at Datetime -
+ Date and time at which the event was created. -event_id UUID -ID of the event. -
-
+- device_id UUID -event_type String -
+ ID of the [device](../../core-concepts/devices/README.md). -
-occurred_at Datetime -Date and time at which the event occurred. -
+- event_id UUID -
+ ID of the event. -workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
---- +- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.unmanaged.converted_to_managed`** @@ -1276,59 +1207,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. ---- + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.unmanaged.failed_to_convert_to_managed`** @@ -1336,59 +1262,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). + + +
**`access_code.unmanaged.created`** @@ -1396,59 +1317,54 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../core-concepts/workspaces/README.md). ---- + +
**`access_code.unmanaged.removed`** @@ -1456,57 +1372,52 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
-access_code_id UUID +Properties -ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -
+- access_code_id UUID -
+ ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -connected_account_id UUID -ID of the [connected account](../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-device_id UUID +- created_at Datetime -ID of the [device](../../core-concepts/devices/README.md). -
+ Date and time at which the event was created. -
-event_id UUID -ID of the event. -
+- device_id UUID -
+ ID of the [device](../../core-concepts/devices/README.md). -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- 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 68ff3ed56..a90a8ddce 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -163,55 +163,50 @@ An ACS access group was deleted.
-acs_access_group_id UUID -
+Properties -
+- acs_access_group_id UUID -acs_system_id UUID -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
-
+- acs_system_id UUID -connected_account_id UUID + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-event_id UUID -ID of the event. -
+- created_at Datetime -
+ Date and time at which the event was created. -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- 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 56f6073b4..b2b29c009 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -348,57 +348,52 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-acs_credential_id UUID -
+Properties -
+- acs_credential_id UUID -acs_system_id UUID -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
-
+- acs_system_id UUID -connected_account_id UUID + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-event_id UUID -ID of the event. -
+- created_at Datetime -
+ Date and time at which the event was created. -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
+- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. ---- + + +- workspace_id UUID + + ID of the [workspace](../../../core-concepts/workspaces/README.md). + + +
**`acs_credential.issued`** @@ -406,57 +401,52 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-acs_credential_id UUID -
+Properties -
+- acs_credential_id UUID -acs_system_id UUID -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
-
+- acs_system_id UUID -connected_account_id UUID + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-event_id UUID -ID of the event. -
+- created_at Datetime -
+ Date and time at which the event was created. -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../../core-concepts/workspaces/README.md). + + +
**`acs_credential.reissued`** @@ -464,55 +454,50 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
-acs_credential_id UUID -
+Properties -
+- acs_credential_id UUID -acs_system_id UUID -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
-
+- acs_system_id UUID -connected_account_id UUID + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-event_id UUID -ID of the event. -
+- created_at Datetime -
+ Date and time at which the event was created. -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- 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 d260a46e4..0d33935b8 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -100,59 +100,54 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
-acs_encoder_id UUID +Properties -ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -
+- 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 -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
-
+- acs_system_id UUID -connected_account_id UUID + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-event_id UUID -ID of the event. -
+- created_at Datetime -
+ Date and time at which the event was created. -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../../core-concepts/workspaces/README.md). + + +
**`acs_encoder.removed`** @@ -160,57 +155,52 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
-acs_encoder_id UUID +Properties -ID of the [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -
+- 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 -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
-
+- acs_system_id UUID -connected_account_id UUID + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-event_id UUID -ID of the event. -
+- created_at Datetime -
+ Date and time at which the event was created. -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- 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 568f596e8..3e801f7c7 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -284,57 +284,52 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
-acs_entrance_id UUID -
+Properties -
+- acs_entrance_id UUID -acs_system_id UUID -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
-
+- acs_system_id UUID -connected_account_id UUID + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-event_id UUID -ID of the event. -
+- created_at Datetime -
+ Date and time at which the event was created. -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../../core-concepts/workspaces/README.md). + + +
**`acs_entrance.removed`** @@ -342,55 +337,50 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
-acs_entrance_id UUID -
+Properties -
+- acs_entrance_id UUID -acs_system_id UUID -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
-
+- acs_system_id UUID -connected_account_id UUID + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-event_id UUID -ID of the event. -
+- created_at Datetime -
+ Date and time at which the event was created. -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- 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 6d8ddba9e..b5d13979f 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -302,52 +302,48 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-acs_system_id UUID +Properties -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
+- acs_system_id UUID -
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -connected_account_id UUID -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-event_id UUID +- created_at Datetime -ID of the event. -
+ Date and time at which the event was created. -
-event_type String -
-
+- event_id UUID -occurred_at Datetime + ID of the event. -Date and time at which the event occurred. -
-
-workspace_id UUID +- event_type String + + + +- occurred_at Datetime + + Date and time at which the event occurred. -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
---- + +- workspace_id UUID + + ID of the [workspace](../../../core-concepts/workspaces/README.md). + + +
**`acs_system.added`** @@ -355,52 +351,48 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-acs_system_id UUID +Properties -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
+- acs_system_id UUID -
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -connected_account_id UUID -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-event_id UUID +- created_at Datetime -ID of the event. -
+ Date and time at which the event was created. -
-event_type String -
-
+- event_id UUID -occurred_at Datetime + ID of the event. -Date and time at which the event occurred. -
-
-workspace_id UUID +- event_type String -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
---- + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../../core-concepts/workspaces/README.md). + + +
**`acs_system.disconnected`** @@ -408,50 +400,46 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
-acs_system_id UUID +Properties -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
+- acs_system_id UUID -
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -connected_account_id UUID -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
+- connected_account_id UUID -created_at Datetime + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -Date and time at which the event was created. -
-
-event_id UUID +- created_at Datetime -ID of the event. -
+ Date and time at which the event was created. -
-event_type String -
-
+- event_id UUID -occurred_at Datetime + ID of the event. -Date and time at which the event occurred. -
-
-workspace_id UUID +- event_type String -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
---- + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- 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 d4270a212..0337309b4 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -275,55 +275,50 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
-acs_system_id UUID +Properties -ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -
+- acs_system_id UUID -
+ ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). -acs_user_id UUID -
-
-connected_account_id UUID +- acs_user_id UUID -ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-
-created_at Datetime +- connected_account_id UUID -Date and time at which the event was created. -
+ ID of the [connected account](../../../core-concepts/connected-accounts/README.md). -
-event_id UUID -ID of the event. -
+- created_at Datetime -
+ Date and time at which the event was created. -event_type String -
-
-occurred_at Datetime +- event_id UUID -Date and time at which the event occurred. -
+ ID of the event. -
-workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
+- event_type String ---- + + +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- 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 fab668a81..e397afeeb 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -164,43 +164,40 @@ A phone device was deactivated.
-created_at Datetime +Properties -Date and time at which the event was created. -
+- created_at Datetime -
+ Date and time at which the event was created. -device_id UUID -ID of the [device](../../core-concepts/devices/README.md). -
-
+- device_id UUID -event_id UUID + ID of the [device](../../core-concepts/devices/README.md). -ID of the event. -
-
-event_type String -
+- event_id UUID -
+ ID of the event. -occurred_at Datetime -Date and time at which the event occurred. -
-
+- event_type String -workspace_id UUID -ID of the [workspace](../../core-concepts/workspaces/README.md). -
---- +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- 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 1ebda48b6..3c063e663 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -67,43 +67,40 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
-created_at Datetime +Properties -Date and time at which the event was created. -
+- created_at Datetime -
+ Date and time at which the event was created. -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). -
-
+- enrollment_automation_id UUID -event_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). -ID of the event. -
-
-event_type String -
+- event_id UUID -
+ ID of the event. -occurred_at Datetime -Date and time at which the event occurred. -
-
+- event_type String -workspace_id UUID -ID of the [workspace](../../../core-concepts/workspaces/README.md). -
---- +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../../core-concepts/workspaces/README.md). + + +
From f18a117f9394ad2e7eb801dec2f07ffc4027295c Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 13:22:55 -0400 Subject: [PATCH 103/233] Update api-route.hbs --- src/layouts/api-route.hbs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index c254e58ec..95de05693 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -4,6 +4,14 @@ The {{title}} route contains the following resources: {{#each resources}} {{> api-resource }} +## Endpoints + +{{#each endpoints}} +[**`{{path}}`**](./{{name}}.md) + +{{description}} + +{{/each}} {{#if errors.length}} ## Errors @@ -28,14 +36,6 @@ The {{title}} route contains the following resources: {{/each}} {{/if}} -{{/each}} -## Endpoints - -{{#each endpoints}} -[**`{{path}}`**](./{{name}}.md) - -{{description}} - {{/each}} {{#if events.length}} From 38f5e586a4341e7174658d1e02c786be497963ce Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 17:24:07 +0000 Subject: [PATCH 104/233] ci: Generate docs --- docs/api/access_codes/README.md | 4 +- docs/api/acs/access_groups/README.md | 24 --------- docs/api/acs/credentials/README.md | 36 +------------ docs/api/acs/encoders/README.md | 12 ----- docs/api/acs/encoders/simulate/README.md | 18 ------- docs/api/acs/entrances/README.md | 16 ------ docs/api/acs/systems/README.md | 17 +----- docs/api/acs/users/README.md | 48 +---------------- docs/api/phones/README.md | 12 ----- docs/api/phones/simulate/README.md | 6 --- docs/api/thermostats/README.md | 54 ------------------- docs/api/thermostats/schedules/README.md | 20 ------- docs/api/thermostats/simulate/README.md | 10 ---- docs/api/user_identities/README.md | 48 ----------------- .../enrollment_automations/README.md | 16 ------ 15 files changed, 8 insertions(+), 333 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 2c65b83fe..f32e777dc 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -153,6 +153,8 @@ Collection of warnings associated with the access code, structured in a dictiona --- +## Endpoints + ## Errors **`smartthings_failed_to_set_access_code`** @@ -457,8 +459,6 @@ Unable to confirm the access code is set on Kwikset device. --- -## Endpoints - --- diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index a90a8ddce..1ae429322 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -128,30 +128,6 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Endpoints -[**`/acs/access_groups/add_user`**](./add_user.md) - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -[**`/acs/access_groups/get`**](./get.md) - -Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -[**`/acs/access_groups/list`**](./list.md) - -Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -[**`/acs/access_groups/list_accessible_entrances`**](./list_accessible_entrances.md) - -Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -[**`/acs/access_groups/list_users`**](./list_users.md) - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -[**`/acs/access_groups/remove_user`**](./remove_user.md) - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - --- diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index b2b29c009..3627ab6e0 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -265,6 +265,8 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- +## Endpoints + ## Warnings **`waiting_to_be_issued`** @@ -303,40 +305,6 @@ Access permissions for the [credential](../../../capability-guides/access-system --- -## Endpoints - -[**`/acs/credentials/assign`**](./assign.md) - -Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -[**`/acs/credentials/create`**](./create.md) - -Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -[**`/acs/credentials/delete`**](./delete.md) - -Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). - -[**`/acs/credentials/get`**](./get.md) - -Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). - -[**`/acs/credentials/list`**](./list.md) - -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). - -[**`/acs/credentials/list_accessible_entrances`**](./list_accessible_entrances.md) - -Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. - -[**`/acs/credentials/unassign`**](./unassign.md) - -Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -[**`/acs/credentials/update`**](./update.md) - -Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). - --- diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 0d33935b8..a023fab45 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -77,18 +77,6 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Endpoints -[**`/acs/encoders/encode_credential`**](./encode_credential.md) - -Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - -[**`/acs/encoders/list`**](./list.md) - -Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - -[**`/acs/encoders/scan_credential`**](./scan_credential.md) - -Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - --- diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index 83917ca8e..3025b9646 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -2,21 +2,3 @@ The Encoder Simulations route contains the following resources: -## Endpoints - -[**`/acs/encoders/simulate/next_credential_encode_will_fail`**](./next_credential_encode_will_fail.md) - -Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). - -[**`/acs/encoders/simulate/next_credential_encode_will_succeed`**](./next_credential_encode_will_succeed.md) - -Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). - -[**`/acs/encoders/simulate/next_credential_scan_will_fail`**](./next_credential_scan_will_fail.md) - -Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). - -[**`/acs/encoders/simulate/next_credential_scan_will_succeed`**](./next_credential_scan_will_succeed.md) - -Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). - diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 3e801f7c7..9163cd404 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -257,22 +257,6 @@ Visionline-specific metadata associated with the [entrance](../../../capability- --- ## Endpoints -[**`/acs/entrances/get`**](./get.md) - -Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - -[**`/acs/entrances/grant_access`**](./grant_access.md) - - - -[**`/acs/entrances/list`**](./list.md) - -Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). - -[**`/acs/entrances/list_credentials_with_access`**](./list_credentials_with_access.md) - -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - --- diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index b5d13979f..b593ec10c 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -220,6 +220,8 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- +## Endpoints + ## Errors **`seam_bridge_disconnected`** @@ -276,21 +278,6 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui --- -## Endpoints - -[**`/acs/systems/get`**](./get.md) - -Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). - -[**`/acs/systems/list`**](./list.md) - -Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). - -[**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md) - -Returns a list of all credential manager ACS systems that are compatible with a specified -[access control system](https://docs.seam.co/latest/capability-guides/access-systems). - --- diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 0337309b4..47628b3a2 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -166,6 +166,8 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- +## Endpoints + ## Errors **`deleted_externally`** @@ -218,52 +220,6 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc --- -## Endpoints - -[**`/acs/users/add_to_access_group`**](./add_to_access_group.md) - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -[**`/acs/users/create`**](./create.md) - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -[**`/acs/users/delete`**](./delete.md) - -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). - -[**`/acs/users/get`**](./get.md) - -Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -[**`/acs/users/list`**](./list.md) - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -[**`/acs/users/list_accessible_entrances`**](./list_accessible_entrances.md) - -Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. - -[**`/acs/users/remove_from_access_group`**](./remove_from_access_group.md) - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - -[**`/acs/users/revoke_access_to_all_entrances`**](./revoke_access_to_all_entrances.md) - -Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - -[**`/acs/users/suspend`**](./suspend.md) - -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. - -[**`/acs/users/unsuspend`**](./unsuspend.md) - -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. - -[**`/acs/users/update`**](./update.md) - -Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - --- diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index e397afeeb..149be239a 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -141,18 +141,6 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th --- ## Endpoints -[**`/phones/deactivate`**](./deactivate.md) - -Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). - -[**`/phones/get`**](./get.md) - -Returns a single phone entry matching the provided `device_id`. - -[**`/phones/list`**](./list.md) - -Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. - --- diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index 78973f68f..64cb3a1cf 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -2,9 +2,3 @@ The Phone Simulations route contains the following resources: -## Endpoints - -[**`/phones/simulate/create_sandbox_phone`**](./create_sandbox_phone.md) - -Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). - diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index 4c70a788f..2d089bbe8 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -2,57 +2,3 @@ The Thermostats route contains the following resources: -## Endpoints - -[**`/thermostats/activate_climate_preset`**](./activate_climate_preset.md) - -Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/cool`**](./cool.md) - -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). - -[**`/thermostats/create_climate_preset`**](./create_climate_preset.md) - -Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/delete_climate_preset`**](./delete_climate_preset.md) - -Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/heat`**](./heat.md) - -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). - -[**`/thermostats/heat_cool`**](./heat_cool.md) - -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). - -[**`/thermostats/list`**](./list.md) - -Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/off`**](./off.md) - -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). - -[**`/thermostats/set_fallback_climate_preset`**](./set_fallback_climate_preset.md) - -Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/set_fan_mode`**](./set_fan_mode.md) - -Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/set_hvac_mode`**](./set_hvac_mode.md) - -Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/set_temperature_threshold`**](./set_temperature_threshold.md) - -Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. - -[**`/thermostats/update_climate_preset`**](./update_climate_preset.md) - -Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 7017669ba..1a917626f 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -76,23 +76,3 @@ ID of the [thermostat schedule](../../../capability-guides/thermostats/creating- --- ## Endpoints -[**`/thermostats/schedules/create`**](./create.md) - -Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/schedules/delete`**](./delete.md) - -Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/schedules/get`**](./get.md) - -Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). - -[**`/thermostats/schedules/list`**](./list.md) - -Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). - -[**`/thermostats/schedules/update`**](./update.md) - -Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). - diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index b80818871..37f52ca47 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -2,13 +2,3 @@ The Thermostat Simulations route contains the following resources: -## Endpoints - -[**`/thermostats/simulate/hvac_mode_adjusted`**](./hvac_mode_adjusted.md) - -Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). - -[**`/thermostats/simulate/temperature_reached`**](./temperature_reached.md) - -Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). - diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index ed7a516d1..b394b3119 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -54,51 +54,3 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th --- ## Endpoints -[**`/user_identities/add_acs_user`**](./add_acs_user.md) - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - -[**`/user_identities/create`**](./create.md) - -Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - -[**`/user_identities/delete`**](./delete.md) - -Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. - -[**`/user_identities/get`**](./get.md) - -Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - -[**`/user_identities/grant_access_to_device`**](./grant_access_to_device.md) - -Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). - -[**`/user_identities/list`**](./list.md) - -Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - -[**`/user_identities/list_accessible_devices`**](./list_accessible_devices.md) - -Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - -[**`/user_identities/list_acs_systems`**](./list_acs_systems.md) - -Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - -[**`/user_identities/list_acs_users`**](./list_acs_users.md) - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - -[**`/user_identities/remove_acs_user`**](./remove_acs_user.md) - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - -[**`/user_identities/revoke_access_to_device`**](./revoke_access_to_device.md) - -Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - -[**`/user_identities/update`**](./update.md) - - - diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 3c063e663..2ca9b2e1b 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -40,22 +40,6 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Endpoints -[**`/user_identities/enrollment_automations/delete`**](./delete.md) - -Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). - -[**`/user_identities/enrollment_automations/get`**](./get.md) - -Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). - -[**`/user_identities/enrollment_automations/launch`**](./launch.md) - -Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). - -[**`/user_identities/enrollment_automations/list`**](./list.md) - -Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - --- From c5d2f7b10fed3bf4774a3c315762bb8ca2f560c4 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 13:28:39 -0400 Subject: [PATCH 105/233] Update api-route.hbs --- src/layouts/api-route.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 95de05693..201a4483f 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -7,6 +7,7 @@ The {{title}} route contains the following resources: ## Endpoints {{#each endpoints}} + [**`{{path}}`**](./{{name}}.md) {{description}} From 9f408e4223c56d7058d96397ee2e42e2ecab2374 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 13:33:27 -0400 Subject: [PATCH 106/233] Update api-route.hbs --- src/layouts/api-route.hbs | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 201a4483f..fae06ef14 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -4,6 +4,7 @@ The {{title}} route contains the following resources: {{#each resources}} {{> api-resource }} +{{/each}} ## Endpoints {{#each endpoints}} @@ -14,6 +15,9 @@ The {{title}} route contains the following resources: {{/each}} {{#if errors.length}} + +--- + ## Errors {{#each errors}} @@ -26,6 +30,9 @@ The {{title}} route contains the following resources: {{/each}} {{/if}} {{#if warnings.length}} + +--- + ## Warnings {{#each warnings}} @@ -37,7 +44,6 @@ The {{title}} route contains the following resources: {{/each}} {{/if}} -{{/each}} {{#if events.length}} --- From cef8776ad439006c1949b469bda237f8cc914b4e Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 17:34:29 +0000 Subject: [PATCH 107/233] ci: Generate docs --- docs/api/access_codes/README.md | 304 ------------------ docs/api/acs/access_groups/README.md | 30 ++ docs/api/acs/credentials/README.md | 40 +-- docs/api/acs/encoders/README.md | 15 + docs/api/acs/encoders/simulate/README.md | 22 ++ docs/api/acs/entrances/README.md | 20 ++ docs/api/acs/systems/README.md | 54 +--- docs/api/acs/users/README.md | 55 ++-- docs/api/phones/README.md | 15 + docs/api/phones/simulate/README.md | 7 + docs/api/thermostats/README.md | 67 ++++ docs/api/thermostats/schedules/README.md | 25 ++ docs/api/thermostats/simulate/README.md | 12 + docs/api/user_identities/README.md | 60 ++++ .../enrollment_automations/README.md | 20 ++ 15 files changed, 350 insertions(+), 396 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index f32e777dc..03bf30160 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -155,310 +155,6 @@ Collection of warnings associated with the access code, structured in a dictiona --- ## Endpoints -## Errors - -**`smartthings_failed_to_set_access_code`** - -Failed to set code on Smart Things device. - ---- - -**`smartthings_failed_to_set_after_multiple_retries`** - -Failed to set code after multiple retries. - ---- - -**`smartthings_no_free_slots_available`** - -No free slots available on the device. - ---- - -**`failed_to_set_on_device`** - -Failed to set code on device. - ---- - -**`failed_to_remove_from_device`** - -Failed to remove code from device. - ---- - -**`duplicate_code_on_device`** - -Duplicate access code detected on device. - ---- - -**`duplicate_code_attempt_prevented`** - -An attempt to modify this access code was prevented. - ---- - -**`igloohome_bridge_too_many_pending_jobs`** - -Igloohome bridge has too many pending jobs in the queue. - ---- - -**`igloohome_bridge_offline`** - -Igloohome bridge is offline. - ---- - -**`igloohome_offline_access_code_no_variance_available`** - -Lock as reached max amount of codes. - ---- - -**`kwikset_unable_to_confirm_code`** - -Unable to confirm the access code is set on Kwikset device. - ---- - -**`kwikset_unable_to_confirm_deletion`** - -Unable to confirm the deletion of the access code on Kwikset device. - ---- - -**`code_modified_external_to_seam`** - -Code was modified or removed externally after Seam successfully set it on the device. - ---- - -**`august_lock_invalid_code_length`** - -Invalid code length for August lock. - ---- - -**`august_device_programming_delay`** - -Access code has not yet been fully moved to the device. - ---- - -**`august_device_slots_full`** - -All access code slots on the device are full. - ---- - -**`august_lock_missing_keypad`** - -August lock is missing a keypad. - ---- - -**`august_lock_temporarily_offline`** - -August lock is temporarily offline. - ---- - -**`salto_ks_user_not_subscribed`** - -Salto site user is not subscribed. - ---- - -**`hubitat_device_programming_delay`** - -Access code has not yet been fully moved to the device. - ---- - -**`hubitat_no_free_positions_available`** - -No free positions available on the device. - ---- - -**`wyze_duplicate_code_name`** - -Duplicate access code name detected. - ---- - -**`wyze_potential_duplicate_code`** - -Potential duplicate access code detected. - ---- - -**`dormakaba_oracode_no_valid_user_level`** - -No valid user level for Oracode. - ---- - -**`account_disconnected`** - -Account is disconnected - ---- - -**`salto_ks_subscription_limit_exceeded`** - -Salto site user limit reached. - ---- - -**`device_offline`** - -Device is offline - ---- - -**`device_removed`** - -Device has been removed - ---- - -**`hub_disconnected`** - -Hub is disconnected - ---- - -**`device_disconnected`** - -Device is disconnected - ---- - -**`empty_backup_access_code_pool`** - -The backup access code pool is empty. - ---- - -**`august_lock_not_authorized`** - -User is not authorized to use the August Lock. - ---- - -**`august_lock_missing_bridge`** - -Lock is not connected to the Seam Bridge. - ---- - -**`ttlock_lock_not_paired_to_gateway`** - -Lock is not paired with a Gateway. - ---- - -**`missing_device_credentials`** - -Missing device credentials. - ---- - -**`auxiliary_heat_running`** - -The auxiliary heat is running. - ---- - -**`subscription_required`** - -Subscription required to connect. - ---- - -**`invalid_credentials`** - -Credentials provided were invalid. - ---- - -## Warnings - -**`smartthings_failed_to_set_access_code`** - -Failed to set code on Smart Things device. - ---- - -**`schlage_detected_duplicate`** - -Duplicate access code detected. - ---- - -**`schlage_creation_outage`** - -Received an error when attempting to create this code. - ---- - -**`code_modified_external_to_seam`** - -Code was modified or removed externally after Seam successfully set it on the device. - ---- - -**`delay_in_setting_on_device`** - -Delay in setting code on device. - ---- - -**`delay_in_removing_from_device`** - -Delay in removing code from device. - ---- - -**`third_party_integration_detected`** - -Third party integration detected that may cause access codes to fail. - ---- - -**`august_device_programming_delay`** - -Access code has not yet been fully moved to the device. - ---- - -**`august_lock_temporarily_offline`** - -August lock is temporarily offline. - ---- - -**`igloo_algopin_must_be_used_within_24_hours`** - -Algopins must be used within 24 hours. - ---- - -**`management_transferred`** - -Management was transferred to another workspace. - ---- - -**`kwikset_unable_to_confirm_code`** - -Unable to confirm the access code is set on Kwikset device. - ---- - --- diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 1ae429322..aebae40de 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -129,6 +129,36 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Endpoints +[**`/acs/access_groups/add_user`**](./add_user.md) + +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/get`**](./get.md) + +Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/list`**](./list.md) + +Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/list_accessible_entrances`**](./list_accessible_entrances.md) + +Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/list_users`**](./list_users.md) + +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/remove_user`**](./remove_user.md) + +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + --- ## Events diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 3627ab6e0..79284e6f0 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -267,43 +267,45 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Endpoints -## Warnings -**`waiting_to_be_issued`** +[**`/acs/credentials/assign`**](./assign.md) -Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued. +Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- -**`schedule_externally_modified`** +[**`/acs/credentials/create`**](./create.md) -Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally. +Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- -**`schedule_modified`** +[**`/acs/credentials/delete`**](./delete.md) -Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past. +Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- -**`being_deleted`** +[**`/acs/credentials/get`**](./get.md) -Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted. +Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- -**`unknown_issue_with_acs_credential`** +[**`/acs/credentials/list`**](./list.md) -An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential. +Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). ---- -**`needs_to_be_reissued`** +[**`/acs/credentials/list_accessible_entrances`**](./list_accessible_entrances.md) -Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential. +Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. ---- + +[**`/acs/credentials/unassign`**](./unassign.md) + +Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + +[**`/acs/credentials/update`**](./update.md) + +Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). --- diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index a023fab45..78dfa7ee3 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -78,6 +78,21 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Endpoints +[**`/acs/encoders/encode_credential`**](./encode_credential.md) + +Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + + +[**`/acs/encoders/list`**](./list.md) + +Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + + +[**`/acs/encoders/scan_credential`**](./scan_credential.md) + +Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + + --- ## Events diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index 3025b9646..dd72c780f 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -2,3 +2,25 @@ The Encoder Simulations route contains the following resources: +## Endpoints + + +[**`/acs/encoders/simulate/next_credential_encode_will_fail`**](./next_credential_encode_will_fail.md) + +Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + +[**`/acs/encoders/simulate/next_credential_encode_will_succeed`**](./next_credential_encode_will_succeed.md) + +Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + +[**`/acs/encoders/simulate/next_credential_scan_will_fail`**](./next_credential_scan_will_fail.md) + +Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + +[**`/acs/encoders/simulate/next_credential_scan_will_succeed`**](./next_credential_scan_will_succeed.md) + +Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 9163cd404..ecb4c02a2 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -258,6 +258,26 @@ Visionline-specific metadata associated with the [entrance](../../../capability- ## Endpoints +[**`/acs/entrances/get`**](./get.md) + +Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + + +[**`/acs/entrances/grant_access`**](./grant_access.md) + + + + +[**`/acs/entrances/list`**](./list.md) + +Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). + + +[**`/acs/entrances/list_credentials_with_access`**](./list_credentials_with_access.md) + +Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + + --- ## Events diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index b593ec10c..1ecb83a0e 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -222,61 +222,21 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Endpoints -## Errors -**`seam_bridge_disconnected`** +[**`/acs/systems/get`**](./get.md) -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. - This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md). - See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). +Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - -**`visionline_instance_unreachable`** -Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). - For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../../../core-concepts/workspaces/README.md). - See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable). - ---- +[**`/acs/systems/list`**](./list.md) -**`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. - ---- +Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). -**`acs_system_disconnected`** -Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue. - ---- - -**`account_disconnected`** - -Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access. - ---- +[**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md) -**`salto_ks_certification_expired`** - -Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. - ---- - -## Warnings - -**`salto_ks_subscription_limit_almost_reached`** - -Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue. - ---- - -**`time_zone_does_not_match_location`** - -Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). - ---- +Returns a list of all credential manager ACS systems that are compatible with a specified +[access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 47628b3a2..d503f7f89 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -168,57 +168,60 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- ## Endpoints -## Errors -**`deleted_externally`** +[**`/acs/users/add_to_access_group`**](./add_to_access_group.md) -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam. +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). ---- -**`salto_ks_subscription_limit_exceeded`** +[**`/acs/users/create`**](./create.md) -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- -**`failed_to_create_on_acs_system`** +[**`/acs/users/delete`**](./delete.md) -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). +Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). ---- -**`failed_to_update_on_acs_system`** +[**`/acs/users/get`**](./get.md) -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). +Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- -**`failed_to_delete_on_acs_system`** +[**`/acs/users/list`**](./list.md) -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- -## Warnings +[**`/acs/users/list_accessible_entrances`**](./list_accessible_entrances.md) -**`being_deleted`** +Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly. ---- +[**`/acs/users/remove_from_access_group`**](./remove_from_access_group.md) -**`salto_ks_user_not_subscribed`** +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. ---- +[**`/acs/users/revoke_access_to_all_entrances`**](./revoke_access_to_all_entrances.md) -**`unknown_issue_with_acs_user`** +Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. ---- +[**`/acs/users/suspend`**](./suspend.md) + +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + + +[**`/acs/users/unsuspend`**](./unsuspend.md) + +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + + +[**`/acs/users/update`**](./update.md) + +Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 149be239a..a6ab3f93c 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -142,6 +142,21 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th ## Endpoints +[**`/phones/deactivate`**](./deactivate.md) + +Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). + + +[**`/phones/get`**](./get.md) + +Returns a single phone entry matching the provided `device_id`. + + +[**`/phones/list`**](./list.md) + +Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. + + --- ## Events diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index 64cb3a1cf..a35db54d2 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -2,3 +2,10 @@ The Phone Simulations route contains the following resources: +## Endpoints + + +[**`/phones/simulate/create_sandbox_phone`**](./create_sandbox_phone.md) + +Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). + diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index 2d089bbe8..94a7da664 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -2,3 +2,70 @@ The Thermostats route contains the following resources: +## Endpoints + + +[**`/thermostats/activate_climate_preset`**](./activate_climate_preset.md) + +Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/cool`**](./cool.md) + +Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + + +[**`/thermostats/create_climate_preset`**](./create_climate_preset.md) + +Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/delete_climate_preset`**](./delete_climate_preset.md) + +Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/heat`**](./heat.md) + +Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + + +[**`/thermostats/heat_cool`**](./heat_cool.md) + +Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + + +[**`/thermostats/list`**](./list.md) + +Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/off`**](./off.md) + +Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + + +[**`/thermostats/set_fallback_climate_preset`**](./set_fallback_climate_preset.md) + +Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/set_fan_mode`**](./set_fan_mode.md) + +Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/set_hvac_mode`**](./set_hvac_mode.md) + +Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/set_temperature_threshold`**](./set_temperature_threshold.md) + +Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. + + +[**`/thermostats/update_climate_preset`**](./update_climate_preset.md) + +Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 1a917626f..44f489820 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -76,3 +76,28 @@ ID of the [thermostat schedule](../../../capability-guides/thermostats/creating- --- ## Endpoints + +[**`/thermostats/schedules/create`**](./create.md) + +Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/schedules/delete`**](./delete.md) + +Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/schedules/get`**](./get.md) + +Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + + +[**`/thermostats/schedules/list`**](./list.md) + +Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +[**`/thermostats/schedules/update`**](./update.md) + +Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index 37f52ca47..83bc7ed0d 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -2,3 +2,15 @@ The Thermostat Simulations route contains the following resources: +## Endpoints + + +[**`/thermostats/simulate/hvac_mode_adjusted`**](./hvac_mode_adjusted.md) + +Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). + + +[**`/thermostats/simulate/temperature_reached`**](./temperature_reached.md) + +Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). + diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index b394b3119..ac78b5e1f 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -54,3 +54,63 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th --- ## Endpoints + +[**`/user_identities/add_acs_user`**](./add_acs_user.md) + +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +[**`/user_identities/create`**](./create.md) + +Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +[**`/user_identities/delete`**](./delete.md) + +Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. + + +[**`/user_identities/get`**](./get.md) + +Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +[**`/user_identities/grant_access_to_device`**](./grant_access_to_device.md) + +Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). + + +[**`/user_identities/list`**](./list.md) + +Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +[**`/user_identities/list_accessible_devices`**](./list_accessible_devices.md) + +Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +[**`/user_identities/list_acs_systems`**](./list_acs_systems.md) + +Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +[**`/user_identities/list_acs_users`**](./list_acs_users.md) + +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +[**`/user_identities/remove_acs_user`**](./remove_acs_user.md) + +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +[**`/user_identities/revoke_access_to_device`**](./revoke_access_to_device.md) + +Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +[**`/user_identities/update`**](./update.md) + + + diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 2ca9b2e1b..3369e99a5 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -41,6 +41,26 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Endpoints +[**`/user_identities/enrollment_automations/delete`**](./delete.md) + +Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). + + +[**`/user_identities/enrollment_automations/get`**](./get.md) + +Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + + +[**`/user_identities/enrollment_automations/launch`**](./launch.md) + +Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + + +[**`/user_identities/enrollment_automations/list`**](./list.md) + +Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + --- ## Events From 4f7f6fc23a05a738ba8379aefadd32aea445bef7 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 13:35:44 -0400 Subject: [PATCH 108/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 8672632a5..5c90a211c 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -60,4 +60,5 @@ This object has no properties. {{/if}} --- + {{/each}} From 7370f2a6cc93f7a475095971206c867a2c1478ea Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 17:36:41 +0000 Subject: [PATCH 109/233] ci: Generate docs --- docs/api/access_codes/README.md | 21 +++++++++++++++ docs/api/acs/access_groups/README.md | 12 +++++++++ docs/api/acs/credentials/README.md | 26 +++++++++++++++++++ docs/api/acs/encoders/README.md | 6 +++++ docs/api/acs/encoders/encode_credential.md | 3 +++ docs/api/acs/encoders/scan_credential.md | 3 +++ docs/api/acs/entrances/README.md | 11 ++++++++ docs/api/acs/systems/README.md | 22 ++++++++++++++++ docs/api/acs/users/README.md | 21 +++++++++++++++ docs/api/phones/README.md | 10 +++++++ .../thermostats/activate_climate_preset.md | 3 +++ docs/api/thermostats/cool.md | 3 +++ docs/api/thermostats/heat.md | 3 +++ docs/api/thermostats/heat_cool.md | 3 +++ docs/api/thermostats/off.md | 3 +++ docs/api/thermostats/schedules/README.md | 9 +++++++ docs/api/thermostats/set_fan_mode.md | 3 +++ docs/api/thermostats/set_hvac_mode.md | 3 +++ docs/api/user_identities/README.md | 8 ++++++ .../enrollment_automations/README.md | 5 ++++ 20 files changed, 178 insertions(+) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 03bf30160..745c03c2a 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -12,108 +12,126 @@ Unique identifier for the access code. --- + **`code`** *String* Code used for access. Typically, a numeric or alphanumeric string. --- + **`common_code_key`** *String* Unique identifier for a group of access codes that share the same code. --- + **`created_at`** *Datetime* Date and time at which the access code was created. --- + **`device_id`** *UUID* Unique identifier for the device associated with the access code. --- + **`ends_at`** *Datetime* Date and time after which the time-bound access code becomes inactive. --- + [**`errors`**](./#errors-1) *List* *of Objects* Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. --- + **`is_backup`** *Boolean* Indicates whether the access code is a backup code. --- + **`is_backup_access_code_available`** *Boolean* Indicates whether a backup access code is available for use if the primary access code is lost or compromised. --- + **`is_external_modification_allowed`** *Boolean* Indicates whether changes to the access code from external sources are permitted. --- + **`is_managed`** *Boolean* Indicates whether Seam manages the access code. --- + **`is_offline_access_code`** *Boolean* Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. --- + **`is_one_time_use`** *Boolean* Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. --- + **`is_scheduled_on_device`** *Boolean* Indicates whether the code is set on the device according to a preconfigured schedule. --- + **`is_waiting_for_code_assignment`** *Boolean* Indicates whether the access code is waiting for a code assignment. --- + **`name`** *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. --- + **`pulled_backup_access_code_id`** *UUID* Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. --- + **`starts_at`** *Datetime* Date and time at which the time-bound access code becomes active. --- + **`status`** *Enum* @@ -133,6 +151,7 @@ Date and time at which the time-bound access code becomes active. --- + **`type`** *Enum* Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. @@ -147,12 +166,14 @@ Nature of the access code. Values are "ongoing" for access codes that are active --- + [**`warnings`**](./#warnings-1) *List* *of Objects* Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. --- + ## Endpoints diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index aebae40de..b301bfad7 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -32,6 +32,7 @@ To learn whether your access control system supports access groups, see the corr --- + **`access_group_type_display_name`** *String* {% hint style="warning" %} @@ -40,28 +41,33 @@ To learn whether your access control system supports access groups, see the corr --- + **`acs_access_group_id`** *UUID* ID of the access group. --- + **`acs_system_id`** *UUID* ID of the access control system that contains the access group. --- + **`created_at`** *Datetime* Date and time at which the access group was created. --- + **`display_name`** *String* --- + **`external_type`** *Enum* Brand-specific terminology for the access group type. @@ -80,22 +86,26 @@ Brand-specific terminology for the access group type. --- + **`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the access group type. --- + **`is_managed`** *Boolean* --- + **`name`** *String* Name of the access group. --- + **`warnings`** *List* *of Objects* Warnings associated with the `acs_access_group`. @@ -120,12 +130,14 @@ Warnings associated with the `acs_access_group`. --- + **`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. --- + ## Endpoints diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 79284e6f0..0a067e227 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -27,28 +27,33 @@ Access method for the [credential](../../../capability-guides/access-systems/man --- + **`acs_credential_id`** *UUID* ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- + **`acs_credential_pool_id`** *UUID* --- + **`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- + **`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. --- + **`assa_abloy_vostio_metadata`** *Object* Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -80,36 +85,42 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- --- + **`card_number`** *String* Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- + **`code`** *String* Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- + **`created_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. --- + **`display_name`** *String* Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- + **`ends_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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`** *List* *of Objects* Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -124,6 +135,7 @@ Errors associated with the [credential](../../../capability-guides/access-system --- + **`external_type`** *Enum* Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. @@ -143,64 +155,75 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces --- + **`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- + **`is_issued`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. --- + **`is_latest_desired_state_synced_with_provider`** *Boolean* Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. --- + **`is_managed`** *Boolean* --- + **`is_multi_phone_sync_credential`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- + **`is_one_time_use`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. --- + **`issued_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. --- + **`latest_desired_state_synced_with_provider_at`** *Datetime* Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. --- + **`parent_acs_credential_id`** *UUID* ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). --- + **`starts_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- + **`visionline_metadata`** *Object* Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -253,18 +276,21 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc --- + [**`warnings`**](./#warnings-1) *List* *of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- + **`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- + ## Endpoints diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 78dfa7ee3..6e11e5c6c 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -27,24 +27,28 @@ ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems --- + **`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- + **`created_at`** *Datetime* Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. --- + **`display_name`** *String* Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- + **`errors`** *List* *of Objects* Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). @@ -69,12 +73,14 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w --- + **`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- + ## Endpoints diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 1e4519912..1092107ac 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -55,12 +55,14 @@ ID of the action attempt. --- + **`action_type`** *String* Type of action that the action attempt tracks. --- + **`status`** *Enum*
@@ -74,3 +76,4 @@ Type of action that the action attempt tracks. --- + diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index c072306d6..906e60cb5 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -46,10 +46,12 @@ ID of the action attempt. --- + **`action_type`** *String* --- + **`status`** *Enum*
@@ -63,3 +65,4 @@ ID of the action attempt. --- + diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index ecb4c02a2..6a7d52e3f 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -16,12 +16,14 @@ ID of the [entrance](../../../capability-guides/access-systems/retrieving-entran --- + **`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- + **`assa_abloy_vostio_metadata`** *Object* ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -64,18 +66,21 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa --- + **`created_at`** *Datetime* Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. --- + **`display_name`** *String* Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- + **`dormakaba_community_metadata`** *Object* dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -91,6 +96,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca --- + **`errors`** *List* *of Objects* Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -109,6 +115,7 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/ --- + **`latch_metadata`** *Object* Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -136,6 +143,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide --- + **`salto_ks_metadata`** *Object* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -179,6 +187,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu --- + **`salto_space_metadata`** *Object* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -202,6 +211,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability --- + **`visionline_metadata`** *Object* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -255,6 +265,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability- --- + ## Endpoints diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 1ecb83a0e..ed64f3816 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -18,36 +18,42 @@ ID of the [access control system](https://docs.seam.co/latest/capability-guides/ --- + **`can_add_acs_users_to_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- + **`can_automate_enrollment`** *Boolean* Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- + **`can_create_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- + **`can_remove_acs_users_from_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- + **`connected_account_id`** *UUID* ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- + **`connected_account_ids`** *List* *of UUIDs* IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -58,24 +64,28 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README --- + **`created_at`** *Datetime* Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. --- + **`default_credential_manager_acs_system_id`** *UUID* ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- + [**`errors`**](./#errors-1) *List* *of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- + **`external_type`** *Enum* Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. @@ -101,30 +111,35 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/ --- + **`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. --- + **`image_alt_text`** *String* Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. --- + **`image_url`** *String* URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- + **`is_credential_manager`** *Boolean* Indicates whether the `acs_system` is a credential manager. --- + **`location`** *Object*
@@ -140,12 +155,14 @@ Indicates whether the `acs_system` is a credential manager. --- + **`name`** *String* Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- + **`system_type`** *Enum* {% hint style="warning" %} @@ -173,6 +190,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- + **`system_type_display_name`** *String* {% hint style="warning" %} @@ -181,6 +199,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- + **`visionline_metadata`** *Object*
@@ -208,18 +227,21 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- + [**`warnings`**](./#warnings-1) *List* *of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- + **`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- + ## Endpoints diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index d503f7f89..fe55c6ab9 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -35,30 +35,35 @@ For details about how to configure `acs_user`s in your access control system, se --- + **`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + **`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + **`created_at`** *Datetime* Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. --- + **`display_name`** *String* Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + **`email`** *String* {% hint style="warning" %} @@ -67,18 +72,21 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- + **`email_address`** *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + [**`errors`**](./#errors-1) *List* *of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + **`external_type`** *Enum* Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. @@ -98,74 +106,87 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi --- + **`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. --- + **`full_name`** *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + **`hid_acs_system_id`** *UUID* --- + **`is_managed`** *Boolean* --- + **`is_suspended`** *Boolean* Indicates whether the [ACS 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). --- + **`phone_number`** *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- + **`user_identity_email_address`** *String* Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + **`user_identity_full_name`** *String* Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + **`user_identity_id`** *String* ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + **`user_identity_phone_number`** *String* Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- + [**`warnings`**](./#warnings-1) *List* *of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + **`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- + ## Endpoints diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index a6ab3f93c..f28f1a37c 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -14,18 +14,21 @@ Date and time at which the `phone` was created. --- + **`custom_metadata`** *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. --- + **`device_id`** *UUID* ID of the `phone`. --- + **`device_type`** *Enum* Type of phone. @@ -40,12 +43,14 @@ Type of phone. --- + **`display_name`** *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. --- + **`errors`** *List* *of Objects* Errors associated with the `phone`. @@ -60,12 +65,14 @@ Errors associated with the `phone`. --- + **`nickname`** *String* Optional nickname to describe the phone, settable through Seam. --- + **`properties`** *Object* Properties of the phone. @@ -119,6 +126,7 @@ Properties of the phone. --- + **`warnings`** *List* *of Objects* Warnings associated with the `phone`. @@ -133,12 +141,14 @@ Warnings associated with the `phone`. --- + **`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. --- + ## Endpoints diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 766efbc2e..46966311a 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -187,10 +187,12 @@ ID of the action attempt. --- + **`action_type`** *String* --- + **`status`** *Enum*
@@ -204,3 +206,4 @@ ID of the action attempt. --- + diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 9714724f9..68be39a37 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -197,10 +197,12 @@ ID of the action attempt. --- + **`action_type`** *String* --- + **`status`** *Enum*
@@ -214,3 +216,4 @@ ID of the action attempt. --- + diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 53d61b159..baed8e059 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -197,10 +197,12 @@ ID of the action attempt. --- + **`action_type`** *String* --- + **`status`** *Enum*
@@ -214,3 +216,4 @@ ID of the action attempt. --- + diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 38369cc18..70b1ca9d5 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -221,10 +221,12 @@ ID of the action attempt. --- + **`action_type`** *String* --- + **`status`** *Enum*
@@ -238,3 +240,4 @@ ID of the action attempt. --- + diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index f232c9ee2..970e6b0d9 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -169,10 +169,12 @@ ID of the action attempt. --- + **`action_type`** *String* --- + **`status`** *Enum*
@@ -186,3 +188,4 @@ ID of the action attempt. --- + diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 44f489820..7ca952edb 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -14,24 +14,28 @@ Key of the [climate preset](../../../capability-guides/thermostats/creating-and- --- + **`created_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. --- + **`device_id`** *UUID* ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. --- + **`ends_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- + **`errors`** *List* *of Objects* Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). @@ -50,30 +54,35 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther --- + **`max_override_period_minutes`** *Number* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- + **`name`** *String* User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- + **`starts_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- + **`thermostat_schedule_id`** *UUID* ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- + ## Endpoints diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 50d134425..183615953 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -197,10 +197,12 @@ ID of the action attempt. --- + **`action_type`** *String* --- + **`status`** *Enum*
@@ -214,3 +216,4 @@ ID of the action attempt. --- + diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index cb0edbf8d..fede2d545 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -235,10 +235,12 @@ ID of the action attempt. --- + **`action_type`** *String* --- + **`status`** *Enum*
@@ -252,3 +254,4 @@ ID of the action attempt. --- + diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index ac78b5e1f..2ebf52b0e 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -14,44 +14,52 @@ Date and time at which the user identity was created. --- + **`display_name`** *String* --- + **`email_address`** *String* Unique email address for the user identity. --- + **`full_name`** *String* --- + **`phone_number`** *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- + **`user_identity_id`** *UUID* ID of the user identity. --- + **`user_identity_key`** *String* Unique key for the user identity. --- + **`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. --- + ## Endpoints diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 3369e99a5..456eb306c 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -14,30 +14,35 @@ Date and time at which the enrollment automation was created. --- + **`credential_manager_acs_system_id`** *UUID* ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. --- + **`enrollment_automation_id`** *UUID* ID of the enrollment automation. --- + **`user_identity_id`** *UUID* ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). --- + **`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. --- + ## Endpoints From 862fc62b50dfb5c8f07a3328e4e25a3303b9582f Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 13:43:13 -0400 Subject: [PATCH 110/233] Update api-route.hbs --- src/layouts/api-route.hbs | 6 ------ 1 file changed, 6 deletions(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index fae06ef14..5caf4ba1c 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -16,8 +16,6 @@ The {{title}} route contains the following resources: {{/each}} {{#if errors.length}} ---- - ## Errors {{#each errors}} @@ -31,8 +29,6 @@ The {{title}} route contains the following resources: {{/if}} {{#if warnings.length}} ---- - ## Warnings {{#each warnings}} @@ -46,8 +42,6 @@ The {{title}} route contains the following resources: {{/if}} {{#if events.length}} ---- - ## Events {{#each events}} From 8b1d91e03644940d968ed06b41e6dbed4ae843e2 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 17:44:11 +0000 Subject: [PATCH 111/233] ci: Generate docs --- docs/api/access_codes/README.md | 2 -- docs/api/acs/access_groups/README.md | 2 -- docs/api/acs/credentials/README.md | 2 -- docs/api/acs/encoders/README.md | 2 -- docs/api/acs/entrances/README.md | 2 -- docs/api/acs/systems/README.md | 2 -- docs/api/acs/users/README.md | 2 -- docs/api/phones/README.md | 2 -- docs/api/user_identities/enrollment_automations/README.md | 2 -- 9 files changed, 18 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 745c03c2a..59d1ca7c2 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -177,8 +177,6 @@ Collection of warnings associated with the access code, structured in a dictiona ## Endpoints ---- - ## Events **`access_code.created`** diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index b301bfad7..9651f953e 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -171,8 +171,6 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). ---- - ## Events **`acs_access_group.deleted`** diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 0a067e227..41d10b47d 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -334,8 +334,6 @@ Unassigns a specified [credential](../../../capability-guides/access-systems/man Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- - ## Events **`acs_credential.deleted`** diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 6e11e5c6c..a5d1d48ba 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -99,8 +99,6 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/worki Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). ---- - ## Events **`acs_encoder.added`** diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 6a7d52e3f..76a84dbd9 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -289,8 +289,6 @@ Returns a list of all [ACS entrances](../../../capability-guides/access-systems/ Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). ---- - ## Events **`acs_entrance.added`** diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index ed64f3816..f9d8ee992 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -261,8 +261,6 @@ Returns a list of all credential manager ACS systems that are compatible with a [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - ## Events **`acs_system.connected`** diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index fe55c6ab9..48ab99dc8 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -245,8 +245,6 @@ Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - ## Events **`acs_user.deleted`** diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index f28f1a37c..b02c24f6d 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -167,8 +167,6 @@ Returns a single phone entry matching the provided `device_id`. Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. ---- - ## Events **`phone.deactivated`** diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 456eb306c..0417600ab 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -66,8 +66,6 @@ Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-gui Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). ---- - ## Events **`enrollment_automation.deleted`** From 9a4ab5eb8cf626d80615e67ea45a0800b3a7e940 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 13:51:11 -0400 Subject: [PATCH 112/233] Update api-route.hbs --- src/layouts/api-route.hbs | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 5caf4ba1c..17b55f940 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -4,16 +4,6 @@ The {{title}} route contains the following resources: {{#each resources}} {{> api-resource }} -{{/each}} -## Endpoints - -{{#each endpoints}} - -[**`{{path}}`**](./{{name}}.md) - -{{description}} - -{{/each}} {{#if errors.length}} ## Errors @@ -40,6 +30,7 @@ The {{title}} route contains the following resources: {{/each}} {{/if}} +{{/each}} {{#if events.length}} ## Events @@ -62,3 +53,13 @@ The {{title}} route contains the following resources: {{/each}} {{/if}} +## Endpoints + +{{#each endpoints}} + +[**`{{path}}`**](./{{name}}.md) + +{{description}} + +{{/each}} + From 5794f0b3d8bd19b8edefaf403504636d24cf41ca Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 17:52:09 +0000 Subject: [PATCH 113/233] ci: Generate docs --- docs/api/access_codes/README.md | 309 +++++++++++++++++- docs/api/acs/access_groups/README.md | 65 ++-- docs/api/acs/credentials/README.md | 84 +++-- docs/api/acs/encoders/README.md | 35 +- docs/api/acs/encoders/simulate/README.md | 1 + docs/api/acs/entrances/README.md | 45 +-- docs/api/acs/systems/README.md | 75 ++++- docs/api/acs/users/README.md | 113 +++++-- docs/api/phones/README.md | 35 +- docs/api/phones/simulate/README.md | 1 + docs/api/thermostats/README.md | 1 + docs/api/thermostats/schedules/README.md | 1 + docs/api/thermostats/simulate/README.md | 1 + docs/api/user_identities/README.md | 1 + .../enrollment_automations/README.md | 45 +-- 15 files changed, 642 insertions(+), 170 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 59d1ca7c2..a44fb7920 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -174,7 +174,311 @@ Collection of warnings associated with the access code, structured in a dictiona --- -## Endpoints + +## Errors + +**`smartthings_failed_to_set_access_code`** + +Failed to set code on Smart Things device. + +--- + +**`smartthings_failed_to_set_after_multiple_retries`** + +Failed to set code after multiple retries. + +--- + +**`smartthings_no_free_slots_available`** + +No free slots available on the device. + +--- + +**`failed_to_set_on_device`** + +Failed to set code on device. + +--- + +**`failed_to_remove_from_device`** + +Failed to remove code from device. + +--- + +**`duplicate_code_on_device`** + +Duplicate access code detected on device. + +--- + +**`duplicate_code_attempt_prevented`** + +An attempt to modify this access code was prevented. + +--- + +**`igloohome_bridge_too_many_pending_jobs`** + +Igloohome bridge has too many pending jobs in the queue. + +--- + +**`igloohome_bridge_offline`** + +Igloohome bridge is offline. + +--- + +**`igloohome_offline_access_code_no_variance_available`** + +Lock as reached max amount of codes. + +--- + +**`kwikset_unable_to_confirm_code`** + +Unable to confirm the access code is set on Kwikset device. + +--- + +**`kwikset_unable_to_confirm_deletion`** + +Unable to confirm the deletion of the access code on Kwikset device. + +--- + +**`code_modified_external_to_seam`** + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +**`august_lock_invalid_code_length`** + +Invalid code length for August lock. + +--- + +**`august_device_programming_delay`** + +Access code has not yet been fully moved to the device. + +--- + +**`august_device_slots_full`** + +All access code slots on the device are full. + +--- + +**`august_lock_missing_keypad`** + +August lock is missing a keypad. + +--- + +**`august_lock_temporarily_offline`** + +August lock is temporarily offline. + +--- + +**`salto_ks_user_not_subscribed`** + +Salto site user is not subscribed. + +--- + +**`hubitat_device_programming_delay`** + +Access code has not yet been fully moved to the device. + +--- + +**`hubitat_no_free_positions_available`** + +No free positions available on the device. + +--- + +**`wyze_duplicate_code_name`** + +Duplicate access code name detected. + +--- + +**`wyze_potential_duplicate_code`** + +Potential duplicate access code detected. + +--- + +**`dormakaba_oracode_no_valid_user_level`** + +No valid user level for Oracode. + +--- + +**`account_disconnected`** + +Account is disconnected + +--- + +**`salto_ks_subscription_limit_exceeded`** + +Salto site user limit reached. + +--- + +**`device_offline`** + +Device is offline + +--- + +**`device_removed`** + +Device has been removed + +--- + +**`hub_disconnected`** + +Hub is disconnected + +--- + +**`device_disconnected`** + +Device is disconnected + +--- + +**`empty_backup_access_code_pool`** + +The backup access code pool is empty. + +--- + +**`august_lock_not_authorized`** + +User is not authorized to use the August Lock. + +--- + +**`august_lock_missing_bridge`** + +Lock is not connected to the Seam Bridge. + +--- + +**`ttlock_lock_not_paired_to_gateway`** + +Lock is not paired with a Gateway. + +--- + +**`missing_device_credentials`** + +Missing device credentials. + +--- + +**`auxiliary_heat_running`** + +The auxiliary heat is running. + +--- + +**`subscription_required`** + +Subscription required to connect. + +--- + +**`invalid_credentials`** + +Credentials provided were invalid. + +--- + + +## Warnings + +**`smartthings_failed_to_set_access_code`** + +Failed to set code on Smart Things device. + +--- + +**`schlage_detected_duplicate`** + +Duplicate access code detected. + +--- + +**`schlage_creation_outage`** + +Received an error when attempting to create this code. + +--- + +**`code_modified_external_to_seam`** + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +**`delay_in_setting_on_device`** + +Delay in setting code on device. + +--- + +**`delay_in_removing_from_device`** + +Delay in removing code from device. + +--- + +**`third_party_integration_detected`** + +Third party integration detected that may cause access codes to fail. + +--- + +**`august_device_programming_delay`** + +Access code has not yet been fully moved to the device. + +--- + +**`august_lock_temporarily_offline`** + +August lock is temporarily offline. + +--- + +**`igloo_algopin_must_be_used_within_24_hours`** + +Algopins must be used within 24 hours. + +--- + +**`management_transferred`** + +Management was transferred to another workspace. + +--- + +**`kwikset_unable_to_confirm_code`** + +Unable to confirm the access code is set on Kwikset device. + +--- ## Events @@ -1136,3 +1440,6 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
+## Endpoints + + diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 9651f953e..f2cbef027 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -138,38 +138,6 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -## Endpoints - - -[**`/acs/access_groups/add_user`**](./add_user.md) - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - - -[**`/acs/access_groups/get`**](./get.md) - -Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - - -[**`/acs/access_groups/list`**](./list.md) - -Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - - -[**`/acs/access_groups/list_accessible_entrances`**](./list_accessible_entrances.md) - -Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - - -[**`/acs/access_groups/list_users`**](./list_users.md) - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - - -[**`/acs/access_groups/remove_user`**](./remove_user.md) - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). - ## Events @@ -226,3 +194,36 @@ An ACS access group was deleted.
+## Endpoints + + +[**`/acs/access_groups/add_user`**](./add_user.md) + +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/get`**](./get.md) + +Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/list`**](./list.md) + +Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/list_accessible_entrances`**](./list_accessible_entrances.md) + +Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/list_users`**](./list_users.md) + +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/access_groups/remove_user`**](./remove_user.md) + +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 41d10b47d..a70ef34ec 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -291,47 +291,44 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -## Endpoints - - -[**`/acs/credentials/assign`**](./assign.md) - -Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - - -[**`/acs/credentials/create`**](./create.md) -Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Warnings +**`waiting_to_be_issued`** -[**`/acs/credentials/delete`**](./delete.md) +Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued. -Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- +**`schedule_externally_modified`** -[**`/acs/credentials/get`**](./get.md) +Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally. -Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- +**`schedule_modified`** -[**`/acs/credentials/list`**](./list.md) +Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past. -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). +--- +**`being_deleted`** -[**`/acs/credentials/list_accessible_entrances`**](./list_accessible_entrances.md) +Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted. -Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. +--- +**`unknown_issue_with_acs_credential`** -[**`/acs/credentials/unassign`**](./unassign.md) +An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential. -Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- +**`needs_to_be_reissued`** -[**`/acs/credentials/update`**](./update.md) +Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential. -Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +--- ## Events @@ -495,3 +492,46 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
+## Endpoints + + +[**`/acs/credentials/assign`**](./assign.md) + +Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + +[**`/acs/credentials/create`**](./create.md) + +Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + +[**`/acs/credentials/delete`**](./delete.md) + +Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + + +[**`/acs/credentials/get`**](./get.md) + +Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + + +[**`/acs/credentials/list`**](./list.md) + +Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). + + +[**`/acs/credentials/list_accessible_entrances`**](./list_accessible_entrances.md) + +Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. + + +[**`/acs/credentials/unassign`**](./unassign.md) + +Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + +[**`/acs/credentials/update`**](./update.md) + +Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + + diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index a5d1d48ba..fe990c240 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -81,23 +81,6 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -## Endpoints - - -[**`/acs/encoders/encode_credential`**](./encode_credential.md) - -Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - - -[**`/acs/encoders/list`**](./list.md) - -Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - - -[**`/acs/encoders/scan_credential`**](./scan_credential.md) - -Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). - ## Events @@ -211,3 +194,21 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
+## Endpoints + + +[**`/acs/encoders/encode_credential`**](./encode_credential.md) + +Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + + +[**`/acs/encoders/list`**](./list.md) + +Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + + +[**`/acs/encoders/scan_credential`**](./scan_credential.md) + +Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + + diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index dd72c780f..041564aad 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -24,3 +24,4 @@ Simulates that the next attempt to scan a [credential](../../../../capability-gu Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 76a84dbd9..5273e1986 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -266,28 +266,6 @@ Visionline-specific metadata associated with the [entrance](../../../capability- --- -## Endpoints - - -[**`/acs/entrances/get`**](./get.md) - -Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - - -[**`/acs/entrances/grant_access`**](./grant_access.md) - - - - -[**`/acs/entrances/list`**](./list.md) - -Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). - - -[**`/acs/entrances/list_credentials_with_access`**](./list_credentials_with_access.md) - -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - ## Events @@ -397,3 +375,26 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
+## Endpoints + + +[**`/acs/entrances/get`**](./get.md) + +Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + + +[**`/acs/entrances/grant_access`**](./grant_access.md) + + + + +[**`/acs/entrances/list`**](./list.md) + +Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). + + +[**`/acs/entrances/list_credentials_with_access`**](./list_credentials_with_access.md) + +Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + + diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index f9d8ee992..ab63fe1f0 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -242,23 +242,63 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -## Endpoints +## Errors -[**`/acs/systems/get`**](./get.md) +**`seam_bridge_disconnected`** -Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +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. + This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md). + See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). +--- -[**`/acs/systems/list`**](./list.md) +**`visionline_instance_unreachable`** -Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). +Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). + For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../../../core-concepts/workspaces/README.md). + See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable). + +--- +**`salto_ks_subscription_limit_exceeded`** -[**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md) +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. -Returns a list of all credential manager ACS systems that are compatible with a specified -[access control system](https://docs.seam.co/latest/capability-guides/access-systems). +--- + +**`acs_system_disconnected`** + +Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue. + +--- + +**`account_disconnected`** + +Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access. + +--- + +**`salto_ks_certification_expired`** + +Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. + +--- + + +## Warnings + +**`salto_ks_subscription_limit_almost_reached`** + +Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue. + +--- + +**`time_zone_does_not_match_location`** + +Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). + +--- ## Events @@ -410,3 +450,22 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
+## Endpoints + + +[**`/acs/systems/get`**](./get.md) + +Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + + +[**`/acs/systems/list`**](./list.md) + +Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). + + +[**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md) + +Returns a list of all credential manager ACS systems that are compatible with a specified +[access control system](https://docs.seam.co/latest/capability-guides/access-systems). + + diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 48ab99dc8..ed2529181 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -187,62 +187,59 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -## Endpoints - - -[**`/acs/users/add_to_access_group`**](./add_to_access_group.md) - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +## Errors -[**`/acs/users/create`**](./create.md) - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - - -[**`/acs/users/delete`**](./delete.md) +**`deleted_externally`** -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). +Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam. +--- -[**`/acs/users/get`**](./get.md) +**`salto_ks_subscription_limit_exceeded`** -Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. +--- -[**`/acs/users/list`**](./list.md) +**`failed_to_create_on_acs_system`** -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). +--- -[**`/acs/users/list_accessible_entrances`**](./list_accessible_entrances.md) +**`failed_to_update_on_acs_system`** -Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. +Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). +--- -[**`/acs/users/remove_from_access_group`**](./remove_from_access_group.md) +**`failed_to_delete_on_acs_system`** -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). +--- -[**`/acs/users/revoke_access_to_all_entrances`**](./revoke_access_to_all_entrances.md) -Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +## Warnings +**`being_deleted`** -[**`/acs/users/suspend`**](./suspend.md) +Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly. -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. +--- +**`salto_ks_user_not_subscribed`** -[**`/acs/users/unsuspend`**](./unsuspend.md) +Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. +--- +**`unknown_issue_with_acs_user`** -[**`/acs/users/update`**](./update.md) +An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. -Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +--- ## Events @@ -300,3 +297,61 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
+## Endpoints + + +[**`/acs/users/add_to_access_group`**](./add_to_access_group.md) + +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/users/create`**](./create.md) + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + +[**`/acs/users/delete`**](./delete.md) + +Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). + + +[**`/acs/users/get`**](./get.md) + +Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + +[**`/acs/users/list`**](./list.md) + +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + +[**`/acs/users/list_accessible_entrances`**](./list_accessible_entrances.md) + +Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. + + +[**`/acs/users/remove_from_access_group`**](./remove_from_access_group.md) + +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +[**`/acs/users/revoke_access_to_all_entrances`**](./revoke_access_to_all_entrances.md) + +Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + +[**`/acs/users/suspend`**](./suspend.md) + +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + + +[**`/acs/users/unsuspend`**](./unsuspend.md) + +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + + +[**`/acs/users/update`**](./update.md) + +Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index b02c24f6d..37c9d298a 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -149,23 +149,6 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th --- -## Endpoints - - -[**`/phones/deactivate`**](./deactivate.md) - -Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). - - -[**`/phones/get`**](./get.md) - -Returns a single phone entry matching the provided `device_id`. - - -[**`/phones/list`**](./list.md) - -Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. - ## Events @@ -212,3 +195,21 @@ A phone device was deactivated.
+## Endpoints + + +[**`/phones/deactivate`**](./deactivate.md) + +Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). + + +[**`/phones/get`**](./get.md) + +Returns a single phone entry matching the provided `device_id`. + + +[**`/phones/list`**](./list.md) + +Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. + + diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index a35db54d2..4f2e3d8bb 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -9,3 +9,4 @@ The Phone Simulations route contains the following resources: Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). + diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index 94a7da664..d32978ee5 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -69,3 +69,4 @@ Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-m Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 7ca952edb..f6bd29d35 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -110,3 +110,4 @@ Returns a list of all [thermostat schedules](../../../capability-guides/thermost Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index 83bc7ed0d..87837884e 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -14,3 +14,4 @@ Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). + diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 2ebf52b0e..10661348e 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -122,3 +122,4 @@ Revokes access to a specified [device](../../core-concepts/devices/README.md) fr + diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 0417600ab..1368d6aa6 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -43,28 +43,6 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains --- -## Endpoints - - -[**`/user_identities/enrollment_automations/delete`**](./delete.md) - -Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). - - -[**`/user_identities/enrollment_automations/get`**](./get.md) - -Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). - - -[**`/user_identities/enrollment_automations/launch`**](./launch.md) - -Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). - - -[**`/user_identities/enrollment_automations/list`**](./list.md) - -Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). - ## Events @@ -111,3 +89,26 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
+## Endpoints + + +[**`/user_identities/enrollment_automations/delete`**](./delete.md) + +Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). + + +[**`/user_identities/enrollment_automations/get`**](./get.md) + +Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + + +[**`/user_identities/enrollment_automations/launch`**](./launch.md) + +Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + + +[**`/user_identities/enrollment_automations/list`**](./list.md) + +Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + From 53ec2cbbf1f8a3e5e83369c91c7036250b6af41a Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 13:55:03 -0400 Subject: [PATCH 114/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 5c90a211c..1df56cb1e 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -8,6 +8,8 @@ {{description}} {{/if}} +--- + {{#if headingOffset}} ### Properties {{else}} From 1eb8c855dd119d4d4e19cad6ac530304ed357e33 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 17:56:05 +0000 Subject: [PATCH 115/233] ci: Generate docs --- docs/api/access_codes/README.md | 2 ++ docs/api/acs/access_groups/README.md | 2 ++ docs/api/acs/credentials/README.md | 2 ++ docs/api/acs/encoders/README.md | 2 ++ docs/api/acs/encoders/encode_credential.md | 2 ++ docs/api/acs/encoders/scan_credential.md | 2 ++ docs/api/acs/entrances/README.md | 2 ++ docs/api/acs/systems/README.md | 2 ++ docs/api/acs/users/README.md | 2 ++ docs/api/phones/README.md | 2 ++ docs/api/thermostats/activate_climate_preset.md | 2 ++ docs/api/thermostats/cool.md | 2 ++ docs/api/thermostats/heat.md | 2 ++ docs/api/thermostats/heat_cool.md | 2 ++ docs/api/thermostats/off.md | 2 ++ docs/api/thermostats/schedules/README.md | 2 ++ docs/api/thermostats/set_fan_mode.md | 2 ++ docs/api/thermostats/set_hvac_mode.md | 2 ++ docs/api/user_identities/README.md | 2 ++ docs/api/user_identities/enrollment_automations/README.md | 2 ++ 20 files changed, 40 insertions(+) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index a44fb7920..efff6519a 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -4,6 +4,8 @@ The Access Codes route contains the following resources: ## The `access_code` Resource +--- + ## Properties **`access_code_id`** *UUID* diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index f2cbef027..d5a4f8a9b 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -10,6 +10,8 @@ Some access control systems use [access group](https://docs.seam.co/latest/capab To learn whether your access control system supports access groups, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +--- + ## Properties **`access_group_type`** *Enum* diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index a70ef34ec..85a7e9804 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -10,6 +10,8 @@ An access control system generally uses digital means of access to authorize a u For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. +--- + ## Properties **`access_method`** *Enum* diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index fe990c240..340c8aa92 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -19,6 +19,8 @@ Separately, the Seam API also supports card scanning, which enables you to scan To verify if your access control system requires a card encoder, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +--- + ## Properties **`acs_encoder_id`** *UUID* diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 1092107ac..94f1c3141 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -47,6 +47,8 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. Action attempt to track encoding credential data from the physical encoder onto a card. +--- + ### Properties **`action_attempt_id`** *UUID* diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 906e60cb5..e458f4da5 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -38,6 +38,8 @@ ID of the `acs_encoder` to use for the scan. Reading credential data from physical encoder. +--- + ### Properties **`action_attempt_id`** *UUID* diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 5273e1986..e0ed7c130 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -8,6 +8,8 @@ Represents an [entrance](../../../capability-guides/access-systems/retrieving-en 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. +--- + ## Properties **`acs_entrance_id`** *UUID* diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index ab63fe1f0..4ca8afde5 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -10,6 +10,8 @@ Within an `acs_system`, create [`acs_user`s](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/latest/api/acs). +--- + ## Properties **`acs_system_id`** *UUID* diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index ed2529181..278c7be6c 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -10,6 +10,8 @@ An `acs_user` typically refers to an individual who requires access, like an emp For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +--- + ## Properties **`access_schedule`** *Object* diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 37c9d298a..e218d5bdc 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -6,6 +6,8 @@ The Phones route contains the following resources: Represents an app user's mobile phone. +--- + ## Properties **`created_at`** *Datetime* diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 46966311a..5cc820a71 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -179,6 +179,8 @@ ID of the desired thermostat device. Activating climate preset. +--- + ### Properties **`action_attempt_id`** *UUID* diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 68be39a37..924cb22cd 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -189,6 +189,8 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +--- + ### Properties **`action_attempt_id`** *UUID* diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index baed8e059..adc78f228 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -189,6 +189,8 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +--- + ### Properties **`action_attempt_id`** *UUID* diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 70b1ca9d5..93a064403 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -213,6 +213,8 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +--- + ### Properties **`action_attempt_id`** *UUID* diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 970e6b0d9..5f9551b38 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -161,6 +161,8 @@ ID of the desired thermostat device. Setting HVAC mode. +--- + ### Properties **`action_attempt_id`** *UUID* diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index f6bd29d35..0d69508bb 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -6,6 +6,8 @@ The Thermostat Schedules route contains the following resources: Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. +--- + ## Properties **`climate_preset_key`** *String* diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 183615953..eb6245537 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -189,6 +189,8 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos Setting fan mode. +--- + ### Properties **`action_attempt_id`** *UUID* diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index fede2d545..f4ffbb0c2 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -227,6 +227,8 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +--- + ### Properties **`action_attempt_id`** *UUID* diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 10661348e..06b95b7a1 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -6,6 +6,8 @@ The User Identities route contains the following resources: Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. +--- + ## Properties **`created_at`** *Datetime* diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 1368d6aa6..cae5b230a 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -6,6 +6,8 @@ The Enrollment Automations route contains the following resources: Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). +--- + ## Properties **`created_at`** *Datetime* From d1ec958f2bf101562e97df4c172200bd7161bfd1 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 14:05:17 -0400 Subject: [PATCH 116/233] Update api-route.hbs --- src/layouts/api-route.hbs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 17b55f940..d90e3ae92 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -51,6 +51,8 @@ The {{title}} route contains the following resources: {{/each}}
+--- + {{/each}} {{/if}} ## Endpoints From b933f15209152d6fd70e493749d2e3e9ec0ae899 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 18:06:15 +0000 Subject: [PATCH 117/233] ci: Generate docs --- docs/api/access_codes/README.md | 34 +++++++++++++++++++ docs/api/acs/access_groups/README.md | 2 ++ docs/api/acs/credentials/README.md | 6 ++++ docs/api/acs/encoders/README.md | 4 +++ docs/api/acs/entrances/README.md | 4 +++ docs/api/acs/systems/README.md | 6 ++++ docs/api/acs/users/README.md | 2 ++ docs/api/phones/README.md | 2 ++ .../enrollment_automations/README.md | 2 ++ 9 files changed, 62 insertions(+) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index efff6519a..aed29ea90 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -540,6 +540,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.changed`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed. @@ -595,6 +597,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.scheduled_on_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device. @@ -656,6 +660,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.set_on_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device. @@ -717,6 +723,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.removed_from_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device. @@ -772,6 +780,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.delay_in_setting_on_device`** There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device. @@ -827,6 +837,8 @@ There was an unusually long delay in setting an [access code](https://docs.seam.
+--- + **`access_code.failed_to_set_on_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device. @@ -882,6 +894,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.deleted`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted. @@ -943,6 +957,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.delay_in_removing_from_device`** There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device. @@ -998,6 +1014,8 @@ There was an unusually long delay in removing an [access code](https://docs.seam
+--- + **`access_code.failed_to_remove_from_device`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device. @@ -1053,6 +1071,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.modified_external_to_seam`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam. @@ -1108,6 +1128,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.deleted_external_to_seam`** An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam. @@ -1163,6 +1185,8 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
+--- + **`access_code.backup_access_code_pulled`** A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device. @@ -1222,6 +1246,8 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks
+--- + **`access_code.unmanaged.converted_to_managed`** An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code. @@ -1277,6 +1303,8 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
+--- + **`access_code.unmanaged.failed_to_convert_to_managed`** An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code. @@ -1332,6 +1360,8 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l +--- + **`access_code.unmanaged.created`** An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device. @@ -1387,6 +1417,8 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l +--- + **`access_code.unmanaged.removed`** An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device. @@ -1442,6 +1474,8 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l +--- + ## Endpoints diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index d5a4f8a9b..cd13a5ef7 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -196,6 +196,8 @@ An ACS access group was deleted. +--- + ## Endpoints diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 85a7e9804..c4e76b22d 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -388,6 +388,8 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia +--- + **`acs_credential.issued`** An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was issued. @@ -441,6 +443,8 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia +--- + **`acs_credential.reissued`** An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was reissued. @@ -494,6 +498,8 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia +--- + ## Endpoints diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 340c8aa92..eda889bcf 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -141,6 +141,8 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc +--- + **`acs_encoder.removed`** An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was removed. @@ -196,6 +198,8 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc +--- + ## Endpoints diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index e0ed7c130..3ce9e24ce 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -324,6 +324,8 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra +--- + **`acs_entrance.removed`** An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed. @@ -377,6 +379,8 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra +--- + ## Endpoints diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 4ca8afde5..cb8ee4280 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -354,6 +354,8 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa +--- + **`acs_system.added`** An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added. @@ -403,6 +405,8 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa +--- + **`acs_system.disconnected`** An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected. @@ -452,6 +456,8 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa +--- + ## Endpoints diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 278c7be6c..56c4cbd3e 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -299,6 +299,8 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user- +--- + ## Endpoints diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index e218d5bdc..45bea0bbd 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -197,6 +197,8 @@ A phone device was deactivated. +--- + ## Endpoints diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index cae5b230a..a32cade26 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -91,6 +91,8 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi +--- + ## Endpoints From 9048658639e578f3ff255d352bf1d3092198af39 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 14:15:16 -0400 Subject: [PATCH 118/233] Update api-route.ts --- src/lib/layout/api-route.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lib/layout/api-route.ts b/src/lib/layout/api-route.ts index d3249a699..e2254f786 100644 --- a/src/lib/layout/api-route.ts +++ b/src/lib/layout/api-route.ts @@ -289,8 +289,8 @@ function addLinkTargetsToProperties( sections: { errors: boolean; warnings: boolean }, ): void { const linkableProperties: Record = { - errors: sections.errors ? './#errors-1' : undefined, - warnings: sections.warnings ? './#warnings-1' : undefined, + errors: sections.errors ? './#errors' : undefined, + warnings: sections.warnings ? './#warnings' : undefined, } for (const prop of properties) { From 7401a3c914ae18b750d998c53a899d846eee6beb Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 18:16:24 +0000 Subject: [PATCH 119/233] ci: Generate docs --- docs/api/access_codes/README.md | 4 ++-- docs/api/acs/credentials/README.md | 2 +- docs/api/acs/systems/README.md | 4 ++-- docs/api/acs/users/README.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index aed29ea90..7624bfc56 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -50,7 +50,7 @@ Date and time after which the time-bound access code becomes inactive. --- -[**`errors`**](./#errors-1) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. @@ -169,7 +169,7 @@ Nature of the access code. Values are "ongoing" for access codes that are active --- -[**`warnings`**](./#warnings-1) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index c4e76b22d..3c3c9de56 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -279,7 +279,7 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc --- -[**`warnings`**](./#warnings-1) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index cb8ee4280..ffc582cad 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -81,7 +81,7 @@ ID of the default credential manager `acs_system` for this [access control syste --- -[**`errors`**](./#errors-1) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -230,7 +230,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -[**`warnings`**](./#warnings-1) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 56c4cbd3e..18d757a17 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -82,7 +82,7 @@ Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -[**`errors`**](./#errors-1) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). @@ -175,7 +175,7 @@ Phone number of the user identity associated with the [ACS user](https://docs.se --- -[**`warnings`**](./#warnings-1) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). From 54bae25e96dff84378c0673bc7aa4ad438ebe192 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 14:21:15 -0400 Subject: [PATCH 120/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 1df56cb1e..8981ea033 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -55,10 +55,15 @@ This object has no properties. {{/if}} {{/unless}} {{#if listProperties}} +
+ +Child Properties {{#each listProperties}} - {{> property-nested this}} {{/each}} +
+ {{/if}} --- From be5717f774b0161ac9369d01b7c8aefe5f514537 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 18:22:21 +0000 Subject: [PATCH 121/233] ci: Generate docs --- docs/api/acs/access_groups/README.md | 5 +++++ docs/api/acs/credentials/README.md | 5 +++++ docs/api/acs/encoders/README.md | 5 +++++ docs/api/acs/entrances/README.md | 5 +++++ docs/api/phones/README.md | 10 ++++++++++ docs/api/thermostats/schedules/README.md | 5 +++++ 6 files changed, 35 insertions(+) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index cd13a5ef7..030e88a62 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -112,6 +112,9 @@ Name of the access group. Warnings associated with the `acs_access_group`. +
+ +Child Properties - created_at Datetime @@ -130,6 +133,8 @@ Warnings associated with the `acs_access_group`. Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. +
+ --- diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 3c3c9de56..bbc23f210 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -127,6 +127,9 @@ Date and time at which the [credential](../../../capability-guides/access-system Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). +
+ +Child Properties - error_code String @@ -135,6 +138,8 @@ Errors associated with the [credential](../../../capability-guides/access-system - message String +
+ --- diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index eda889bcf..ad48292b7 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -55,6 +55,9 @@ Display name for the [encoder](../../../capability-guides/access-systems/working Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). +
+ +Child Properties - created_at Datetime @@ -73,6 +76,8 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w Detailed description of the error. Provides insights into the issue and potentially how to rectify it. +
+ --- diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 3ce9e24ce..c16e0d5e8 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -103,6 +103,9 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +
+ +Child Properties - error_code String @@ -115,6 +118,8 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/ Detailed description of the error. Provides insights into the issue and potentially how to rectify it. +
+ --- diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 45bea0bbd..8a050f9e8 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -57,6 +57,9 @@ Display name of the phone. Defaults to `nickname` (if it is set) or `properties. Errors associated with the `phone`. +
+ +Child Properties - error_code String @@ -65,6 +68,8 @@ Errors associated with the `phone`. - message String +
+ --- @@ -133,6 +138,9 @@ Properties of the phone. Warnings associated with the `phone`. +
+ +Child Properties - message String @@ -141,6 +149,8 @@ Warnings associated with the `phone`. - warning_code String +
+ --- diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 0d69508bb..50b05657c 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -42,6 +42,9 @@ Date and time at which the [thermostat schedule](../../../capability-guides/ther Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +
+ +Child Properties - error_code String @@ -54,6 +57,8 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther Detailed description of the error. Provides insights into the issue and potentially how to rectify it. +
+ --- From 19f66c2ce6530311451f72ce08cb63aadb42e2f0 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 30 Mar 2025 14:24:20 -0400 Subject: [PATCH 122/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 8981ea033..739db4dd7 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -57,7 +57,7 @@ This object has no properties. {{#if listProperties}}
-Child Properties +Child Object Properties {{#each listProperties}} - {{> property-nested this}} From 99f0874fa0dac71e02db6971ef4ad5bbf228d4e5 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 30 Mar 2025 18:25:18 +0000 Subject: [PATCH 123/233] ci: Generate docs --- docs/api/acs/access_groups/README.md | 2 +- docs/api/acs/credentials/README.md | 2 +- docs/api/acs/encoders/README.md | 2 +- docs/api/acs/entrances/README.md | 2 +- docs/api/phones/README.md | 4 ++-- docs/api/thermostats/schedules/README.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 030e88a62..a560caec7 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -114,7 +114,7 @@ Warnings associated with the `acs_access_group`.
-Child Properties +Child Object Properties - created_at Datetime diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index bbc23f210..fe87f8206 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -129,7 +129,7 @@ Errors associated with the [credential](../../../capability-guides/access-system
-Child Properties +Child Object Properties - error_code String diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index ad48292b7..da5f3b60e 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -57,7 +57,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
-Child Properties +Child Object Properties - created_at Datetime diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index c16e0d5e8..59324f772 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -105,7 +105,7 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
-Child Properties +Child Object Properties - error_code String diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 8a050f9e8..c33b9a4b4 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -59,7 +59,7 @@ Errors associated with the `phone`.
-Child Properties +Child Object Properties - error_code String @@ -140,7 +140,7 @@ Warnings associated with the `phone`.
-Child Properties +Child Object Properties - message String diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 50b05657c..7849aa3ce 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -44,7 +44,7 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
-Child Properties +Child Object Properties - error_code String From 8f6db2bc37f8f475da33c2a2d5775118c098e937 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:04:59 +0200 Subject: [PATCH 124/233] Fix typo --- src/layouts/api-endpoint.hbs | 4 ++-- src/lib/layout/api-endpoint.ts | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 23df0a346..f1b91f3cd 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -46,11 +46,11 @@ None {{> api-resource headingOffset=true}} {{/with}} -{{#if addtionalCodeSamples.length}} +{{#if additionalCodeSamples.length}} ## Additional Code Samples -{{#each addtionalCodeSamples}} +{{#each additionalCodeSamples}} {{> code-sample }} {{/each}} {{/if}} diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index 36f82ac58..53de2921a 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -45,7 +45,7 @@ export interface ApiEndpointLayoutContext { actionAttempt?: ApiRouteResource } primaryCodeSample: CodeSampleContext | null - addtionalCodeSamples: CodeSampleContext[] + additionalCodeSamples: CodeSampleContext[] } interface CodeSampleContext { @@ -153,10 +153,10 @@ export function setEndpointLayoutContext( } } - const [primaryCodeSample, ...addtionalCodeSamples] = endpoint.codeSamples + const [primaryCodeSample, ...additionalCodeSamples] = endpoint.codeSamples file.primaryCodeSample = primaryCodeSample == null ? null : mapCodeSample(primaryCodeSample) - file.addtionalCodeSamples = addtionalCodeSamples.map(mapCodeSample) + file.additionalCodeSamples = additionalCodeSamples.map(mapCodeSample) } const mapCodeSample = (sample: CodeSample): CodeSampleContext => { From f43544059fcba9f66a9a8a09d0a69f4f2d757233 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:21:49 +0200 Subject: [PATCH 125/233] Add item format for array request params --- package-lock.json | 8 ++++---- package.json | 2 +- src/layouts/api-endpoint.hbs | 7 +++++++ src/layouts/partials/enum-values.hbs | 4 ++++ src/lib/layout/api-endpoint.ts | 9 +++++++++ 5 files changed, 25 insertions(+), 5 deletions(-) create mode 100644 src/layouts/partials/enum-values.hbs diff --git a/package-lock.json b/package-lock.json index 3ec2d7e13..7e5295b0e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13,7 +13,7 @@ "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", - "@seamapi/blueprint": "^0.37.1", + "@seamapi/blueprint": "^0.38.0", "@seamapi/types": "1.369.2", "change-case": "^5.4.4", "command-exists": "^1.2.9", @@ -767,9 +767,9 @@ "peer": true }, "node_modules/@seamapi/blueprint": { - "version": "0.37.1", - "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.37.1.tgz", - "integrity": "sha512-OSJqrWL3KzCWgNiw4gw+5Cp1PHCb+BudWFa6+7bd+RQDL/fzwC6RvlcFAp4Md3Fw2SYfxrH7uEwVTEhJYrPIjQ==", + "version": "0.38.0", + "resolved": "https://npm.pkg.github.com/download/@seamapi/blueprint/0.38.0/31038259651b23b963051292381bb4fef8ab07cb", + "integrity": "sha512-NlmzFZgoWORyKIsrKpTUdwOwHLzyV421VsYbDEPD/s/2c4wZoQdunjLHc1qgdfqvb5602+XVFldyi6bs0ssRNA==", "license": "MIT", "dependencies": { "change-case": "^5.4.4", diff --git a/package.json b/package.json index 452147c2c..400f44404 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "@metalsmith/metadata": "^0.3.0", "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", - "@seamapi/blueprint": "^0.37.1", + "@seamapi/blueprint": "^0.38.0", "@seamapi/types": "1.369.2", "change-case": "^5.4.4", "command-exists": "^1.2.9", diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index f1b91f3cd..3d71edc58 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -28,7 +28,14 @@ ### `{{this.name}}` Type: `{{this.jsonType}}` +{{#if this.itemFormat}} +Item format: `{{this.itemFormat}}` +{{/if}} Required: {{#if this.required}}Yes{{else}}No{{/if}} +{{#if this.itemEnumValues}} + +{{> enum-values enumValues=this.itemEnumValues}} +{{/if}} {{this.description}} diff --git a/src/layouts/partials/enum-values.hbs b/src/layouts/partials/enum-values.hbs new file mode 100644 index 000000000..b5df183d8 --- /dev/null +++ b/src/layouts/partials/enum-values.hbs @@ -0,0 +1,4 @@ +Possible enum values: +{{#each enumValues}} +- `{{this}}` +{{/each}} \ No newline at end of file diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index 53de2921a..defdc40f1 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -2,6 +2,7 @@ import type { ActionAttempt, CodeSampleSdk, Endpoint, + EnumProperty, SeamAuthMethod, SeamWorkspaceScope, } from '@seamapi/blueprint' @@ -34,6 +35,8 @@ export interface ApiEndpointLayoutContext { required: boolean description: string jsonType: string + itemFormat?: string + itemEnumValues?: EnumProperty['values'] }> } response: { @@ -106,6 +109,12 @@ export function setEndpointLayoutContext( required: param.isRequired, description: param.description, jsonType: param.jsonType, + ...(param.jsonType === 'array' && { + itemFormat: param.itemFormat, + ...(param.itemFormat === 'enum' && { + itemEnumValues: param.itemEnumValues, + }), + }), })) .sort((a, b) => { if (a.required && !b.required) return -1 From db30d747ee867021275f8b834fe2f9dac07ca8fc Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:24:38 +0200 Subject: [PATCH 126/233] Fix blueprint registry url --- package-lock.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index 7e5295b0e..0468b2834 100644 --- a/package-lock.json +++ b/package-lock.json @@ -768,7 +768,7 @@ }, "node_modules/@seamapi/blueprint": { "version": "0.38.0", - "resolved": "https://npm.pkg.github.com/download/@seamapi/blueprint/0.38.0/31038259651b23b963051292381bb4fef8ab07cb", + "resolved": "https://registry.npmjs.org/@seamapi/blueprint/-/blueprint-0.38.0.tgz", "integrity": "sha512-NlmzFZgoWORyKIsrKpTUdwOwHLzyV421VsYbDEPD/s/2c4wZoQdunjLHc1qgdfqvb5602+XVFldyi6bs0ssRNA==", "license": "MIT", "dependencies": { From 140dfa459f7f90989d8d87958765d2e3688035b1 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 13:25:39 +0000 Subject: [PATCH 127/233] ci: Generate docs --- docs/api/_report.md | 27 +++++++++++++ docs/api/acs/credentials/create.md | 1 + docs/api/acs/encoders/list.md | 2 + .../entrances/list_credentials_with_access.md | 4 ++ docs/api/acs/users/create.md | 1 + docs/api/thermostats/list.md | 40 +++++++++++++++++++ 6 files changed, 75 insertions(+) diff --git a/docs/api/_report.md b/docs/api/_report.md index 75faae138..dc98e3a63 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -194,12 +194,14 @@ Items that are intentionally undocumented are not included in this section. - `client_session` - `connect_webview` - `connected_account` +- `device` - `device_provider` - `event` - `network` - `noise_threshold` - `unmanaged_access_code` - `unmanaged_acs_access_group` +- `unmanaged_device` - `webhook` - `workspace` @@ -271,6 +273,18 @@ Items that are intentionally undocumented are not included in this section. - `connected_account.errors` - `connected_account.user_identifier` - `connected_account.warnings` +- `device.can_hvac_cool` +- `device.can_hvac_heat` +- `device.can_hvac_heat_cool` +- `device.can_program_offline_access_codes` +- `device.can_program_online_access_codes` +- `device.can_remotely_lock` +- `device.can_remotely_unlock` +- `device.can_simulate_connection` +- `device.can_simulate_disconnection` +- `device.can_simulate_removal` +- `device.can_turn_off_hvac` +- `device.custom_metadata` - `device_provider.can_hvac_cool` - `device_provider.can_hvac_heat` - `device_provider.can_hvac_heat_cool` @@ -312,6 +326,19 @@ Items that are intentionally undocumented are not included in this section. - `unmanaged_acs_user.is_managed` - `unmanaged_acs_user.latest_desired_state_synced_with_provider_at` - `unmanaged_acs_user.pending_modifications` +- `unmanaged_device.can_hvac_cool` +- `unmanaged_device.can_hvac_heat` +- `unmanaged_device.can_hvac_heat_cool` +- `unmanaged_device.can_program_offline_access_codes` +- `unmanaged_device.can_program_online_access_codes` +- `unmanaged_device.can_remotely_lock` +- `unmanaged_device.can_remotely_unlock` +- `unmanaged_device.can_simulate_connection` +- `unmanaged_device.can_simulate_disconnection` +- `unmanaged_device.can_simulate_removal` +- `unmanaged_device.can_turn_off_hvac` +- `unmanaged_device.is_managed` +- `unmanaged_device.properties` - `user_identity.display_name` - `user_identity.full_name` - `webhook.event_types` diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index af1e25bfe..c2666512d 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -236,6 +236,7 @@ ID of the ACS user to whom the new credential belongs. ### `allowed_acs_entrance_ids` Type: `array` +Item format: `id` Required: No Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 5705eee18..b827a37e6 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -17,6 +17,7 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/worki ### `acs_encoder_ids` Type: `array` +Item format: `id` Required: No IDs of the `acs_encoder`s that you want to retrieve. @@ -35,6 +36,7 @@ ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. ### `acs_system_ids` Type: `array` +Item format: `id` Required: No IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6cd85a7bf..645e2a735 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -252,8 +252,12 @@ Required: Yes ### `include_if` Type: `array` +Item format: `enum` Required: No +Possible enum values: +- `[object Object]` + *** diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 6137a24e7..377ce55e9 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -218,6 +218,7 @@ Required: No ### `acs_access_group_ids` Type: `array` +Item format: `id` Required: No Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index f0adedbe6..64581fa2f 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -249,6 +249,7 @@ ID of the connected account by which to filter. ### `connected_account_ids` Type: `array` +Item format: `id` Required: No Array of IDs of the connected accounts by which to filter devices. @@ -276,6 +277,7 @@ Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-met ### `device_ids` Type: `array` +Item format: `id` Required: No Array of device IDs by which to filter devices. @@ -294,8 +296,46 @@ Device type by which to filter devices. ### `device_types` Type: `array` +Item format: `enum` Required: No +Possible enum values: +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` +- `[object Object]` + Array of device types by which to filter devices. *** From 192818d1fcc21792866bb5f36aaa6852914a9f7d Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:32:48 +0200 Subject: [PATCH 128/233] Normalize item format, fix enum values --- src/lib/layout/api-endpoint.ts | 8 ++++---- src/lib/layout/api-route.ts | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index defdc40f1..523a82c5c 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -2,7 +2,6 @@ import type { ActionAttempt, CodeSampleSdk, Endpoint, - EnumProperty, SeamAuthMethod, SeamWorkspaceScope, } from '@seamapi/blueprint' @@ -11,6 +10,7 @@ import type { CodeSample } from 'node_modules/@seamapi/blueprint/dist/index.cjs' import { type ApiRouteResource, mapBlueprintPropertyToRouteProperty, + normalizePropertyFormatForDocs, } from './api-route.js' const supportedSdks: CodeSampleSdk[] = [ @@ -36,7 +36,7 @@ export interface ApiEndpointLayoutContext { description: string jsonType: string itemFormat?: string - itemEnumValues?: EnumProperty['values'] + itemEnumValues?: string[] }> } response: { @@ -110,9 +110,9 @@ export function setEndpointLayoutContext( description: param.description, jsonType: param.jsonType, ...(param.jsonType === 'array' && { - itemFormat: param.itemFormat, + itemFormat: normalizePropertyFormatForDocs(param.itemFormat), ...(param.itemFormat === 'enum' && { - itemEnumValues: param.itemEnumValues, + itemEnumValues: param.itemEnumValues.map(({ name }) => name), }), }), })) diff --git a/src/lib/layout/api-route.ts b/src/lib/layout/api-route.ts index d3249a699..71c0b75ca 100644 --- a/src/lib/layout/api-route.ts +++ b/src/lib/layout/api-route.ts @@ -250,7 +250,7 @@ export const mapBlueprintPropertyToRouteProperty = ( type PropertyFormat = Property['format'] | ListProperty['itemFormat'] type ListProperty = Extract -const normalizePropertyFormatForDocs = (format: PropertyFormat): string => { +export const normalizePropertyFormatForDocs = (format: PropertyFormat): string => { const formatMap: Partial> = { id: 'UUID', discriminated_object: 'Object', From ba841b552e513e294d5404124bbcf1f9d4022d87 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 13:33:54 +0000 Subject: [PATCH 129/233] ci: Format code --- src/lib/layout/api-route.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/lib/layout/api-route.ts b/src/lib/layout/api-route.ts index 71c0b75ca..799e80a5a 100644 --- a/src/lib/layout/api-route.ts +++ b/src/lib/layout/api-route.ts @@ -250,7 +250,9 @@ export const mapBlueprintPropertyToRouteProperty = ( type PropertyFormat = Property['format'] | ListProperty['itemFormat'] type ListProperty = Extract -export const normalizePropertyFormatForDocs = (format: PropertyFormat): string => { +export const normalizePropertyFormatForDocs = ( + format: PropertyFormat, +): string => { const formatMap: Partial> = { id: 'UUID', discriminated_object: 'Object', From 8b135cfa3eb6b2739164954471409de85c67c2d6 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 13:34:58 +0000 Subject: [PATCH 130/233] ci: Generate docs --- docs/api/acs/credentials/create.md | 2 +- docs/api/acs/encoders/list.md | 4 +- .../entrances/list_credentials_with_access.md | 4 +- docs/api/acs/users/create.md | 2 +- docs/api/thermostats/list.md | 76 +++++++++---------- 5 files changed, 44 insertions(+), 44 deletions(-) diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index c2666512d..067bc8d2c 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -236,7 +236,7 @@ ID of the ACS user to whom the new credential belongs. ### `allowed_acs_entrance_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index b827a37e6..fa027033b 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -17,7 +17,7 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/worki ### `acs_encoder_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No IDs of the `acs_encoder`s that you want to retrieve. @@ -36,7 +36,7 @@ ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. ### `acs_system_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 645e2a735..7e8107d4e 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -252,11 +252,11 @@ Required: Yes ### `include_if` Type: `array` -Item format: `enum` +Item format: `Enum` Required: No Possible enum values: -- `[object Object]` +- `visionline_metadata.is_valid` diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 377ce55e9..2b7d017b4 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -218,7 +218,7 @@ Required: No ### `acs_access_group_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 64581fa2f..0c7a772f2 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -249,7 +249,7 @@ ID of the connected account by which to filter. ### `connected_account_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No Array of IDs of the connected accounts by which to filter devices. @@ -277,7 +277,7 @@ Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-met ### `device_ids` Type: `array` -Item format: `id` +Item format: `UUID` Required: No Array of device IDs by which to filter devices. @@ -296,45 +296,45 @@ Device type by which to filter devices. ### `device_types` Type: `array` -Item format: `enum` +Item format: `Enum` Required: No Possible enum values: -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` -- `[object Object]` +- `akuvox_lock` +- `august_lock` +- `brivo_access_point` +- `butterflymx_panel` +- `avigilon_alta_entry` +- `doorking_lock` +- `genie_door` +- `igloo_lock` +- `linear_lock` +- `lockly_lock` +- `kwikset_lock` +- `nuki_lock` +- `salto_lock` +- `schlage_lock` +- `seam_relay` +- `smartthings_lock` +- `wyze_lock` +- `yale_lock` +- `two_n_intercom` +- `controlbyweb_device` +- `ttlock_lock` +- `igloohome_lock` +- `hubitat_lock` +- `four_suites_door` +- `dormakaba_oracode_door` +- `tedee_lock` +- `akiles_lock` +- `noiseaware_activity_zone` +- `minut_sensor` +- `ecobee_thermostat` +- `nest_thermostat` +- `honeywell_resideo_thermostat` +- `tado_thermostat` +- `ios_phone` +- `android_phone` Array of device types by which to filter devices. From 7a04ff4df738783632cd6176933c295ef6d2e40f Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:42:28 +0200 Subject: [PATCH 131/233] Use enum partial --- src/layouts/partials/api-resource.hbs | 5 +---- src/layouts/partials/enum-values.hbs | 4 ++-- src/layouts/partials/property-content.hbs | 5 +---- src/layouts/partials/property-nested-internal.hbs | 5 +---- 4 files changed, 5 insertions(+), 14 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 6f432d754..b0095f73a 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -30,10 +30,7 @@ Item format: `{{listItemFormat}}` {{/if}} {{#if enumValues}} -Possible enum values: -{{#each enumValues}} -- `{{this}}` -{{/each}} +{{> enum-values}} {{/if}} {{#unless (eq objectProperties undefined)}} {{#if (eq objectProperties.length 0)}} diff --git a/src/layouts/partials/enum-values.hbs b/src/layouts/partials/enum-values.hbs index b5df183d8..b055f3682 100644 --- a/src/layouts/partials/enum-values.hbs +++ b/src/layouts/partials/enum-values.hbs @@ -1,4 +1,4 @@ -Possible enum values: +{{#if indentationOffset}}{{indentationOffset}}{{/if}}Possible enum values: {{#each enumValues}} -- `{{this}}` +{{#if ../indentationOffset}}{{../indentationOffset}}{{/if}}- `{{this}}` {{/each}} \ No newline at end of file diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs index 07866a381..d5b650ff5 100644 --- a/src/layouts/partials/property-content.hbs +++ b/src/layouts/partials/property-content.hbs @@ -8,10 +8,7 @@ {{/if}} {{#if enumValues}} -Possible enum values: -{{#each enumValues}} -- `{{this}}` -{{/each}} +{{> enum-values}} {{/if}} {{#if listProperties}} {{#each listProperties}} diff --git a/src/layouts/partials/property-nested-internal.hbs b/src/layouts/partials/property-nested-internal.hbs index 4b59f0076..16d7c4c42 100644 --- a/src/layouts/partials/property-nested-internal.hbs +++ b/src/layouts/partials/property-nested-internal.hbs @@ -8,8 +8,5 @@ {{/if}} {{#if enumValues}} - Possible enum values: -{{#each enumValues}} - - `{{this}}` -{{/each}} +{{> enum-values indentationOffset=" "}} {{/if}} \ No newline at end of file From 03f1377a4f7c983bf0bcfb9f99ece356fe72cf73 Mon Sep 17 00:00:00 2001 From: Andrii Balitskyi <10balian10@gmail.com> Date: Mon, 31 Mar 2025 15:46:04 +0200 Subject: [PATCH 132/233] Put desctiption before possible enum values --- src/layouts/api-endpoint.hbs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 3d71edc58..70d7556bc 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -32,13 +32,15 @@ Type: `{{this.jsonType}}` Item format: `{{this.itemFormat}}` {{/if}} Required: {{#if this.required}}Yes{{else}}No{{/if}} +{{#if this.description}} + +{{this.description}} +{{/if}} {{#if this.itemEnumValues}} {{> enum-values enumValues=this.itemEnumValues}} {{/if}} -{{this.description}} - *** {{/each}} From 581af96cc3db3ba838b2f075f3dbeefa74e8df30 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 13:47:12 +0000 Subject: [PATCH 133/233] ci: Generate docs --- .../acs/encoders/simulate/next_credential_scan_will_fail.md | 4 ---- docs/api/acs/entrances/get.md | 2 -- docs/api/acs/entrances/grant_access.md | 4 ---- docs/api/acs/entrances/list.md | 4 ---- docs/api/acs/entrances/list_credentials_with_access.md | 4 ---- docs/api/acs/users/create.md | 2 -- docs/api/acs/users/list.md | 2 -- docs/api/acs/users/update.md | 4 ---- docs/api/thermostats/list.md | 4 ++-- docs/api/thermostats/set_fan_mode.md | 4 ---- docs/api/thermostats/set_hvac_mode.md | 2 -- docs/api/user_identities/get.md | 2 -- docs/api/user_identities/list.md | 2 -- docs/api/user_identities/update.md | 2 -- 14 files changed, 2 insertions(+), 40 deletions(-) diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 8a3333506..4946e8824 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -28,8 +28,6 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next Type: `string` Required: No - - *** ### `error_code` @@ -37,8 +35,6 @@ Required: No Type: `string` Required: No - - *** ## Return Type diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index b4bbbbdf4..9380e50c6 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -148,8 +148,6 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance Type: `string` Required: Yes - - *** ## Return Type diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 8ea04aa67..5847cfc2f 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -19,8 +19,6 @@ POST /acs/entrances/grant_access ⇒ void Type: `string` Required: Yes - - *** ### `acs_user_id` @@ -28,8 +26,6 @@ Required: Yes Type: `string` Required: Yes - - *** ## Return Type diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index acf540d23..083fb93bd 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -148,8 +148,6 @@ func main() { Type: `string` Required: No - - *** ### `acs_system_id` @@ -157,8 +155,6 @@ Required: No Type: `string` Required: No - - *** ## Return Type diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 7e8107d4e..bfa174069 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -245,8 +245,6 @@ func main() { Type: `string` Required: Yes - - *** ### `include_if` @@ -258,8 +256,6 @@ Required: No Possible enum values: - `visionline_metadata.is_valid` - - *** ## Return Type diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 2b7d017b4..0459ac6c4 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -230,8 +230,6 @@ Array of `access_group_id`s to indicate the access groups to which to add the ne Type: `string` Required: No - - *** ### `email_address` diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index b23c5a49e..d0465e7d1 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -167,8 +167,6 @@ ID of the `acs_system` for which you want to retrieve all `acs_user`s. Type: `string` Required: No - - *** ### `limit` diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index dccb7c8af..c4a2ef58d 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -149,8 +149,6 @@ Required: No Type: `string` Required: No - - *** ### `email_address` @@ -176,8 +174,6 @@ Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access Type: `string` Required: No - - *** ### `phone_number` diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 0c7a772f2..abcd7414e 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -299,6 +299,8 @@ Type: `array` Item format: `Enum` Required: No +Array of device types by which to filter devices. + Possible enum values: - `akuvox_lock` - `august_lock` @@ -336,8 +338,6 @@ Possible enum values: - `ios_phone` - `android_phone` -Array of device types by which to filter devices. - *** ### `limit` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 5ceb92167..8e4f44cc3 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -152,8 +152,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu Type: `string` Required: Yes - - *** ### `fan_mode` @@ -161,8 +159,6 @@ Required: Yes Type: `string` Required: No - - *** ### `fan_mode_setting` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index f1e05acfd..9dc658f9c 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -172,8 +172,6 @@ ID of the desired thermostat device. Type: `string` Required: Yes - - *** ### `cooling_set_point_celsius` diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index a76dbf454..9530bc553 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -177,8 +177,6 @@ ID of the desired user identity. Type: `string` Required: No - - *** ## Return Type diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 7044c7aaa..1cd65237f 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -168,8 +168,6 @@ func main() { Type: `string` Required: No - - *** ## Return Type diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index d5deb5c99..fb4085307 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -37,8 +37,6 @@ Unique email address for the user identity. Type: `string` Required: No - - *** ### `phone_number` From 3b268b9bd622d2440f5b8f32ec7b004b8041ec28 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 21:32:55 +0000 Subject: [PATCH 134/233] ci: Generate docs --- .../next_credential_scan_will_fail.md | 5 +- docs/api/acs/entrances/get.md | 3 +- docs/api/acs/entrances/grant_access.md | 5 +- docs/api/acs/entrances/list.md | 5 +- .../entrances/list_credentials_with_access.md | 5 +- docs/api/acs/users/create.md | 409 +++++++++++++++++- docs/api/acs/users/list.md | 2 +- docs/api/acs/users/update.md | 4 +- docs/api/thermostats/list.md | 2 +- docs/api/thermostats/set_fan_mode.md | 4 +- docs/api/thermostats/set_hvac_mode.md | 2 +- docs/api/user_identities/get.md | 3 +- docs/api/user_identities/list.md | 3 +- docs/api/user_identities/update.md | 2 +- 14 files changed, 415 insertions(+), 39 deletions(-) diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index e5aa04549..c1029de34 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -34,14 +34,15 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next Type: `string` Required: No -*** +--- ### `error_code` Type: `string` Required: No -*** +--- + ## Return Type diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index f9fb4a3bf..dea604ca0 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -154,7 +154,8 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance Type: `string` Required: Yes -*** +--- + ## Return Type diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 6366129cc..cf513acb3 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -25,14 +25,15 @@ POST /acs/entrances/grant_access ⇒ void Type: `string` Required: Yes -*** +--- ### `acs_user_id` Type: `string` Required: Yes -*** +--- + ## Return Type diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 306e003c1..a95de75be 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -154,14 +154,15 @@ func main() { Type: `string` Required: No -*** +--- ### `acs_system_id` Type: `string` Required: No -*** +--- + ## Return Type diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 53776fedf..ea1783d67 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -251,7 +251,7 @@ func main() { Type: `string` Required: Yes -*** +--- ### `include_if` @@ -262,7 +262,8 @@ Required: No Possible enum values: - `visionline_metadata.is_valid` -*** +--- + ## Return Type diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 26352db40..e3d10f32a 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -12,7 +12,7 @@ Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-sy {% tabs %} {% tab title="JavaScript" %} -#### Request +#### Code ```javascript await seam.acs.users.create({ @@ -20,7 +20,6 @@ await seam.acs.users.create({ full_name: "Jane Doe", email_address: "jane@example.com", phone_number: "+15555550100", - acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], }); ``` @@ -49,7 +48,6 @@ seam.acs.users.create( full_name="Jane Doe", email_address="jane@example.com", phone_number="+15555550100", - acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"], ) ``` @@ -78,7 +76,6 @@ seam.acs.users.create( full_name: "Jane Doe", email_address: "jane@example.com", phone_number: "+15555550100", - acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], ) ``` @@ -107,8 +104,7 @@ $seam->acs->users->create( acs_system_id: "123e4567-e89b-12d3-a456-426614174000", full_name: "Jane Doe", email_address: "jane@example.com", - phone_number: "+15555550100", - acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"] + phone_number: "+15555550100" ); ``` @@ -133,7 +129,7 @@ $seam->acs->users->create( #### Code ```seam_cli -seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"] +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" ``` #### Output @@ -165,11 +161,10 @@ func main() { client.Acs.Users.Create( context.Background(), users.UsersCreateRequest{ - AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FullName: api.String("Jane Doe"), - EmailAddress: api.String("jane@example.com"), - PhoneNumber: api.String("+15555550100"), - AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")}, + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), }, ) } @@ -190,6 +185,8 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 - Personal access token
Must also include the `seam-workspace` header in the request. +--- + ## Request Parameters ### `acs_system_id` @@ -199,7 +196,7 @@ Required: Yes ID of the `acs_system` to which to add the new `acs_user`. -*** +--- ### `full_name` @@ -208,7 +205,7 @@ Required: Yes Full name of the new `acs_user`. -*** +--- ### `access_schedule` @@ -217,7 +214,7 @@ Required: No `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. -*** +--- ### `acs_access_group_ids` @@ -227,14 +224,14 @@ Required: No Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. -*** +--- ### `email` Type: `string` Required: No -*** +--- ### `email_address` @@ -243,7 +240,7 @@ Required: No Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -*** +--- ### `phone_number` @@ -252,7 +249,7 @@ Required: No Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). -*** +--- ### `user_identity_id` @@ -261,8 +258,380 @@ Required: No ID of the user identity with which to associate the new `acs_user`. -*** +--- + ## Return Type [acs\_user](./) + +--- + +## Code Samples + +### Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +}); +``` + +#### Output + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", + access_schedule={ + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Output + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: { + starts_at: "2024-11-01T15:00:00.000Z", + ends_at: "2024-11-04T11:00:00.000Z", + }, +) +``` + +#### Output + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + access_schedule: [ + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-04T11:00:00.000Z", + ] +); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --access_schedule {"starts_at":"2024-11-01T15:00:00.000Z","ends_at":"2024-11-04T11:00:00.000Z"} +``` + +#### Output + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + AccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String("2024-11-01T15:00:00.000Z"), EndsAt: api.String("2024-11-04T11:00:00.000Z")}, + }, + ) +} +``` + +#### Output + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} +### Create a new ACS user in an access group + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and assigns the new user to an [access group](../../../capability-guides/access-systems/user-management/assigning-users-to-access-groups.md). + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.create({ + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], +}); +``` + +#### Output + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.create( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", + acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"], +) +``` + +#### Output + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"], +) +``` + +#### Output + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->create( + acs_system_id: "123e4567-e89b-12d3-a456-426614174000", + full_name: "Jane Doe", + email_address: "jane@example.com", + phone_number: "+15555550100", + acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"] +); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --phone_number "+15555550100" --acs_access_group_ids ["123e4567-e89b-12d3-a456-426614174000"] +``` + +#### Output + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Create( + context.Background(), + users.UsersCreateRequest{ + AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FullName: api.String("Jane Doe"), + EmailAddress: api.String("jane@example.com"), + PhoneNumber: api.String("+15555550100"), + AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")}, + }, + ) +} +``` + +#### Output + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 9e7b00e6c..4685f4fbb 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -173,7 +173,7 @@ ID of the `acs_system` for which you want to retrieve all `acs_user`s. Type: `string` Required: No -*** +--- ### `limit` diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 5b9bbc1d9..d4e5ed6e6 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -155,7 +155,7 @@ Required: No Type: `string` Required: No -*** +--- ### `email_address` @@ -180,7 +180,7 @@ Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access Type: `string` Required: No -*** +--- ### `phone_number` diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 8605939d6..60c7c5167 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -344,7 +344,7 @@ Possible enum values: - `ios_phone` - `android_phone` -*** +--- ### `limit` diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index d3cf834a7..ed3b3520a 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -158,14 +158,14 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu Type: `string` Required: Yes -*** +--- ### `fan_mode` Type: `string` Required: No -*** +--- ### `fan_mode_setting` diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 27b92fdcc..ba238a3f1 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -178,7 +178,7 @@ ID of the desired thermostat device. Type: `string` Required: Yes -*** +--- ### `cooling_set_point_celsius` diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 8c1fafb0b..14c494f13 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -183,7 +183,8 @@ ID of the desired user identity. Type: `string` Required: No -*** +--- + ## Return Type diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index d272a3a23..6ebafb252 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -174,7 +174,8 @@ func main() { Type: `string` Required: No -*** +--- + ## Return Type diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 5b1ce667d..afae2ac5b 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -43,7 +43,7 @@ Unique email address for the user identity. Type: `string` Required: No -*** +--- ### `phone_number` From 3dd8a744deb36609f913e3619033770a3dd69411 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 31 Mar 2025 17:44:35 -0400 Subject: [PATCH 135/233] Update property-nested.hbs --- src/layouts/partials/property-nested.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs index c9f0e4479..a65034566 100644 --- a/src/layouts/partials/property-nested.hbs +++ b/src/layouts/partials/property-nested.hbs @@ -1,4 +1,4 @@ -{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} +{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{> property-nested-internal}} {{#if listProperties}} {{#each listProperties}} From fa0a7eead2b3ed419c42bdef08e629cb9c15f391 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 21:45:46 +0000 Subject: [PATCH 136/233] ci: Generate docs --- docs/api/access_codes/README.md | 280 +++++++++--------- docs/api/acs/access_groups/README.md | 22 +- docs/api/acs/credentials/README.md | 78 ++--- docs/api/acs/encoders/README.md | 38 +-- docs/api/acs/entrances/README.md | 88 +++--- docs/api/acs/systems/README.md | 50 ++-- docs/api/acs/users/README.md | 20 +- docs/api/phones/README.md | 34 +-- docs/api/thermostats/schedules/README.md | 4 +- .../enrollment_automations/README.md | 12 +- 10 files changed, 313 insertions(+), 313 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 7624bfc56..b376233ca 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -493,47 +493,47 @@ 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 String +- event_type String -- 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). @@ -550,47 +550,47 @@ 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 String +- event_type String -- 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). @@ -607,53 +607,53 @@ 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 String +- event_type String -- 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). @@ -670,53 +670,53 @@ 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 String +- event_type String -- 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). @@ -733,47 +733,47 @@ 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 String +- event_type String -- 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). @@ -790,47 +790,47 @@ 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 String +- event_type String -- 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). @@ -847,47 +847,47 @@ 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 String +- event_type String -- 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). @@ -904,53 +904,53 @@ 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 String +- event_type String -- 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). @@ -967,47 +967,47 @@ 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 String +- event_type String -- 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). @@ -1024,47 +1024,47 @@ 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 String +- event_type String -- 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). @@ -1081,47 +1081,47 @@ 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 String +- event_type String -- 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). @@ -1138,47 +1138,47 @@ 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 String +- event_type String -- 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). @@ -1195,51 +1195,51 @@ 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 String +- event_type String -- 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). @@ -1256,47 +1256,47 @@ 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 String +- event_type String -- 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). @@ -1313,47 +1313,47 @@ 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 String +- event_type String -- 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). @@ -1370,47 +1370,47 @@ 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 String +- event_type String -- 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). @@ -1427,47 +1427,47 @@ 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 String +- event_type String -- 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 a560caec7..77a8b918a 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -116,19 +116,19 @@ Warnings associated with the `acs_access_group`. Child Object Properties -- created_at Datetime +- created_at Datetime Date and time at which Seam created the warning. -- message String +- message String Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. -- warning_code String +- warning_code String Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -156,45 +156,45 @@ 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 String +- event_type String -- 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 fe87f8206..a1b0f6add 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -64,23 +64,23 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- Child Properties -- door_names List of Strings +- door_names List of Strings -- endpoint_id String +- endpoint_id String -- key_id String +- key_id String -- key_issuing_request_id String +- key_issuing_request_id String -- override_guest_acs_entrance_ids List of Strings +- override_guest_acs_entrance_ids List of Strings
@@ -131,11 +131,11 @@ Errors associated with the [credential](../../../capability-guides/access-system Child Object Properties -- error_code String +- error_code String -- message String +- message String
@@ -239,11 +239,11 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc Child Properties -- auto_join Boolean +- auto_join Boolean -- card_function_type Enum +- card_function_type Enum
@@ -256,27 +256,27 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc -- card_id String +- card_id String -- common_acs_entrance_ids List of UUIDs +- common_acs_entrance_ids List of UUIDs -- credential_id String +- credential_id String -- guest_acs_entrance_ids List of UUIDs +- guest_acs_entrance_ids List of UUIDs -- is_valid Boolean +- is_valid Boolean -- joiner_acs_credential_ids List of UUIDs +- joiner_acs_credential_ids List of UUIDs
@@ -348,45 +348,45 @@ 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 String +- event_type String -- 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). @@ -403,45 +403,45 @@ 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 String +- event_type String -- 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). @@ -458,45 +458,45 @@ 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 String +- event_type String -- 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 da5f3b60e..97d562913 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -59,19 +59,19 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w Child Object Properties -- created_at Datetime +- created_at Datetime Date and time at which Seam created the error. -- error_code String +- error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -- message String +- message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -99,47 +99,47 @@ 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 String +- event_type String -- 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). @@ -156,47 +156,47 @@ 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 String +- event_type String -- 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 59324f772..6ba69825a 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -34,15 +34,15 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa Child Properties -- door_name String +- door_name String -- door_number Number +- door_number Number -- door_type Enum +- door_type Enum
@@ -57,11 +57,11 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa -- pms_id String +- pms_id String -- stand_open Boolean +- stand_open Boolean
@@ -91,7 +91,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca Child Properties -- access_point_name String +- access_point_name String
@@ -107,13 +107,13 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/ Child Object Properties -- error_code String +- error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -- message String +- message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -131,19 +131,19 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide Child Properties -- accessibility_type String +- accessibility_type String -- door_name String +- door_name String -- door_type String +- door_type String -- is_connected Boolean +- is_connected Boolean
@@ -159,35 +159,35 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu Child Properties -- battery_level String +- battery_level String -- door_name String +- door_name String -- intrusion_alarm Boolean +- intrusion_alarm Boolean -- left_open_alarm Boolean +- left_open_alarm Boolean -- lock_type String +- lock_type String -- locked_state String +- locked_state String -- online Boolean +- online Boolean -- privacy_mode Boolean +- privacy_mode Boolean
@@ -203,15 +203,15 @@ Salto Space-specific metadata associated with the [entrance](../../../capability Child Properties -- door_description String +- door_description String -- door_name String +- door_name String -- ext_door_id String +- ext_door_id String
@@ -227,7 +227,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability- Child Properties -- door_category Enum +- door_category Enum
@@ -243,18 +243,18 @@ Visionline-specific metadata associated with the [entrance](../../../capability- -- door_name String +- door_name String -- profiles List of Objects +- profiles List of Objects -- visionline_door_profile_id String +- visionline_door_profile_id String -- visionline_door_profile_type Enum +- visionline_door_profile_type Enum
@@ -284,45 +284,45 @@ 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 String +- event_type String -- 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). @@ -339,45 +339,45 @@ 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 String +- event_type String -- 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 ffc582cad..c437aee95 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -148,7 +148,7 @@ Indicates whether the `acs_system` is a credential manager. Child Properties -- time_zone String +- time_zone String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. @@ -208,19 +208,19 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide Child Properties -- lan_address String +- lan_address String IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network. -- mobile_access_uuid String +- mobile_access_uuid String Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. -- system_id String +- system_id String Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. @@ -313,41 +313,41 @@ 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 String +- event_type String -- 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). @@ -364,41 +364,41 @@ 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 String +- event_type String -- 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). @@ -415,41 +415,41 @@ 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 String +- event_type String -- 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 18d757a17..783c7be24 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -22,13 +22,13 @@ For details about how to configure `acs_user`s in your access control system, se Child Properties -- ends_at Datetime +- ends_at Datetime 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. -- starts_at Datetime +- starts_at Datetime Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. @@ -254,45 +254,45 @@ 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 String +- event_type String -- 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 c33b9a4b4..82957056f 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -61,11 +61,11 @@ Errors associated with the `phone`. Child Object Properties -- error_code String +- error_code String -- message String +- message String
@@ -88,43 +88,43 @@ Properties of the phone. Child Properties -- assa_abloy_credential_service_metadata Object +- assa_abloy_credential_service_metadata Object ASSA ABLOY Credential Service metadata for the phone. -- assa_abloy_credential_service_metadata.endpoints List of Objects +- assa_abloy_credential_service_metadata.endpoints List of Objects Endpoints associated with the phone. -- endpoint_id String +- endpoint_id String ID of the associated endpoint. -- is_active Boolean +- is_active Boolean Indicated whether the endpoint is active. -- assa_abloy_credential_service_metadata.has_active_endpoint Boolean +- assa_abloy_credential_service_metadata.has_active_endpoint Boolean Indicates whether the credential service has active endpoints associated with the phone. -- salto_space_credential_service_metadata Object +- salto_space_credential_service_metadata Object Salto Space credential service metadata for the phone. -- salto_space_credential_service_metadata.has_active_phone Boolean +- salto_space_credential_service_metadata.has_active_phone Boolean Indicates whether the credential service has an active associated phone. @@ -142,11 +142,11 @@ Warnings associated with the `phone`. Child Object Properties -- message String +- message String -- warning_code String +- warning_code String
@@ -172,35 +172,35 @@ 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 String +- event_type String -- 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/schedules/README.md b/docs/api/thermostats/schedules/README.md index 7849aa3ce..b077aa805 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -46,13 +46,13 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther Child Object Properties -- error_code String +- error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -- message String +- message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index a32cade26..16030d733 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -56,35 +56,35 @@ 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 String +- event_type String -- 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). From 5ad653079aa02580b6155d330e688d94ff10292e Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 31 Mar 2025 18:00:56 -0400 Subject: [PATCH 137/233] Update property-nested.hbs --- src/layouts/partials/property-nested.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/property-nested.hbs b/src/layouts/partials/property-nested.hbs index a65034566..7b4fc98e0 100644 --- a/src/layouts/partials/property-nested.hbs +++ b/src/layouts/partials/property-nested.hbs @@ -1,4 +1,4 @@ -{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} +{{name}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{> property-nested-internal}} {{#if listProperties}} {{#each listProperties}} From 9f85fbf0b6a5b22fa9c4aab44daacd7f4b890e84 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 31 Mar 2025 22:01:54 +0000 Subject: [PATCH 138/233] ci: Generate docs --- docs/api/access_codes/README.md | 280 +++++++++--------- docs/api/acs/access_groups/README.md | 22 +- docs/api/acs/credentials/README.md | 78 ++--- docs/api/acs/encoders/README.md | 38 +-- docs/api/acs/entrances/README.md | 88 +++--- docs/api/acs/systems/README.md | 50 ++-- docs/api/acs/users/README.md | 20 +- docs/api/phones/README.md | 34 +-- docs/api/thermostats/schedules/README.md | 4 +- .../enrollment_automations/README.md | 12 +- 10 files changed, 313 insertions(+), 313 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index b376233ca..606f4c1d1 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -493,47 +493,47 @@ 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 String +- event_type String -- 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). @@ -550,47 +550,47 @@ 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 String +- event_type String -- 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). @@ -607,53 +607,53 @@ 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 String +- event_type String -- 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). @@ -670,53 +670,53 @@ 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 String +- event_type String -- 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). @@ -733,47 +733,47 @@ 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 String +- event_type String -- 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). @@ -790,47 +790,47 @@ 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 String +- event_type String -- 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). @@ -847,47 +847,47 @@ 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 String +- event_type String -- 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). @@ -904,53 +904,53 @@ 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 String +- event_type String -- 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). @@ -967,47 +967,47 @@ 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 String +- event_type String -- 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). @@ -1024,47 +1024,47 @@ 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 String +- event_type String -- 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). @@ -1081,47 +1081,47 @@ 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 String +- event_type String -- 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). @@ -1138,47 +1138,47 @@ 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 String +- event_type String -- 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). @@ -1195,51 +1195,51 @@ 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 String +- event_type String -- 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). @@ -1256,47 +1256,47 @@ 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 String +- event_type String -- 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). @@ -1313,47 +1313,47 @@ 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 String +- event_type String -- 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). @@ -1370,47 +1370,47 @@ 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 String +- event_type String -- 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). @@ -1427,47 +1427,47 @@ 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 String +- event_type String -- 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 77a8b918a..98100322b 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -116,19 +116,19 @@ Warnings associated with the `acs_access_group`. Child Object Properties -- created_at Datetime +- created_at Datetime Date and time at which Seam created the warning. -- message String +- message String Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. -- warning_code String +- warning_code String Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. @@ -156,45 +156,45 @@ 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 String +- event_type String -- 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 a1b0f6add..e1541884f 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -64,23 +64,23 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- Child Properties -- door_names List of Strings +- door_names List of Strings -- endpoint_id String +- endpoint_id String -- key_id String +- key_id String -- key_issuing_request_id String +- key_issuing_request_id String -- override_guest_acs_entrance_ids List of Strings +- override_guest_acs_entrance_ids List of Strings
@@ -131,11 +131,11 @@ Errors associated with the [credential](../../../capability-guides/access-system Child Object Properties -- error_code String +- error_code String -- message String +- message String
@@ -239,11 +239,11 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc Child Properties -- auto_join Boolean +- auto_join Boolean -- card_function_type Enum +- card_function_type Enum
@@ -256,27 +256,27 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc -- card_id String +- card_id String -- common_acs_entrance_ids List of UUIDs +- common_acs_entrance_ids List of UUIDs -- credential_id String +- credential_id String -- guest_acs_entrance_ids List of UUIDs +- guest_acs_entrance_ids List of UUIDs -- is_valid Boolean +- is_valid Boolean -- joiner_acs_credential_ids List of UUIDs +- joiner_acs_credential_ids List of UUIDs
@@ -348,45 +348,45 @@ 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 String +- event_type String -- 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). @@ -403,45 +403,45 @@ 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 String +- event_type String -- 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). @@ -458,45 +458,45 @@ 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 String +- event_type String -- 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 97d562913..8c744092a 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -59,19 +59,19 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w Child Object Properties -- created_at Datetime +- created_at Datetime Date and time at which Seam created the error. -- error_code String +- error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -- message String +- message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -99,47 +99,47 @@ 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 String +- event_type String -- 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). @@ -156,47 +156,47 @@ 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 String +- event_type String -- 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 6ba69825a..b862c7c30 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -34,15 +34,15 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa Child Properties -- door_name String +- door_name String -- door_number Number +- door_number Number -- door_type Enum +- door_type Enum
@@ -57,11 +57,11 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa -- pms_id String +- pms_id String -- stand_open Boolean +- stand_open Boolean
@@ -91,7 +91,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca Child Properties -- access_point_name String +- access_point_name String @@ -107,13 +107,13 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/ Child Object Properties -- error_code String +- error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -- message String +- message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. @@ -131,19 +131,19 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide Child Properties -- accessibility_type String +- accessibility_type String -- door_name String +- door_name String -- door_type String +- door_type String -- is_connected Boolean +- is_connected Boolean @@ -159,35 +159,35 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu Child Properties -- battery_level String +- battery_level String -- door_name String +- door_name String -- intrusion_alarm Boolean +- intrusion_alarm Boolean -- left_open_alarm Boolean +- left_open_alarm Boolean -- lock_type String +- lock_type String -- locked_state String +- locked_state String -- online Boolean +- online Boolean -- privacy_mode Boolean +- privacy_mode Boolean @@ -203,15 +203,15 @@ Salto Space-specific metadata associated with the [entrance](../../../capability Child Properties -- door_description String +- door_description String -- door_name String +- door_name String -- ext_door_id String +- ext_door_id String @@ -227,7 +227,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability- Child Properties -- door_category Enum +- door_category Enum
@@ -243,18 +243,18 @@ Visionline-specific metadata associated with the [entrance](../../../capability- -- door_name String +- door_name String -- profiles List of Objects +- profiles List of Objects -- visionline_door_profile_id String +- visionline_door_profile_id String -- visionline_door_profile_type Enum +- visionline_door_profile_type Enum
@@ -284,45 +284,45 @@ 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 String +- event_type String -- 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). @@ -339,45 +339,45 @@ 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 String +- event_type String -- 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 c437aee95..da9756f6e 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -148,7 +148,7 @@ Indicates whether the `acs_system` is a credential manager. Child Properties -- time_zone String +- time_zone String Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. @@ -208,19 +208,19 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide Child Properties -- lan_address String +- lan_address String IP address or hostname of the main Visionline server relative to [Seam Bridge](../../../capability-guides/seam-bridge.md) on the local network. -- mobile_access_uuid String +- mobile_access_uuid String Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. -- system_id String +- system_id String Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. @@ -313,41 +313,41 @@ 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 String +- event_type String -- 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). @@ -364,41 +364,41 @@ 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 String +- event_type String -- 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). @@ -415,41 +415,41 @@ 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 String +- event_type String -- 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 783c7be24..ee4a92520 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -22,13 +22,13 @@ For details about how to configure `acs_user`s in your access control system, se Child Properties -- ends_at Datetime +- ends_at Datetime 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. -- starts_at Datetime +- starts_at Datetime Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. @@ -254,45 +254,45 @@ 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 String +- event_type String -- 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 82957056f..91d6606aa 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -61,11 +61,11 @@ Errors associated with the `phone`. Child Object Properties -- error_code String +- error_code String -- message String +- message String
@@ -88,43 +88,43 @@ Properties of the phone. Child Properties -- assa_abloy_credential_service_metadata Object +- assa_abloy_credential_service_metadata Object ASSA ABLOY Credential Service metadata for the phone. -- assa_abloy_credential_service_metadata.endpoints List of Objects +- assa_abloy_credential_service_metadata.endpoints List of Objects Endpoints associated with the phone. -- endpoint_id String +- endpoint_id String ID of the associated endpoint. -- is_active Boolean +- is_active Boolean Indicated whether the endpoint is active. -- assa_abloy_credential_service_metadata.has_active_endpoint Boolean +- assa_abloy_credential_service_metadata.has_active_endpoint Boolean Indicates whether the credential service has active endpoints associated with the phone. -- salto_space_credential_service_metadata Object +- salto_space_credential_service_metadata Object Salto Space credential service metadata for the phone. -- salto_space_credential_service_metadata.has_active_phone Boolean +- salto_space_credential_service_metadata.has_active_phone Boolean Indicates whether the credential service has an active associated phone. @@ -142,11 +142,11 @@ Warnings associated with the `phone`. Child Object Properties -- message String +- message String -- warning_code String +- warning_code String
@@ -172,35 +172,35 @@ 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 String +- event_type String -- 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/schedules/README.md b/docs/api/thermostats/schedules/README.md index b077aa805..c4fb759eb 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -46,13 +46,13 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther Child Object Properties -- error_code String +- error_code String Unique identifier of the type of error. Enables quick recognition and categorization of the issue. -- message String +- message String Detailed description of the error. Provides insights into the issue and potentially how to rectify it. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 16030d733..c945ba568 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -56,35 +56,35 @@ 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 String +- event_type String -- 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). From 8a8e2cb2a9dab0e33a2f1752eec7d33ae04f2314 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 5 Apr 2025 22:01:29 -0400 Subject: [PATCH 139/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 739db4dd7..f45b194aa 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -8,6 +8,12 @@ {{description}} {{/if}} +```json +{{#each properties}} +{{name}}: [example value], +{{/each}} +``` + --- {{#if headingOffset}} From 26ffb827daa7ef61d03ed74298e7678751b13704 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 02:02:28 +0000 Subject: [PATCH 140/233] ci: Generate docs --- docs/api/access_codes/README.md | 24 +++++++++++++++ docs/api/acs/access_groups/README.md | 15 ++++++++++ docs/api/acs/credentials/README.md | 29 +++++++++++++++++++ docs/api/acs/encoders/README.md | 9 ++++++ docs/api/acs/encoders/encode_credential.md | 6 ++++ docs/api/acs/encoders/scan_credential.md | 6 ++++ docs/api/acs/entrances/README.md | 14 +++++++++ docs/api/acs/systems/README.md | 25 ++++++++++++++++ docs/api/acs/users/README.md | 24 +++++++++++++++ docs/api/phones/README.md | 13 +++++++++ .../thermostats/activate_climate_preset.md | 6 ++++ docs/api/thermostats/cool.md | 6 ++++ docs/api/thermostats/heat.md | 6 ++++ docs/api/thermostats/heat_cool.md | 6 ++++ docs/api/thermostats/off.md | 6 ++++ docs/api/thermostats/schedules/README.md | 12 ++++++++ docs/api/thermostats/set_fan_mode.md | 6 ++++ docs/api/thermostats/set_hvac_mode.md | 6 ++++ docs/api/user_identities/README.md | 11 +++++++ .../enrollment_automations/README.md | 8 +++++ 20 files changed, 238 insertions(+) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 606f4c1d1..dc8ef0006 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -4,6 +4,30 @@ The Access Codes route contains the following resources: ## The `access_code` Resource +```json +access_code_id: [example value], +code: [example value], +common_code_key: [example value], +created_at: [example value], +device_id: [example value], +ends_at: [example value], +errors: [example value], +is_backup: [example value], +is_backup_access_code_available: [example value], +is_external_modification_allowed: [example value], +is_managed: [example value], +is_offline_access_code: [example value], +is_one_time_use: [example value], +is_scheduled_on_device: [example value], +is_waiting_for_code_assignment: [example value], +name: [example value], +pulled_backup_access_code_id: [example value], +starts_at: [example value], +status: [example value], +type: [example value], +warnings: [example value], +``` + --- ## Properties diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 98100322b..2d732598b 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -10,6 +10,21 @@ Some access control systems use [access group](https://docs.seam.co/latest/capab To learn whether your access control system supports access groups, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +```json +access_group_type: [example value], +access_group_type_display_name: [example value], +acs_access_group_id: [example value], +acs_system_id: [example value], +created_at: [example value], +display_name: [example value], +external_type: [example value], +external_type_display_name: [example value], +is_managed: [example value], +name: [example value], +warnings: [example value], +workspace_id: [example value], +``` + --- ## Properties diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index e1541884f..1401f114b 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -10,6 +10,35 @@ An access control system generally uses digital means of access to authorize a u For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. +```json +access_method: [example value], +acs_credential_id: [example value], +acs_credential_pool_id: [example value], +acs_system_id: [example value], +acs_user_id: [example value], +assa_abloy_vostio_metadata: [example value], +card_number: [example value], +code: [example value], +created_at: [example value], +display_name: [example value], +ends_at: [example value], +errors: [example value], +external_type: [example value], +external_type_display_name: [example value], +is_issued: [example value], +is_latest_desired_state_synced_with_provider: [example value], +is_managed: [example value], +is_multi_phone_sync_credential: [example value], +is_one_time_use: [example value], +issued_at: [example value], +latest_desired_state_synced_with_provider_at: [example value], +parent_acs_credential_id: [example value], +starts_at: [example value], +visionline_metadata: [example value], +warnings: [example value], +workspace_id: [example value], +``` + --- ## Properties diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 8c744092a..d77477b52 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -19,6 +19,15 @@ Separately, the Seam API also supports card scanning, which enables you to scan To verify if your access control system requires a card encoder, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +```json +acs_encoder_id: [example value], +acs_system_id: [example value], +created_at: [example value], +display_name: [example value], +errors: [example value], +workspace_id: [example value], +``` + --- ## Properties diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 94f1c3141..1be5ee6e9 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -47,6 +47,12 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. Action attempt to track encoding credential data from the physical encoder onto a card. +```json +action_attempt_id: [example value], +action_type: [example value], +status: [example value], +``` + --- ### Properties diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index e458f4da5..c4f6e25ee 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -38,6 +38,12 @@ ID of the `acs_encoder` to use for the scan. Reading credential data from physical encoder. +```json +action_attempt_id: [example value], +action_type: [example value], +status: [example value], +``` + --- ### Properties diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index b862c7c30..54392a09b 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -8,6 +8,20 @@ Represents an [entrance](../../../capability-guides/access-systems/retrieving-en 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. +```json +acs_entrance_id: [example value], +acs_system_id: [example value], +assa_abloy_vostio_metadata: [example value], +created_at: [example value], +display_name: [example value], +dormakaba_community_metadata: [example value], +errors: [example value], +latch_metadata: [example value], +salto_ks_metadata: [example value], +salto_space_metadata: [example value], +visionline_metadata: [example value], +``` + --- ## Properties diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index da9756f6e..6cc015d56 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -10,6 +10,31 @@ Within an `acs_system`, create [`acs_user`s](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/latest/api/acs). +```json +acs_system_id: [example value], +can_add_acs_users_to_acs_access_groups: [example value], +can_automate_enrollment: [example value], +can_create_acs_access_groups: [example value], +can_remove_acs_users_from_acs_access_groups: [example value], +connected_account_id: [example value], +connected_account_ids: [example value], +created_at: [example value], +default_credential_manager_acs_system_id: [example value], +errors: [example value], +external_type: [example value], +external_type_display_name: [example value], +image_alt_text: [example value], +image_url: [example value], +is_credential_manager: [example value], +location: [example value], +name: [example value], +system_type: [example value], +system_type_display_name: [example value], +visionline_metadata: [example value], +warnings: [example value], +workspace_id: [example value], +``` + --- ## Properties diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index ee4a92520..249885e9d 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -10,6 +10,30 @@ An `acs_user` typically refers to an individual who requires access, like an emp For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +```json +access_schedule: [example value], +acs_system_id: [example value], +acs_user_id: [example value], +created_at: [example value], +display_name: [example value], +email: [example value], +email_address: [example value], +errors: [example value], +external_type: [example value], +external_type_display_name: [example value], +full_name: [example value], +hid_acs_system_id: [example value], +is_managed: [example value], +is_suspended: [example value], +phone_number: [example value], +user_identity_email_address: [example value], +user_identity_full_name: [example value], +user_identity_id: [example value], +user_identity_phone_number: [example value], +warnings: [example value], +workspace_id: [example value], +``` + --- ## Properties diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 91d6606aa..ba2a14d53 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -6,6 +6,19 @@ The Phones route contains the following resources: Represents an app user's mobile phone. +```json +created_at: [example value], +custom_metadata: [example value], +device_id: [example value], +device_type: [example value], +display_name: [example value], +errors: [example value], +nickname: [example value], +properties: [example value], +warnings: [example value], +workspace_id: [example value], +``` + --- ## Properties diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 5cc820a71..59cbabdf7 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -179,6 +179,12 @@ ID of the desired thermostat device. Activating climate preset. +```json +action_attempt_id: [example value], +action_type: [example value], +status: [example value], +``` + --- ### Properties diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 924cb22cd..1788a19fe 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -189,6 +189,12 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +```json +action_attempt_id: [example value], +action_type: [example value], +status: [example value], +``` + --- ### Properties diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index adc78f228..e4b95be49 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -189,6 +189,12 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +```json +action_attempt_id: [example value], +action_type: [example value], +status: [example value], +``` + --- ### Properties diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 93a064403..f37295dc3 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -213,6 +213,12 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +```json +action_attempt_id: [example value], +action_type: [example value], +status: [example value], +``` + --- ### Properties diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 5f9551b38..19155b36c 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -161,6 +161,12 @@ ID of the desired thermostat device. Setting HVAC mode. +```json +action_attempt_id: [example value], +action_type: [example value], +status: [example value], +``` + --- ### Properties diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index c4fb759eb..828bd4717 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -6,6 +6,18 @@ The Thermostat Schedules route contains the following resources: Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. +```json +climate_preset_key: [example value], +created_at: [example value], +device_id: [example value], +ends_at: [example value], +errors: [example value], +max_override_period_minutes: [example value], +name: [example value], +starts_at: [example value], +thermostat_schedule_id: [example value], +``` + --- ## Properties diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index ed3b3520a..a9c66fdbb 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -185,6 +185,12 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos Setting fan mode. +```json +action_attempt_id: [example value], +action_type: [example value], +status: [example value], +``` + --- ### Properties diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index ba238a3f1..2329dae75 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -225,6 +225,12 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +```json +action_attempt_id: [example value], +action_type: [example value], +status: [example value], +``` + --- ### Properties diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 06b95b7a1..a5dbbb53e 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -6,6 +6,17 @@ The User Identities route contains the following resources: Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. +```json +created_at: [example value], +display_name: [example value], +email_address: [example value], +full_name: [example value], +phone_number: [example value], +user_identity_id: [example value], +user_identity_key: [example value], +workspace_id: [example value], +``` + --- ## Properties diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index c945ba568..5c6107594 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -6,6 +6,14 @@ The Enrollment Automations route contains the following resources: Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). +```json +created_at: [example value], +credential_manager_acs_system_id: [example value], +enrollment_automation_id: [example value], +user_identity_id: [example value], +workspace_id: [example value], +``` + --- ## Properties From 1d6c153cd375d0bba4fe1c18a6debc589d47e9cb Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 5 Apr 2025 22:14:11 -0400 Subject: [PATCH 141/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index f45b194aa..5f1c97634 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -8,11 +8,18 @@ {{description}} {{/if}} +{% tabs %} +{% tab title="JSON" %} ```json +{ {{#each properties}} -{{name}}: [example value], + {{properties.indexOf(this)}} + {{name}}: [example value], {{/each}} +} ``` +{% endtab %} +{% endtabs %} --- From fcaa434994f255df7215f073cdaa84d0f81d3e08 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 5 Apr 2025 22:18:16 -0400 Subject: [PATCH 142/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 5f1c97634..c3358393b 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -13,8 +13,11 @@ ```json { {{#each properties}} - {{properties.indexOf(this)}} +{{#if @last}} + {{name}}: [example value] +{{else}} {{name}}: [example value], +{{/if}} {{/each}} } ``` From 70193e04e99e177c0d5a6f2dc49375db4c625b13 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 02:19:23 +0000 Subject: [PATCH 143/233] ci: Generate docs --- docs/api/access_codes/README.md | 48 ++++++++------- docs/api/acs/access_groups/README.md | 30 ++++++---- docs/api/acs/credentials/README.md | 58 ++++++++++--------- docs/api/acs/encoders/README.md | 18 ++++-- docs/api/acs/encoders/encode_credential.md | 12 +++- docs/api/acs/encoders/scan_credential.md | 12 +++- docs/api/acs/entrances/README.md | 28 +++++---- docs/api/acs/systems/README.md | 50 +++++++++------- docs/api/acs/users/README.md | 48 ++++++++------- docs/api/phones/README.md | 26 +++++---- .../thermostats/activate_climate_preset.md | 12 +++- docs/api/thermostats/cool.md | 12 +++- docs/api/thermostats/heat.md | 12 +++- docs/api/thermostats/heat_cool.md | 12 +++- docs/api/thermostats/off.md | 12 +++- docs/api/thermostats/schedules/README.md | 24 +++++--- docs/api/thermostats/set_fan_mode.md | 12 +++- docs/api/thermostats/set_hvac_mode.md | 12 +++- docs/api/user_identities/README.md | 22 ++++--- .../enrollment_automations/README.md | 16 +++-- 20 files changed, 298 insertions(+), 178 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index dc8ef0006..34b4ad938 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -4,29 +4,35 @@ The Access Codes route contains the following resources: ## The `access_code` Resource +{% tabs %} +{% tab title="JSON" %} ```json -access_code_id: [example value], -code: [example value], -common_code_key: [example value], -created_at: [example value], -device_id: [example value], -ends_at: [example value], -errors: [example value], -is_backup: [example value], -is_backup_access_code_available: [example value], -is_external_modification_allowed: [example value], -is_managed: [example value], -is_offline_access_code: [example value], -is_one_time_use: [example value], -is_scheduled_on_device: [example value], -is_waiting_for_code_assignment: [example value], -name: [example value], -pulled_backup_access_code_id: [example value], -starts_at: [example value], -status: [example value], -type: [example value], -warnings: [example value], +{ + access_code_id: [example value], + code: [example value], + common_code_key: [example value], + created_at: [example value], + device_id: [example value], + ends_at: [example value], + errors: [example value], + is_backup: [example value], + is_backup_access_code_available: [example value], + is_external_modification_allowed: [example value], + is_managed: [example value], + is_offline_access_code: [example value], + is_one_time_use: [example value], + is_scheduled_on_device: [example value], + is_waiting_for_code_assignment: [example value], + name: [example value], + pulled_backup_access_code_id: [example value], + starts_at: [example value], + status: [example value], + type: [example value], + warnings: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 2d732598b..3dc21555c 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -10,20 +10,26 @@ Some access control systems use [access group](https://docs.seam.co/latest/capab To learn whether your access control system supports access groups, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +{% tabs %} +{% tab title="JSON" %} ```json -access_group_type: [example value], -access_group_type_display_name: [example value], -acs_access_group_id: [example value], -acs_system_id: [example value], -created_at: [example value], -display_name: [example value], -external_type: [example value], -external_type_display_name: [example value], -is_managed: [example value], -name: [example value], -warnings: [example value], -workspace_id: [example value], +{ + access_group_type: [example value], + access_group_type_display_name: [example value], + acs_access_group_id: [example value], + acs_system_id: [example value], + created_at: [example value], + display_name: [example value], + external_type: [example value], + external_type_display_name: [example value], + is_managed: [example value], + name: [example value], + warnings: [example value], + workspace_id: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 1401f114b..aa839df15 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -10,34 +10,40 @@ An access control system generally uses digital means of access to authorize a u For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. +{% tabs %} +{% tab title="JSON" %} ```json -access_method: [example value], -acs_credential_id: [example value], -acs_credential_pool_id: [example value], -acs_system_id: [example value], -acs_user_id: [example value], -assa_abloy_vostio_metadata: [example value], -card_number: [example value], -code: [example value], -created_at: [example value], -display_name: [example value], -ends_at: [example value], -errors: [example value], -external_type: [example value], -external_type_display_name: [example value], -is_issued: [example value], -is_latest_desired_state_synced_with_provider: [example value], -is_managed: [example value], -is_multi_phone_sync_credential: [example value], -is_one_time_use: [example value], -issued_at: [example value], -latest_desired_state_synced_with_provider_at: [example value], -parent_acs_credential_id: [example value], -starts_at: [example value], -visionline_metadata: [example value], -warnings: [example value], -workspace_id: [example value], +{ + access_method: [example value], + acs_credential_id: [example value], + acs_credential_pool_id: [example value], + acs_system_id: [example value], + acs_user_id: [example value], + assa_abloy_vostio_metadata: [example value], + card_number: [example value], + code: [example value], + created_at: [example value], + display_name: [example value], + ends_at: [example value], + errors: [example value], + external_type: [example value], + external_type_display_name: [example value], + is_issued: [example value], + is_latest_desired_state_synced_with_provider: [example value], + is_managed: [example value], + is_multi_phone_sync_credential: [example value], + is_one_time_use: [example value], + issued_at: [example value], + latest_desired_state_synced_with_provider_at: [example value], + parent_acs_credential_id: [example value], + starts_at: [example value], + visionline_metadata: [example value], + warnings: [example value], + workspace_id: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index d77477b52..14f109cf2 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -19,14 +19,20 @@ Separately, the Seam API also supports card scanning, which enables you to scan To verify if your access control system requires a card encoder, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +{% tabs %} +{% tab title="JSON" %} ```json -acs_encoder_id: [example value], -acs_system_id: [example value], -created_at: [example value], -display_name: [example value], -errors: [example value], -workspace_id: [example value], +{ + acs_encoder_id: [example value], + acs_system_id: [example value], + created_at: [example value], + display_name: [example value], + errors: [example value], + workspace_id: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 1be5ee6e9..8dce24fc5 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -47,11 +47,17 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. Action attempt to track encoding credential data from the physical encoder onto a card. +{% tabs %} +{% tab title="JSON" %} ```json -action_attempt_id: [example value], -action_type: [example value], -status: [example value], +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index c4f6e25ee..72263217a 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -38,11 +38,17 @@ ID of the `acs_encoder` to use for the scan. Reading credential data from physical encoder. +{% tabs %} +{% tab title="JSON" %} ```json -action_attempt_id: [example value], -action_type: [example value], -status: [example value], +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 54392a09b..17026d490 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -8,19 +8,25 @@ Represents an [entrance](../../../capability-guides/access-systems/retrieving-en 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. +{% tabs %} +{% tab title="JSON" %} ```json -acs_entrance_id: [example value], -acs_system_id: [example value], -assa_abloy_vostio_metadata: [example value], -created_at: [example value], -display_name: [example value], -dormakaba_community_metadata: [example value], -errors: [example value], -latch_metadata: [example value], -salto_ks_metadata: [example value], -salto_space_metadata: [example value], -visionline_metadata: [example value], +{ + acs_entrance_id: [example value], + acs_system_id: [example value], + assa_abloy_vostio_metadata: [example value], + created_at: [example value], + display_name: [example value], + dormakaba_community_metadata: [example value], + errors: [example value], + latch_metadata: [example value], + salto_ks_metadata: [example value], + salto_space_metadata: [example value], + visionline_metadata: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 6cc015d56..092f0b9ea 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -10,30 +10,36 @@ Within an `acs_system`, create [`acs_user`s](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/latest/api/acs). +{% tabs %} +{% tab title="JSON" %} ```json -acs_system_id: [example value], -can_add_acs_users_to_acs_access_groups: [example value], -can_automate_enrollment: [example value], -can_create_acs_access_groups: [example value], -can_remove_acs_users_from_acs_access_groups: [example value], -connected_account_id: [example value], -connected_account_ids: [example value], -created_at: [example value], -default_credential_manager_acs_system_id: [example value], -errors: [example value], -external_type: [example value], -external_type_display_name: [example value], -image_alt_text: [example value], -image_url: [example value], -is_credential_manager: [example value], -location: [example value], -name: [example value], -system_type: [example value], -system_type_display_name: [example value], -visionline_metadata: [example value], -warnings: [example value], -workspace_id: [example value], +{ + acs_system_id: [example value], + can_add_acs_users_to_acs_access_groups: [example value], + can_automate_enrollment: [example value], + can_create_acs_access_groups: [example value], + can_remove_acs_users_from_acs_access_groups: [example value], + connected_account_id: [example value], + connected_account_ids: [example value], + created_at: [example value], + default_credential_manager_acs_system_id: [example value], + errors: [example value], + external_type: [example value], + external_type_display_name: [example value], + image_alt_text: [example value], + image_url: [example value], + is_credential_manager: [example value], + location: [example value], + name: [example value], + system_type: [example value], + system_type_display_name: [example value], + visionline_metadata: [example value], + warnings: [example value], + workspace_id: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 249885e9d..87b0c819a 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -10,29 +10,35 @@ An `acs_user` typically refers to an individual who requires access, like an emp For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems). +{% tabs %} +{% tab title="JSON" %} ```json -access_schedule: [example value], -acs_system_id: [example value], -acs_user_id: [example value], -created_at: [example value], -display_name: [example value], -email: [example value], -email_address: [example value], -errors: [example value], -external_type: [example value], -external_type_display_name: [example value], -full_name: [example value], -hid_acs_system_id: [example value], -is_managed: [example value], -is_suspended: [example value], -phone_number: [example value], -user_identity_email_address: [example value], -user_identity_full_name: [example value], -user_identity_id: [example value], -user_identity_phone_number: [example value], -warnings: [example value], -workspace_id: [example value], +{ + access_schedule: [example value], + acs_system_id: [example value], + acs_user_id: [example value], + created_at: [example value], + display_name: [example value], + email: [example value], + email_address: [example value], + errors: [example value], + external_type: [example value], + external_type_display_name: [example value], + full_name: [example value], + hid_acs_system_id: [example value], + is_managed: [example value], + is_suspended: [example value], + phone_number: [example value], + user_identity_email_address: [example value], + user_identity_full_name: [example value], + user_identity_id: [example value], + user_identity_phone_number: [example value], + warnings: [example value], + workspace_id: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index ba2a14d53..c8a86769a 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -6,18 +6,24 @@ The Phones route contains the following resources: Represents an app user's mobile phone. +{% tabs %} +{% tab title="JSON" %} ```json -created_at: [example value], -custom_metadata: [example value], -device_id: [example value], -device_type: [example value], -display_name: [example value], -errors: [example value], -nickname: [example value], -properties: [example value], -warnings: [example value], -workspace_id: [example value], +{ + created_at: [example value], + custom_metadata: [example value], + device_id: [example value], + device_type: [example value], + display_name: [example value], + errors: [example value], + nickname: [example value], + properties: [example value], + warnings: [example value], + workspace_id: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 59cbabdf7..dd142509f 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -179,11 +179,17 @@ ID of the desired thermostat device. Activating climate preset. +{% tabs %} +{% tab title="JSON" %} ```json -action_attempt_id: [example value], -action_type: [example value], -status: [example value], +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 1788a19fe..df0afe773 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -189,11 +189,17 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +{% tabs %} +{% tab title="JSON" %} ```json -action_attempt_id: [example value], -action_type: [example value], -status: [example value], +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index e4b95be49..453e8667e 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -189,11 +189,17 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +{% tabs %} +{% tab title="JSON" %} ```json -action_attempt_id: [example value], -action_type: [example value], -status: [example value], +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index f37295dc3..fef1b401b 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -213,11 +213,17 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +{% tabs %} +{% tab title="JSON" %} ```json -action_attempt_id: [example value], -action_type: [example value], -status: [example value], +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 19155b36c..06ecfb5b8 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -161,11 +161,17 @@ ID of the desired thermostat device. Setting HVAC mode. +{% tabs %} +{% tab title="JSON" %} ```json -action_attempt_id: [example value], -action_type: [example value], -status: [example value], +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 828bd4717..bac5f59fe 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -6,17 +6,23 @@ The Thermostat Schedules route contains the following resources: Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. +{% tabs %} +{% tab title="JSON" %} ```json -climate_preset_key: [example value], -created_at: [example value], -device_id: [example value], -ends_at: [example value], -errors: [example value], -max_override_period_minutes: [example value], -name: [example value], -starts_at: [example value], -thermostat_schedule_id: [example value], +{ + climate_preset_key: [example value], + created_at: [example value], + device_id: [example value], + ends_at: [example value], + errors: [example value], + max_override_period_minutes: [example value], + name: [example value], + starts_at: [example value], + thermostat_schedule_id: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index a9c66fdbb..f7fefbd8b 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -185,11 +185,17 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos Setting fan mode. +{% tabs %} +{% tab title="JSON" %} ```json -action_attempt_id: [example value], -action_type: [example value], -status: [example value], +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 2329dae75..7fe7f49d8 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -225,11 +225,17 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th Setting HVAC mode. +{% tabs %} +{% tab title="JSON" %} ```json -action_attempt_id: [example value], -action_type: [example value], -status: [example value], +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index a5dbbb53e..9a6954794 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -6,16 +6,22 @@ The User Identities route contains the following resources: Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. +{% tabs %} +{% tab title="JSON" %} ```json -created_at: [example value], -display_name: [example value], -email_address: [example value], -full_name: [example value], -phone_number: [example value], -user_identity_id: [example value], -user_identity_key: [example value], -workspace_id: [example value], +{ + created_at: [example value], + display_name: [example value], + email_address: [example value], + full_name: [example value], + phone_number: [example value], + user_identity_id: [example value], + user_identity_key: [example value], + workspace_id: [example value] +} ``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 5c6107594..6f5e3ada3 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -6,13 +6,19 @@ The Enrollment Automations route contains the following resources: Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). +{% tabs %} +{% tab title="JSON" %} ```json -created_at: [example value], -credential_manager_acs_system_id: [example value], -enrollment_automation_id: [example value], -user_identity_id: [example value], -workspace_id: [example value], +{ + created_at: [example value], + credential_manager_acs_system_id: [example value], + enrollment_automation_id: [example value], + user_identity_id: [example value], + workspace_id: [example value] +} ``` +{% endtab %} +{% endtabs %} --- From 69f81c5d4474509afc1998db5bed38b75ca40c7f Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 5 Apr 2025 22:40:16 -0400 Subject: [PATCH 144/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index e50381962..4f6f525d3 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -1,21 +1,18 @@ # {{title}} +{{{description}}} + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` {{request.preferredMethod}} {{path}} ⇒ {{#if response.responseKey}}{{#if (eq response.responseType "resource_list")}}{ {{response.responseKey}}: [{{response.resourceType}}, …] }{{else}}{ {{response.responseKey}} }{{/if}}{{else}}void{{/if}} ``` -{% endtab %} -{% endtabs %} - -{{{description}}} -{{#with primaryCodeSample}} -{{> code-sample }} - -{{/with}} {{#if authMethods}} -## Authentication Methods +
+ +Authentication Methods {{#each authMethods}} - {{this}} @@ -23,10 +20,18 @@
{{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} {{/if}} {{/each}} - ---- +
{{/if}} +{% endtab %} +{% endtabs %} +{% endhint %} + +{{#with primaryCodeSample}} +{{> code-sample }} + +{{/with}} + ## Request Parameters {{#if request.parameters.length}} From 523dd73598550a987c5a756cb9acb96f5abb63ce Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 02:41:19 +0000 Subject: [PATCH 145/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 23 ++++++++------ docs/api/acs/access_groups/get.md | 23 ++++++++------ docs/api/acs/access_groups/list.md | 23 ++++++++------ .../list_accessible_entrances.md | 23 ++++++++------ docs/api/acs/access_groups/list_users.md | 23 ++++++++------ docs/api/acs/access_groups/remove_user.md | 23 ++++++++------ docs/api/acs/credentials/assign.md | 23 ++++++++------ docs/api/acs/credentials/create.md | 23 ++++++++------ docs/api/acs/credentials/delete.md | 23 ++++++++------ docs/api/acs/credentials/get.md | 23 ++++++++------ docs/api/acs/credentials/list.md | 25 +++++++++------ .../credentials/list_accessible_entrances.md | 23 ++++++++------ docs/api/acs/credentials/unassign.md | 23 ++++++++------ docs/api/acs/credentials/update.md | 23 ++++++++------ docs/api/acs/encoders/encode_credential.md | 15 ++++++--- docs/api/acs/encoders/list.md | 15 ++++++--- docs/api/acs/encoders/scan_credential.md | 15 ++++++--- .../next_credential_encode_will_fail.md | 15 ++++++--- .../next_credential_encode_will_succeed.md | 15 ++++++--- .../next_credential_scan_will_fail.md | 15 ++++++--- .../next_credential_scan_will_succeed.md | 15 ++++++--- docs/api/acs/entrances/get.md | 21 ++++++++----- docs/api/acs/entrances/grant_access.md | 15 ++++++--- docs/api/acs/entrances/list.md | 25 +++++++++------ .../entrances/list_credentials_with_access.md | 25 +++++++++------ docs/api/acs/systems/get.md | 27 +++++++++------- docs/api/acs/systems/list.md | 29 ++++++++++------- ...mpatible_credential_manager_acs_systems.md | 31 +++++++++++-------- docs/api/acs/users/add_to_access_group.md | 23 ++++++++------ docs/api/acs/users/create.md | 23 ++++++++------ docs/api/acs/users/delete.md | 23 ++++++++------ docs/api/acs/users/get.md | 23 ++++++++------ docs/api/acs/users/list.md | 25 +++++++++------ .../acs/users/list_accessible_entrances.md | 15 ++++++--- .../api/acs/users/remove_from_access_group.md | 23 ++++++++------ .../users/revoke_access_to_all_entrances.md | 15 ++++++--- docs/api/acs/users/suspend.md | 23 ++++++++------ docs/api/acs/users/unsuspend.md | 23 ++++++++------ docs/api/acs/users/update.md | 23 ++++++++------ docs/api/phones/deactivate.md | 15 ++++++--- docs/api/phones/get.md | 15 ++++++--- docs/api/phones/list.md | 15 ++++++--- .../phones/simulate/create_sandbox_phone.md | 15 ++++++--- .../thermostats/activate_climate_preset.md | 23 ++++++++------ docs/api/thermostats/cool.md | 25 +++++++++------ docs/api/thermostats/create_climate_preset.md | 25 +++++++++------ docs/api/thermostats/delete_climate_preset.md | 25 +++++++++------ docs/api/thermostats/heat.md | 25 +++++++++------ docs/api/thermostats/heat_cool.md | 25 +++++++++------ docs/api/thermostats/list.md | 25 +++++++++------ docs/api/thermostats/off.md | 25 +++++++++------ docs/api/thermostats/schedules/create.md | 25 +++++++++------ docs/api/thermostats/schedules/delete.md | 25 +++++++++------ docs/api/thermostats/schedules/get.md | 25 +++++++++------ docs/api/thermostats/schedules/list.md | 25 +++++++++------ docs/api/thermostats/schedules/update.md | 25 +++++++++------ .../set_fallback_climate_preset.md | 23 ++++++++------ docs/api/thermostats/set_fan_mode.md | 25 +++++++++------ docs/api/thermostats/set_hvac_mode.md | 25 +++++++++------ .../thermostats/set_temperature_threshold.md | 23 ++++++++------ .../simulate/hvac_mode_adjusted.md | 15 ++++++--- .../simulate/temperature_reached.md | 15 ++++++--- docs/api/thermostats/update_climate_preset.md | 25 +++++++++------ docs/api/user_identities/add_acs_user.md | 23 ++++++++------ docs/api/user_identities/create.md | 23 ++++++++------ docs/api/user_identities/delete.md | 23 ++++++++------ .../enrollment_automations/delete.md | 23 ++++++++------ .../enrollment_automations/get.md | 25 +++++++++------ .../enrollment_automations/launch.md | 23 ++++++++------ .../enrollment_automations/list.md | 25 +++++++++------ docs/api/user_identities/get.md | 23 ++++++++------ .../user_identities/grant_access_to_device.md | 23 ++++++++------ docs/api/user_identities/list.md | 25 +++++++++------ .../list_accessible_devices.md | 23 ++++++++------ docs/api/user_identities/list_acs_systems.md | 25 +++++++++------ docs/api/user_identities/list_acs_users.md | 23 ++++++++------ docs/api/user_identities/remove_acs_user.md | 23 ++++++++------ .../revoke_access_to_device.md | 23 ++++++++------ docs/api/user_identities/update.md | 15 ++++++--- 79 files changed, 1069 insertions(+), 674 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 2805c6a65..e87fd49c1 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -1,14 +1,26 @@ # Add an ACS User to an Access Group +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PUT /acs/access_groups/add_user ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -123,13 +135,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 73fe16bf4..5edb74b46 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -1,14 +1,26 @@ # Get an Access Group +Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/access_groups/get ⇒ { acs_access_group } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -170,13 +182,6 @@ api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Nam {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 01e436a12..0ff9aebe5 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -1,14 +1,26 @@ # List Access Groups +Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -189,13 +201,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index bbd65b0d0..44eb68544 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -1,14 +1,26 @@ # List Entrances Accessible to an Access Group +Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -164,13 +176,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index f151a3acb..d25646091 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -1,14 +1,26 @@ # List ACS Users in an Access Group +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -222,13 +234,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index d417a68c9..04d9d592a 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -1,14 +1,26 @@ # Remove an ACS User from an Access Group +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/access_groups/remove_user ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -123,13 +135,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index fc98593dc..f3fbf9106 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -1,14 +1,26 @@ # Assign a Credential to an ACS User +Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PATCH /acs/credentials/assign ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -123,13 +135,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index dbef47242..9d20109c5 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -1,14 +1,26 @@ # Create a Credential for an ACS User +Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/credentials/create ⇒ { acs_credential } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -211,13 +223,6 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 9d00c4d61..e45e5c12f 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -1,14 +1,26 @@ # Delete a Credential +Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/credentials/delete ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -114,13 +126,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 1e44ed30c..2b1fc2432 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -1,14 +1,26 @@ # Get a Credential +Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/credentials/get ⇒ { acs_credential } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -165,13 +177,6 @@ api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUs {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 1a4e19719..2ad078619 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -1,14 +1,27 @@ # List Credentials +Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -194,14 +207,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 45809e06e..1d343e4ff 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -1,14 +1,26 @@ # List Accessible Entrances +Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -209,13 +221,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 283af8293..d4bff6dc8 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -1,14 +1,26 @@ # Unassign a Credential from an ACS User +Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PATCH /acs/credentials/unassign ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -123,13 +135,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 02e3e0ad3..9731b822e 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -1,14 +1,26 @@ # Update a Credential +Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PATCH /acs/credentials/update ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -119,13 +131,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 8dce24fc5..8b4408dae 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -1,22 +1,27 @@ # Encode a Credential +Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/encoders/encode_credential ⇒ { action_attempt } ``` -{% endtab %} -{% endtabs %} -Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index f9aa94e68..5315ecbbc 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -1,22 +1,27 @@ # List Encoders +Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ``` -{% endtab %} -{% endtabs %} -Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 72263217a..fcc08c304 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -1,22 +1,27 @@ # Scan a Credential +Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/encoders/scan_credential ⇒ { action_attempt } ``` -{% endtab %} -{% endtabs %} -Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 3ad65d74a..fb49c4f93 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -1,22 +1,27 @@ # Simulate that the Next Credential Encoding Will Fail +Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ``` -{% endtab %} -{% endtabs %} -Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 9843a3308..df315bba3 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -1,22 +1,27 @@ # Simulate that the Next Credential Encoding Will Succeed +Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ``` -{% endtab %} -{% endtabs %} -Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index c1029de34..a34e2b791 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -1,22 +1,27 @@ # Simulate that the Next Credential Scan Will Fail +Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ``` -{% endtab %} -{% endtabs %} -Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index da97c97b6..d645702ee 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -1,22 +1,27 @@ # Simulate that the Next Credential Scan Will Succeed +Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ``` -{% endtab %} -{% endtabs %} -Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index dea604ca0..1f9403974 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -1,14 +1,25 @@ # Get an Entrance +Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/entrances/get ⇒ { acs_entrance } ``` + +
+ +Authentication Methods + +- API key +- Client session token +
+ {% endtab %} {% endtabs %} - -Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -140,12 +151,6 @@ api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntrance {% endtabs %} -## Authentication Methods - -- API key -- Client session token - ---- ## Request Parameters diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index cf513acb3..5f6c86427 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -1,22 +1,27 @@ # Grant an ACS User Access to an Entrance + + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/entrances/grant_access ⇒ void ``` -{% endtab %} -{% endtabs %} - +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index a95de75be..a339cfd44 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -1,14 +1,27 @@ # List Entrances +Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -138,14 +151,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index ea1783d67..8289b97e7 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -1,14 +1,27 @@ # List Credentials with Access to an Entrance +Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_credential, …] } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -235,14 +248,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 4f1dfa2e1..83e35c82f 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -1,16 +1,28 @@ # Get an ACS System +Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + +Specify the desired access control system by including the corresponding `acs_system_id` in the request body. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/systems/get ⇒ { acs_system } ``` -{% endtab %} -{% endtabs %} -Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +
-Specify the desired access control system by including the corresponding `acs_system_id` in the request body. +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -115,13 +127,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index dfd79b79b..909784099 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -1,16 +1,29 @@ # List ACS Systems +Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). + +To filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ``` -{% endtab %} -{% endtabs %} -Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). +
-To filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -117,14 +130,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 460818a89..a1b059dc2 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -1,18 +1,30 @@ # List Compatible Credential Manager ACS Systems +Returns a list of all credential manager ACS systems that are compatible with a specified +[access control system](https://docs.seam.co/latest/capability-guides/access-systems). + +Specify the ACS system for which you want to retrieve all compatible credential manager ACS +systems by including the corresponding `acs_system_id` in the request body. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` -{% endtab %} -{% endtabs %} -Returns a list of all credential manager ACS systems that are compatible with a specified -[access control system](https://docs.seam.co/latest/capability-guides/access-systems). +
-Specify the ACS system for which you want to retrieve all compatible credential manager ACS -systems by including the corresponding `acs_system_id` in the request body. +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -123,13 +135,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 3751d076a..2d35374b3 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -1,14 +1,26 @@ # Add an ACS User to an Access Group +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PUT /acs/users/add_to_access_group ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -123,13 +135,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index e3d10f32a..c1e962aa0 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -1,14 +1,26 @@ # Create an ACS User +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/users/create ⇒ { acs_user } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -179,13 +191,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 01963fadb..cd34638f8 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -1,14 +1,26 @@ # Delete an ACS User +Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/users/delete ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -112,13 +124,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 79acfe5ce..c9efdf0d1 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -1,14 +1,26 @@ # Get an ACS User +Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/users/get ⇒ { acs_user } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -158,13 +170,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 4685f4fbb..cbb4eb783 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -1,14 +1,27 @@ # List ACS Users +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -148,14 +161,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 246d70a5f..a27ac1b64 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -1,23 +1,28 @@ # List ACS User-Accessible Entrances +Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` -{% endtab %} -{% endtabs %} -Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. +
-## Authentication Methods +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 119aba347..076f5c9e6 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -1,14 +1,26 @@ # Remove an ACS User from an Access Group +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/users/remove_from_access_group ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -123,13 +135,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index fff46237a..781a42fe0 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -1,22 +1,27 @@ # Revoke ACS User Access to All Entrances +Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/users/revoke_access_to_all_entrances ⇒ void ``` -{% endtab %} -{% endtabs %} -Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 1e68cbf71..2b2916cb9 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -1,14 +1,26 @@ # Suspend an ACS User +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/users/suspend ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -112,13 +124,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 4b18eb838..41f20e160 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -1,14 +1,26 @@ # Unsuspend an ACS User +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /acs/users/unsuspend ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -114,13 +126,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index d4e5ed6e6..e242e9b50 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -1,14 +1,26 @@ # Update an ACS User +Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PATCH /acs/users/update ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -122,13 +134,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index a1312416e..7a9b71903 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -1,23 +1,28 @@ # Deactivate a Phone +Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /phones/deactivate ⇒ void ``` -{% endtab %} -{% endtabs %} -Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). +
-## Authentication Methods +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index d609d8c6c..ae63bab35 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -1,22 +1,27 @@ # Get Phone +Returns a single phone entry matching the provided `device_id`. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /phones/get ⇒ { phone } ``` -{% endtab %} -{% endtabs %} -Returns a single phone entry matching the provided `device_id`. +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index f7bcc6972..ee7f62285 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -1,22 +1,27 @@ # List Phones +Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /phones/list ⇒ { phones: [phone, …] } ``` -{% endtab %} -{% endtabs %} -Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 1686ede5d..7ae1bdfa0 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -1,22 +1,27 @@ # Create a Sandbox Phone +Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /phones/simulate/create_sandbox_phone ⇒ { phone } ``` -{% endtab %} -{% endtabs %} -Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index dd142509f..253a69fb5 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -1,14 +1,26 @@ # Activate a Climate Preset +Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/activate_climate_preset ⇒ { action_attempt } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -142,13 +154,6 @@ api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Statu {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index df0afe773..635d2037b 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -1,14 +1,27 @@ # Set to Cool Mode +Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/cool ⇒ { action_attempt } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -142,14 +155,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 4f20ffbae..ecf5f0ae3 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -1,14 +1,27 @@ # Create a Climate Preset +Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/create_climate_preset ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -152,14 +165,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index dd5f15a73..658cd0f48 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -1,14 +1,27 @@ # Delete a Climate Preset +Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/delete_climate_preset ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -121,14 +134,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 453e8667e..e107254fd 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -1,14 +1,27 @@ # Set to Heat Mode +Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/heat ⇒ { action_attempt } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -142,14 +155,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index fef1b401b..f70f1038a 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -1,14 +1,27 @@ # Set to Heat-Cool (Auto) Mode +Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/heat_cool ⇒ { action_attempt } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -148,14 +161,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 60c7c5167..665076033 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -1,14 +1,27 @@ # List Thermostats +Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/list ⇒ { devices: [device, …] } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -223,14 +236,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 06ecfb5b8..351f7d61b 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -1,14 +1,27 @@ # Set to Off Mode +Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/off ⇒ { action_attempt } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -132,14 +145,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 2ae7c7eba..eb04366fd 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -1,14 +1,27 @@ # Create a Thermostat Schedule +Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/schedules/create ⇒ { thermostat_schedule } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -184,14 +197,6 @@ api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a7746 {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 24913deb7..9f7905786 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -1,14 +1,27 @@ # Delete a Thermostat Schedule +Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/schedules/delete ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -116,14 +129,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index d447f1fb8..733ee11a5 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -1,14 +1,27 @@ # Get a Thermostat Schedule +Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/schedules/get ⇒ { thermostat_schedule } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -157,14 +170,6 @@ api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30a {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 23648c329..ed7bf659a 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -1,14 +1,27 @@ # List Thermostat Schedules +Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedule, …] } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -210,14 +223,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 2f170b593..fec4f46ad 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -1,14 +1,27 @@ # Update a Thermostat Schedule +Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PATCH /thermostats/schedules/update ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -123,14 +136,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index e5c879c78..de6dc1750 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -1,14 +1,26 @@ # Set the Fallback Climate Preset +Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/set_fallback_climate_preset ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -121,13 +133,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index f7fefbd8b..23c1cdad9 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -1,14 +1,27 @@ # Set the Fan Mode Setting +Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/set_fan_mode ⇒ { action_attempt } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -142,14 +155,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 7fe7f49d8..676eae624 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -1,14 +1,27 @@ # Set the HVAC Mode +Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/set_hvac_mode ⇒ { action_attempt } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -153,14 +166,6 @@ api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Statu {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 6ef3cc763..de36009f8 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -1,14 +1,26 @@ # Set a Temperature Threshold +Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PATCH /thermostats/set_temperature_threshold ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -127,13 +139,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 85c397611..e0fe65599 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -1,22 +1,27 @@ # HVAC Mode Adjusted +Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ``` -{% endtab %} -{% endtabs %} -Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 27a3e90f1..e8986e43b 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -1,22 +1,27 @@ # Temperature Reached +Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /thermostats/simulate/temperature_reached ⇒ void ``` -{% endtab %} -{% endtabs %} -Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 0e37698a0..dffa49138 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -1,14 +1,27 @@ # Update a Climate Preset +Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PATCH /thermostats/update_climate_preset ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -132,14 +145,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 4bfc51015..aec012213 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -1,14 +1,26 @@ # Add an ACS User to a User Identity +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PUT /user_identities/add_acs_user ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -122,13 +134,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 27be89a33..067b121bd 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -1,14 +1,26 @@ # Create a User Identity +Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/create ⇒ { user_identity } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -178,13 +190,6 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index cffd2486b..7146a8529 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -1,14 +1,26 @@ # Delete a User Identity +Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/delete ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -113,13 +125,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index bf4463b81..2dbd35b85 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -1,14 +1,26 @@ # Delete an Enrollment Automation +Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/delete ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -118,13 +130,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 3b93f089e..8a8badbd0 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -1,14 +1,27 @@ # Get an Enrollment Automation +Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -161,14 +174,6 @@ api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 14042b574..d6fc9bd90 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -1,14 +1,26 @@ # Launch an Enrollment Automation +Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -176,13 +188,6 @@ api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAu {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 0fbd5c84b..22236e80e 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -1,14 +1,27 @@ # List Enrollment Automations +Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: [enrollment_automation, …] } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -171,14 +184,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 14c494f13..411a144e0 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -1,14 +1,26 @@ # Get a User Identity +Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/get ⇒ { user_identity } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -159,13 +171,6 @@ api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIde {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 3f158dcd7..98fd6eb1a 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -1,14 +1,26 @@ # Grant a User Identity Access to a Device +Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PUT /user_identities/grant_access_to_device ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -122,13 +134,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 6ebafb252..0582e3776 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -1,14 +1,27 @@ # List User Identities +Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -158,14 +171,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 37a235e87..30cb8d4f3 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -1,14 +1,26 @@ # List Accessible Devices for a User Identity +Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -389,13 +401,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 8e93e5109..09f0d351d 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -1,14 +1,27 @@ # List ACS Systems Associated with a User Identity +Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -176,14 +189,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 49b3bccec..641a94e98 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -1,14 +1,26 @@ # List ACS Users Associated with a User Identity +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -186,13 +198,6 @@ func main() { {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index fb35b5b9b..3608519c3 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -1,14 +1,26 @@ # Remove an ACS User from a User Identity +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/remove_acs_user ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -122,13 +134,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 731f6f2a1..d1cbf4f19 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -1,14 +1,26 @@ # Revoke Access to a Device from a User Identity +Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` POST /user_identities/revoke_access_to_device ⇒ void ``` + +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ {% endtab %} {% endtabs %} - -Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). +{% endhint %} {% tabs %} {% tab title="JavaScript" %} @@ -122,13 +134,6 @@ nil {% endtabs %} -## Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. - ---- ## Request Parameters diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index afae2ac5b..1190756f5 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -1,22 +1,27 @@ # Update a User Identity + + +{% hint style="info" %} {% tabs %} {% tab title="Signature" %} ``` PATCH /user_identities/update ⇒ void ``` -{% endtab %} -{% endtabs %} - +
-## Authentication Methods +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. +
+ +{% endtab %} +{% endtabs %} +{% endhint %} ---- ## Request Parameters From b1b63e7db9783856b365f819091c42d9a37485e8 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 5 Apr 2025 22:46:08 -0400 Subject: [PATCH 146/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 4f6f525d3..57066b3b8 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -2,9 +2,7 @@ {{{description}}} -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` {{request.preferredMethod}} {{path}} ⇒ {{#if response.responseKey}}{{#if (eq response.responseType "resource_list")}}{ {{response.responseKey}}: [{{response.resourceType}}, …] }{{else}}{ {{response.responseKey}} }{{/if}}{{else}}void{{/if}} ``` @@ -22,9 +20,6 @@ {{/each}} {{/if}} - -{% endtab %} -{% endtabs %} {% endhint %} {{#with primaryCodeSample}} From 31f452fe63c956dc8c81f6f1fc3ab77c0573c11d Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 02:47:08 +0000 Subject: [PATCH 147/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 7 +------ docs/api/acs/access_groups/get.md | 7 +------ docs/api/acs/access_groups/list.md | 7 +------ docs/api/acs/access_groups/list_accessible_entrances.md | 7 +------ docs/api/acs/access_groups/list_users.md | 7 +------ docs/api/acs/access_groups/remove_user.md | 7 +------ docs/api/acs/credentials/assign.md | 7 +------ docs/api/acs/credentials/create.md | 7 +------ docs/api/acs/credentials/delete.md | 7 +------ docs/api/acs/credentials/get.md | 7 +------ docs/api/acs/credentials/list.md | 7 +------ docs/api/acs/credentials/list_accessible_entrances.md | 7 +------ docs/api/acs/credentials/unassign.md | 7 +------ docs/api/acs/credentials/update.md | 7 +------ docs/api/acs/encoders/encode_credential.md | 7 +------ docs/api/acs/encoders/list.md | 7 +------ docs/api/acs/encoders/scan_credential.md | 7 +------ .../encoders/simulate/next_credential_encode_will_fail.md | 7 +------ .../simulate/next_credential_encode_will_succeed.md | 7 +------ .../encoders/simulate/next_credential_scan_will_fail.md | 7 +------ .../encoders/simulate/next_credential_scan_will_succeed.md | 7 +------ docs/api/acs/entrances/get.md | 7 +------ docs/api/acs/entrances/grant_access.md | 7 +------ docs/api/acs/entrances/list.md | 7 +------ docs/api/acs/entrances/list_credentials_with_access.md | 7 +------ docs/api/acs/systems/get.md | 7 +------ docs/api/acs/systems/list.md | 7 +------ .../list_compatible_credential_manager_acs_systems.md | 7 +------ docs/api/acs/users/add_to_access_group.md | 7 +------ docs/api/acs/users/create.md | 7 +------ docs/api/acs/users/delete.md | 7 +------ docs/api/acs/users/get.md | 7 +------ docs/api/acs/users/list.md | 7 +------ docs/api/acs/users/list_accessible_entrances.md | 7 +------ docs/api/acs/users/remove_from_access_group.md | 7 +------ docs/api/acs/users/revoke_access_to_all_entrances.md | 7 +------ docs/api/acs/users/suspend.md | 7 +------ docs/api/acs/users/unsuspend.md | 7 +------ docs/api/acs/users/update.md | 7 +------ docs/api/phones/deactivate.md | 7 +------ docs/api/phones/get.md | 7 +------ docs/api/phones/list.md | 7 +------ docs/api/phones/simulate/create_sandbox_phone.md | 7 +------ docs/api/thermostats/activate_climate_preset.md | 7 +------ docs/api/thermostats/cool.md | 7 +------ docs/api/thermostats/create_climate_preset.md | 7 +------ docs/api/thermostats/delete_climate_preset.md | 7 +------ docs/api/thermostats/heat.md | 7 +------ docs/api/thermostats/heat_cool.md | 7 +------ docs/api/thermostats/list.md | 7 +------ docs/api/thermostats/off.md | 7 +------ docs/api/thermostats/schedules/create.md | 7 +------ docs/api/thermostats/schedules/delete.md | 7 +------ docs/api/thermostats/schedules/get.md | 7 +------ docs/api/thermostats/schedules/list.md | 7 +------ docs/api/thermostats/schedules/update.md | 7 +------ docs/api/thermostats/set_fallback_climate_preset.md | 7 +------ docs/api/thermostats/set_fan_mode.md | 7 +------ docs/api/thermostats/set_hvac_mode.md | 7 +------ docs/api/thermostats/set_temperature_threshold.md | 7 +------ docs/api/thermostats/simulate/hvac_mode_adjusted.md | 7 +------ docs/api/thermostats/simulate/temperature_reached.md | 7 +------ docs/api/thermostats/update_climate_preset.md | 7 +------ docs/api/user_identities/add_acs_user.md | 7 +------ docs/api/user_identities/create.md | 7 +------ docs/api/user_identities/delete.md | 7 +------ docs/api/user_identities/enrollment_automations/delete.md | 7 +------ docs/api/user_identities/enrollment_automations/get.md | 7 +------ docs/api/user_identities/enrollment_automations/launch.md | 7 +------ docs/api/user_identities/enrollment_automations/list.md | 7 +------ docs/api/user_identities/get.md | 7 +------ docs/api/user_identities/grant_access_to_device.md | 7 +------ docs/api/user_identities/list.md | 7 +------ docs/api/user_identities/list_accessible_devices.md | 7 +------ docs/api/user_identities/list_acs_systems.md | 7 +------ docs/api/user_identities/list_acs_users.md | 7 +------ docs/api/user_identities/remove_acs_user.md | 7 +------ docs/api/user_identities/revoke_access_to_device.md | 7 +------ docs/api/user_identities/update.md | 7 +------ 79 files changed, 79 insertions(+), 474 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index e87fd49c1..c38877bdc 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -2,9 +2,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PUT /acs/access_groups/add_user ⇒ void ``` @@ -17,9 +15,6 @@ PUT /acs/access_groups/add_user ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 5edb74b46..bb5b26a32 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -2,9 +2,7 @@ Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/access_groups/get ⇒ { acs_access_group } ``` @@ -17,9 +15,6 @@ POST /acs/access_groups/get ⇒ { acs_access_group } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 0ff9aebe5..7742d29ec 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -2,9 +2,7 @@ Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ``` @@ -17,9 +15,6 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 44eb68544..7af061bf0 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -2,9 +2,7 @@ Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` @@ -17,9 +15,6 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index d25646091..6557c248f 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -2,9 +2,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ``` @@ -17,9 +15,6 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 04d9d592a..e93b5f62a 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -2,9 +2,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/access_groups/remove_user ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/access_groups/remove_user ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index f3fbf9106..1093dcebb 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -2,9 +2,7 @@ Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PATCH /acs/credentials/assign ⇒ void ``` @@ -17,9 +15,6 @@ PATCH /acs/credentials/assign ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 9d20109c5..a3da70180 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -2,9 +2,7 @@ Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/credentials/create ⇒ { acs_credential } ``` @@ -17,9 +15,6 @@ POST /acs/credentials/create ⇒ { acs_credential } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index e45e5c12f..b45fc59f2 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -2,9 +2,7 @@ Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/credentials/delete ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/credentials/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 2b1fc2432..e3d7cbfc2 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -2,9 +2,7 @@ Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/credentials/get ⇒ { acs_credential } ``` @@ -17,9 +15,6 @@ POST /acs/credentials/get ⇒ { acs_credential } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 2ad078619..0dfb706a2 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -2,9 +2,7 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ``` @@ -18,9 +16,6 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 1d343e4ff..1e07dc0b6 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -2,9 +2,7 @@ Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` @@ -17,9 +15,6 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index d4bff6dc8..2eb528752 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -2,9 +2,7 @@ Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PATCH /acs/credentials/unassign ⇒ void ``` @@ -17,9 +15,6 @@ PATCH /acs/credentials/unassign ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 9731b822e..bc5568ed7 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -2,9 +2,7 @@ Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PATCH /acs/credentials/update ⇒ void ``` @@ -17,9 +15,6 @@ PATCH /acs/credentials/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 8b4408dae..2cbc7462b 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -2,9 +2,7 @@ Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/encoders/encode_credential ⇒ { action_attempt } ``` @@ -17,9 +15,6 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 5315ecbbc..89250ee24 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -2,9 +2,7 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ``` @@ -17,9 +15,6 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index fcc08c304..ed33e632e 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -2,9 +2,7 @@ Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/encoders/scan_credential ⇒ { action_attempt } ``` @@ -17,9 +15,6 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index fb49c4f93..8e0c593a8 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -2,9 +2,7 @@ Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index df315bba3..54ca990e4 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -2,9 +2,7 @@ Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index a34e2b791..3c60f669a 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -2,9 +2,7 @@ Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index d645702ee..4fb607782 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -2,9 +2,7 @@ Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 1f9403974..f4c598666 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -2,9 +2,7 @@ Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/entrances/get ⇒ { acs_entrance } ``` @@ -16,9 +14,6 @@ POST /acs/entrances/get ⇒ { acs_entrance } - API key - Client session token - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 5f6c86427..6d6d64d64 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -2,9 +2,7 @@ -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/entrances/grant_access ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/entrances/grant_access ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index a339cfd44..4f301e5bc 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -2,9 +2,7 @@ Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ``` @@ -18,9 +16,6 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 8289b97e7..9f114fc0c 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -2,9 +2,7 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_credential, …] } ``` @@ -18,9 +16,6 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 83e35c82f..3075bfacf 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -4,9 +4,7 @@ Returns a specified [access control system](https://docs.seam.co/latest/capabili Specify the desired access control system by including the corresponding `acs_system_id` in the request body. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/systems/get ⇒ { acs_system } ``` @@ -19,9 +17,6 @@ POST /acs/systems/get ⇒ { acs_system } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 909784099..2cc8fa892 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -4,9 +4,7 @@ Returns a list of all [access control systems](https://docs.seam.co/latest/capab To filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ``` @@ -20,9 +18,6 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index a1b059dc2..ddb49e74b 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -6,9 +6,7 @@ Returns a list of all credential manager ACS systems that are compatible with a Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` @@ -21,9 +19,6 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 2d35374b3..845acd0ae 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -2,9 +2,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PUT /acs/users/add_to_access_group ⇒ void ``` @@ -17,9 +15,6 @@ PUT /acs/users/add_to_access_group ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index c1e962aa0..d183d5450 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -2,9 +2,7 @@ Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/users/create ⇒ { acs_user } ``` @@ -17,9 +15,6 @@ POST /acs/users/create ⇒ { acs_user } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index cd34638f8..6ab9e02fd 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -2,9 +2,7 @@ Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/users/delete ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/users/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index c9efdf0d1..e0840b283 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -2,9 +2,7 @@ Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/users/get ⇒ { acs_user } ``` @@ -17,9 +15,6 @@ POST /acs/users/get ⇒ { acs_user } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index cbb4eb783..c38bb4144 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -2,9 +2,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ``` @@ -18,9 +16,6 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index a27ac1b64..5133b835d 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -2,9 +2,7 @@ Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` @@ -18,9 +16,6 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 076f5c9e6..9aa0586d4 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -2,9 +2,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/users/remove_from_access_group ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/users/remove_from_access_group ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 781a42fe0..50e5d84a2 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -2,9 +2,7 @@ Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/users/revoke_access_to_all_entrances ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 2b2916cb9..ea0acfd6f 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -2,9 +2,7 @@ [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/users/suspend ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/users/suspend ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 41f20e160..54d80529b 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -2,9 +2,7 @@ [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /acs/users/unsuspend ⇒ void ``` @@ -17,9 +15,6 @@ POST /acs/users/unsuspend ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index e242e9b50..8e5492505 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -2,9 +2,7 @@ Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PATCH /acs/users/update ⇒ void ``` @@ -17,9 +15,6 @@ PATCH /acs/users/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 7a9b71903..21a34280d 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -2,9 +2,7 @@ Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /phones/deactivate ⇒ void ``` @@ -18,9 +16,6 @@ POST /phones/deactivate ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index ae63bab35..534cd1651 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -2,9 +2,7 @@ Returns a single phone entry matching the provided `device_id`. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /phones/get ⇒ { phone } ``` @@ -17,9 +15,6 @@ POST /phones/get ⇒ { phone } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index ee7f62285..f2b200458 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -2,9 +2,7 @@ Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /phones/list ⇒ { phones: [phone, …] } ``` @@ -17,9 +15,6 @@ POST /phones/list ⇒ { phones: [phone, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 7ae1bdfa0..7cc9ce1ad 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -2,9 +2,7 @@ Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /phones/simulate/create_sandbox_phone ⇒ { phone } ``` @@ -17,9 +15,6 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 253a69fb5..b5756efcb 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -2,9 +2,7 @@ Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/activate_climate_preset ⇒ { action_attempt } ``` @@ -17,9 +15,6 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 635d2037b..db4d828e4 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -2,9 +2,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/cool ⇒ { action_attempt } ``` @@ -18,9 +16,6 @@ POST /thermostats/cool ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index ecf5f0ae3..35acb9648 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -2,9 +2,7 @@ Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/create_climate_preset ⇒ void ``` @@ -18,9 +16,6 @@ POST /thermostats/create_climate_preset ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 658cd0f48..0ed380cd7 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -2,9 +2,7 @@ Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/delete_climate_preset ⇒ void ``` @@ -18,9 +16,6 @@ POST /thermostats/delete_climate_preset ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index e107254fd..72f8da487 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -2,9 +2,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/heat ⇒ { action_attempt } ``` @@ -18,9 +16,6 @@ POST /thermostats/heat ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index f70f1038a..638ca12ad 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -2,9 +2,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/heat_cool ⇒ { action_attempt } ``` @@ -18,9 +16,6 @@ POST /thermostats/heat_cool ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 665076033..9a8860507 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -2,9 +2,7 @@ Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/list ⇒ { devices: [device, …] } ``` @@ -18,9 +16,6 @@ POST /thermostats/list ⇒ { devices: [device, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 351f7d61b..4f707dcff 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -2,9 +2,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/off ⇒ { action_attempt } ``` @@ -18,9 +16,6 @@ POST /thermostats/off ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index eb04366fd..198ba8b13 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -2,9 +2,7 @@ Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/schedules/create ⇒ { thermostat_schedule } ``` @@ -18,9 +16,6 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 9f7905786..64d9d659c 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -2,9 +2,7 @@ Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/schedules/delete ⇒ void ``` @@ -18,9 +16,6 @@ POST /thermostats/schedules/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 733ee11a5..bee713b42 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -2,9 +2,7 @@ Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/schedules/get ⇒ { thermostat_schedule } ``` @@ -18,9 +16,6 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index ed7bf659a..d2de655ba 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -2,9 +2,7 @@ Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedule, …] } ``` @@ -18,9 +16,6 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index fec4f46ad..bada31c7b 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -2,9 +2,7 @@ Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PATCH /thermostats/schedules/update ⇒ void ``` @@ -18,9 +16,6 @@ PATCH /thermostats/schedules/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index de6dc1750..2fa76584d 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -2,9 +2,7 @@ Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/set_fallback_climate_preset ⇒ void ``` @@ -17,9 +15,6 @@ POST /thermostats/set_fallback_climate_preset ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 23c1cdad9..aa17cfa74 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -2,9 +2,7 @@ Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/set_fan_mode ⇒ { action_attempt } ``` @@ -18,9 +16,6 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 676eae624..21a6f8c07 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -2,9 +2,7 @@ Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/set_hvac_mode ⇒ { action_attempt } ``` @@ -18,9 +16,6 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index de36009f8..4aabd1217 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -2,9 +2,7 @@ Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PATCH /thermostats/set_temperature_threshold ⇒ void ``` @@ -17,9 +15,6 @@ PATCH /thermostats/set_temperature_threshold ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index e0fe65599..2c8bc7958 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -2,9 +2,7 @@ Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ``` @@ -17,9 +15,6 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index e8986e43b..e936a3bba 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -2,9 +2,7 @@ Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /thermostats/simulate/temperature_reached ⇒ void ``` @@ -17,9 +15,6 @@ POST /thermostats/simulate/temperature_reached ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index dffa49138..cf7214201 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -2,9 +2,7 @@ Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PATCH /thermostats/update_climate_preset ⇒ void ``` @@ -18,9 +16,6 @@ PATCH /thermostats/update_climate_preset ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index aec012213..aaa926331 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -2,9 +2,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PUT /user_identities/add_acs_user ⇒ void ``` @@ -17,9 +15,6 @@ PUT /user_identities/add_acs_user ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 067b121bd..7902f2fd0 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -2,9 +2,7 @@ Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/create ⇒ { user_identity } ``` @@ -17,9 +15,6 @@ POST /user_identities/create ⇒ { user_identity } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 7146a8529..af29b2faf 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -2,9 +2,7 @@ Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/delete ⇒ void ``` @@ -17,9 +15,6 @@ POST /user_identities/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 2dbd35b85..23c3389c5 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -2,9 +2,7 @@ Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/enrollment_automations/delete ⇒ void ``` @@ -17,9 +15,6 @@ POST /user_identities/enrollment_automations/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 8a8badbd0..1ae0264d3 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -2,9 +2,7 @@ Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ``` @@ -18,9 +16,6 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index d6fc9bd90..282a3f943 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -2,9 +2,7 @@ Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation } ``` @@ -17,9 +15,6 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 22236e80e..fd1c9cd2e 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -2,9 +2,7 @@ Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: [enrollment_automation, …] } ``` @@ -18,9 +16,6 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 411a144e0..f3a291988 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -2,9 +2,7 @@ Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/get ⇒ { user_identity } ``` @@ -17,9 +15,6 @@ POST /user_identities/get ⇒ { user_identity } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 98fd6eb1a..aa479250e 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -2,9 +2,7 @@ Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PUT /user_identities/grant_access_to_device ⇒ void ``` @@ -17,9 +15,6 @@ PUT /user_identities/grant_access_to_device ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 0582e3776..141dac8ca 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -2,9 +2,7 @@ Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ``` @@ -18,9 +16,6 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 30cb8d4f3..5d74ea314 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -2,9 +2,7 @@ Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ``` @@ -17,9 +15,6 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 09f0d351d..98bc6d8ce 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -2,9 +2,7 @@ Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` @@ -18,9 +16,6 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 641a94e98..fbb1e1f52 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -2,9 +2,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ``` @@ -17,9 +15,6 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 3608519c3..859d3f70e 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -2,9 +2,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/remove_acs_user ⇒ void ``` @@ -17,9 +15,6 @@ POST /user_identities/remove_acs_user ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index d1cbf4f19..3b8b9e8b6 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -2,9 +2,7 @@ Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` POST /user_identities/revoke_access_to_device ⇒ void ``` @@ -17,9 +15,6 @@ POST /user_identities/revoke_access_to_device ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} {% tabs %} diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 1190756f5..210282b15 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -2,9 +2,7 @@ -{% hint style="info" %} -{% tabs %} -{% tab title="Signature" %} +{% hint style="success" %} ``` PATCH /user_identities/update ⇒ void ``` @@ -17,9 +15,6 @@ PATCH /user_identities/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - -{% endtab %} -{% endtabs %} {% endhint %} From 3c24840014e7b24a06b1cab1564b76be29b576c1 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sat, 5 Apr 2025 22:56:29 -0400 Subject: [PATCH 148/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 57066b3b8..2a6ddafa9 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -6,6 +6,7 @@ ``` {{request.preferredMethod}} {{path}} ⇒ {{#if response.responseKey}}{{#if (eq response.responseType "resource_list")}}{ {{response.responseKey}}: [{{response.resourceType}}, …] }{{else}}{ {{response.responseKey}} }{{/if}}{{else}}void{{/if}} ``` +{% endhint %} {{#if authMethods}}
@@ -20,31 +21,24 @@ {{/each}}
{{/if}} -{% endhint %} - -{{#with primaryCodeSample}} -{{> code-sample }} - -{{/with}} ## Request Parameters {{#if request.parameters.length}} {{#each request.parameters}} -### `{{this.name}}` - -Type: `{{this.jsonType}}` -{{#if this.itemFormat}} -Item format: `{{this.itemFormat}}` -{{/if}} +**`{{this.name}}`** *{{this.jsonType}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}} Required: {{#if this.required}}Yes{{else}}No{{/if}} {{#if this.description}} {{this.description}} {{/if}} {{#if this.itemEnumValues}} +
+ +Enum values {{> enum-values enumValues=this.itemEnumValues}} +
{{/if}} --- @@ -66,7 +60,16 @@ None --- -## Code Samples +## Examples + +{{#with primaryCodeSample}} +### {{this.title}} + +{{this.description}} + +{{> code-sample }} + +{{/with}} {{#each additionalCodeSamples}} ### {{this.title}} From b7a433c8b1938bf8b42c60f3690b59fd9c599ab5 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 02:57:37 +0000 Subject: [PATCH 149/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 124 +----- docs/api/acs/access_groups/get.md | 167 +------- docs/api/acs/access_groups/list.md | 190 +-------- .../list_accessible_entrances.md | 161 +------- docs/api/acs/access_groups/list_users.md | 219 +--------- docs/api/acs/access_groups/remove_user.md | 124 +----- docs/api/acs/credentials/assign.md | 124 +----- docs/api/acs/credentials/create.md | 249 +---------- docs/api/acs/credentials/delete.md | 111 +---- docs/api/acs/credentials/get.md | 162 +------- docs/api/acs/credentials/list.md | 211 +--------- .../credentials/list_accessible_entrances.md | 206 +--------- docs/api/acs/credentials/unassign.md | 124 +----- docs/api/acs/credentials/update.md | 124 +----- docs/api/acs/encoders/encode_credential.md | 11 +- docs/api/acs/encoders/list.md | 21 +- docs/api/acs/encoders/scan_credential.md | 7 +- .../next_credential_encode_will_fail.md | 15 +- .../next_credential_encode_will_succeed.md | 11 +- .../next_credential_scan_will_fail.md | 15 +- .../next_credential_scan_will_succeed.md | 15 +- docs/api/acs/entrances/get.md | 137 +------ docs/api/acs/entrances/grant_access.md | 11 +- docs/api/acs/entrances/list.md | 139 +------ .../entrances/list_credentials_with_access.md | 241 +---------- docs/api/acs/systems/get.md | 110 +---- docs/api/acs/systems/list.md | 112 +---- ...mpatible_credential_manager_acs_systems.md | 116 +----- docs/api/acs/users/add_to_access_group.md | 124 +----- docs/api/acs/users/create.md | 153 ++++--- docs/api/acs/users/delete.md | 109 +---- docs/api/acs/users/get.md | 155 +------ docs/api/acs/users/list.md | 173 +------- .../acs/users/list_accessible_entrances.md | 7 +- .../api/acs/users/remove_from_access_group.md | 124 +----- .../users/revoke_access_to_all_entrances.md | 7 +- docs/api/acs/users/suspend.md | 109 +---- docs/api/acs/users/unsuspend.md | 111 +---- docs/api/acs/users/update.md | 143 +------ docs/api/phones/deactivate.md | 7 +- docs/api/phones/get.md | 7 +- docs/api/phones/list.md | 11 +- .../phones/simulate/create_sandbox_phone.md | 19 +- .../thermostats/activate_climate_preset.md | 143 +------ docs/api/thermostats/cool.md | 147 +------ docs/api/thermostats/create_climate_preset.md | 185 +-------- docs/api/thermostats/delete_climate_preset.md | 122 +----- docs/api/thermostats/heat.md | 147 +------ docs/api/thermostats/heat_cool.md | 161 +------- docs/api/thermostats/list.md | 267 +----------- docs/api/thermostats/off.md | 129 +----- docs/api/thermostats/schedules/create.md | 205 +--------- docs/api/thermostats/schedules/delete.md | 113 +---- docs/api/thermostats/schedules/get.md | 154 +------ docs/api/thermostats/schedules/list.md | 211 +--------- docs/api/thermostats/schedules/update.md | 144 +------ .../set_fallback_climate_preset.md | 122 +----- docs/api/thermostats/set_fan_mode.md | 147 +------ docs/api/thermostats/set_hvac_mode.md | 170 +------- .../thermostats/set_temperature_threshold.md | 140 +------ .../simulate/hvac_mode_adjusted.md | 27 +- .../simulate/temperature_reached.md | 15 +- docs/api/thermostats/update_climate_preset.md | 165 +------- docs/api/user_identities/add_acs_user.md | 123 +----- docs/api/user_identities/create.md | 187 +-------- docs/api/user_identities/delete.md | 110 +---- .../enrollment_automations/delete.md | 115 +----- .../enrollment_automations/get.md | 158 +------ .../enrollment_automations/launch.md | 189 +-------- .../enrollment_automations/list.md | 168 +------- docs/api/user_identities/get.md | 160 +------- .../user_identities/grant_access_to_device.md | 123 +----- docs/api/user_identities/list.md | 155 +------ .../list_accessible_devices.md | 386 +----------------- docs/api/user_identities/list_acs_systems.md | 173 +------- docs/api/user_identities/list_acs_users.md | 183 +-------- docs/api/user_identities/remove_acs_user.md | 123 +----- .../revoke_access_to_device.md | 123 +----- docs/api/user_identities/update.md | 23 +- 79 files changed, 375 insertions(+), 9554 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index c38877bdc..e7e4cfc49 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -6,6 +6,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access ``` PUT /acs/access_groups/add_user ⇒ void ``` +{% endhint %}
@@ -15,136 +16,17 @@ PUT /acs/access_groups/add_user ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.accessGroups.addUser({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.access_groups.add_user( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - acs_user_id="33333333-3333-3333-3333-333333333333", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.access_groups.add_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->access_groups->add_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.AddUser( - context.Background(), - accessgroups.AccessGroupsAddUserRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_access_group_id` - -Type: `string` +**`acs_access_group_id`** *string* Required: Yes ID of the desired access group. --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired user. diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index bb5b26a32..ab407e0ba 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -6,6 +6,7 @@ Returns a specified [access group](https://docs.seam.co/latest/capability-guides ``` POST /acs/access_groups/get ⇒ { acs_access_group } ``` +{% endhint %}
@@ -15,174 +16,10 @@ POST /acs/access_groups/get ⇒ { acs_access_group } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.accessGroups.get({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -}); -``` - -#### Output - -```javascript -{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444") -``` - -#### Output - -```python -AcsAccessGroup( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - name="Lobby Access", - display_name="Lobby Access", - access_group_type_display_name="PTI access level", - access_group_type="pti_access_level", - external_type="pti_access_level", - external_type_display_name="PTI access level", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2023-11-30T06:27:15.437Z", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444") -``` - -#### Output - -```ruby -{ - "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->access_groups->get( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` - -#### Output - -```php - "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444" -``` - -#### Output - -```seam_cli -{ - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.Get( - context.Background(), - accessgroups.AccessGroupsGetRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - }, - ) -} -``` - -#### Output - -```go -api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_access_group_id` - -Type: `string` +**`acs_access_group_id`** *string* Required: Yes ID of the desired access group. diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 7742d29ec..54e37c763 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -6,6 +6,7 @@ Returns a list of all [access groups](https://docs.seam.co/latest/capability-gui ``` POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ``` +{% endhint %}
@@ -15,202 +16,17 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.accessGroups.list({ - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333", -}); -``` - -#### Output - -```javascript -[ - { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.access_groups.list( - acs_system_id="11111111-1111-1111-1111-111111111111", - acs_user_id="33333333-3333-3333-3333-333333333333", -) -``` - -#### Output - -```python -[ - AcsAccessGroup( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - name="Lobby Access", - display_name="Lobby Access", - access_group_type_display_name="PTI access level", - access_group_type="pti_access_level", - external_type="pti_access_level", - external_type_display_name="PTI access level", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2023-11-30T06:27:15.437Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.access_groups.list( - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333", -) -``` - -#### Output - -```ruby -[ - { - "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->access_groups->list( - acs_system_id: "11111111-1111-1111-1111-111111111111", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` - -#### Output - -```php - "44444444-4444-4444-4444-444444444444", - "name" => "Lobby Access", - "display_name" => "Lobby Access", - "access_group_type_display_name" => "PTI access level", - "access_group_type" => "pti_access_level", - "external_type" => "pti_access_level", - "external_type_display_name" => "PTI access level", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2023-11-30T06:27:15.437Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333" -``` - -#### Output - -```seam_cli -[ - { - "acs_access_group_id": "44444444-4444-4444-4444-444444444444", - "name": "Lobby Access", - "display_name": "Lobby Access", - "access_group_type_display_name": "PTI access level", - "access_group_type": "pti_access_level", - "external_type": "pti_access_level", - "external_type_display_name": "PTI access level", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2023-11-30T06:27:15.437Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.List( - context.Background(), - accessgroups.AccessGroupsListRequest{ - AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_system_id` - -Type: `string` +**`acs_system_id`** *string* Required: No ID of the access control system for which you want to retrieve all access groups. --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: No ID of the user for which you want to retrieve all access groups. diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 7af061bf0..1d6f6b35c 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -6,6 +6,7 @@ Returns a list of all accessible entrances for a specified [access group](https: ``` POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endhint %}
@@ -15,168 +16,10 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.accessGroups.listAccessibleEntrances({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -}); -``` - -#### Output - -```javascript -[ - { - "acs_entrance_id": "66666666-6666-6666-6666-666666666666", - "name": "Main Entrance", - "display_name": "Main Entrance", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-10-15T12:00:00.000Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.access_groups.list_accessible_entrances( - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` - -#### Output - -```python -[ - AcsEntrance( - acs_entrance_id="66666666-6666-6666-6666-666666666666", - name="Main Entrance", - display_name="Main Entrance", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-10-15T12:00:00.000Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.access_groups.list_accessible_entrances( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -) -``` - -#### Output - -```ruby -[ - { - "acs_entrance_id" => "66666666-6666-6666-6666-666666666666", - "name" => "Main Entrance", - "display_name" => "Main Entrance", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-10-15T12:00:00.000Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->access_groups->list_accessible_entrances( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` - -#### Output - -```php - "66666666-6666-6666-6666-666666666666", - "name" => "Main Entrance", - "display_name" => "Main Entrance", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-10-15T12:00:00.000Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444" -``` - -#### Output - -```seam_cli -[ - { - "acs_entrance_id": "66666666-6666-6666-6666-666666666666", - "name": "Main Entrance", - "display_name": "Main Entrance", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-10-15T12:00:00.000Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.ListAccessibleEntrances( - context.Background(), - accessgroups.AccessGroupsListAccessibleEntrancesRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_access_group_id` - -Type: `string` +**`acs_access_group_id`** *string* Required: Yes ID of the access group for which you want to retrieve all accessible entrances. diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 6557c248f..ff68112e6 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -6,6 +6,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ ``` POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ``` +{% endhint %}
@@ -15,226 +16,10 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.accessGroups.listUsers({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", -}); -``` - -#### Output - -```javascript -[ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.access_groups.list_users( - acs_access_group_id="44444444-4444-4444-4444-444444444444" -) -``` - -#### Output - -```python -[ - AcsUser( - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Jane Doe", - full_name="Jane Doe", - email="jane@example.com", - email_address="jane@example.com", - phone_number="+15555550100", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-05T07:14:28.531Z", - is_suspended=false, - access_schedule={ - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z", - }, - user_identity_id="22222222-2222-2222-2222-222222222222", - user_identity_full_name="Jane Doe", - user_identity_email_address="jane@example.com", - user_identity_phone_number="+15555550100", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444") -``` - -#### Output - -```ruby -[ - { - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email" => "jane@example.com", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-05T07:14:28.531Z", - "is_suspended" => false, - "access_schedule" => { - starts_at: "2024-03-01T10:40:00.000Z", - ends_at: "2024-03-04T10:40:00.000Z", - }, - "user_identity_id" => "22222222-2222-2222-2222-222222222222", - "user_identity_full_name" => "Jane Doe", - "user_identity_email_address" => "jane@example.com", - "user_identity_phone_number" => "+15555550100", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->access_groups->list_users( - acs_access_group_id: "44444444-4444-4444-4444-444444444444" -); -``` - -#### Output - -```php - "33333333-3333-3333-3333-333333333333", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email" => "jane@example.com", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-05T07:14:28.531Z", - "is_suspended" => false, - "access_schedule" => [ - "starts_at" => "2024-03-01T10:40:00.000Z", - "ends_at" => "2024-03-04T10:40:00.000Z", - ], - "user_identity_id" => "22222222-2222-2222-2222-222222222222", - "user_identity_full_name" => "Jane Doe", - "user_identity_email_address" => "jane@example.com", - "user_identity_phone_number" => "+15555550100", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444" -``` - -#### Output - -```seam_cli -[ - { - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email": "jane@example.com", - "email_address": "jane@example.com", - "phone_number": "+15555550100", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-05T07:14:28.531Z", - "is_suspended": false, - "access_schedule": { - "starts_at": "2024-03-01T10:40:00.000Z", - "ends_at": "2024-03-04T10:40:00.000Z" - }, - "user_identity_id": "22222222-2222-2222-2222-222222222222", - "user_identity_full_name": "Jane Doe", - "user_identity_email_address": "jane@example.com", - "user_identity_phone_number": "+15555550100" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.ListUsers( - context.Background(), - accessgroups.AccessGroupsListUsersRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_access_group_id` - -Type: `string` +**`acs_access_group_id`** *string* Required: Yes ID of the access group for which you want to retrieve all users. diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index e93b5f62a..631ca0762 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -6,6 +6,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc ``` POST /acs/access_groups/remove_user ⇒ void ``` +{% endhint %}
@@ -15,136 +16,17 @@ POST /acs/access_groups/remove_user ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.accessGroups.removeUser({ - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.access_groups.remove_user( - acs_access_group_id="44444444-4444-4444-4444-444444444444", - acs_user_id="33333333-3333-3333-3333-333333333333", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.access_groups.remove_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->access_groups->remove_user( - acs_access_group_id: "44444444-4444-4444-4444-444444444444", - acs_user_id: "33333333-3333-3333-3333-333333333333" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import accessgroups "github.com/seamapi/go/accessgroups" - -func main() { - client.Acs.AccessGroups.RemoveUser( - context.Background(), - accessgroups.AccessGroupsRemoveUserRequest{ - AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_access_group_id` - -Type: `string` +**`acs_access_group_id`** *string* Required: Yes ID of the desired access group. --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired user. diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 1093dcebb..462c5b399 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -6,6 +6,7 @@ Assigns a specified [credential](../../../capability-guides/access-systems/manag ``` PATCH /acs/credentials/assign ⇒ void ``` +{% endhint %}
@@ -15,136 +16,17 @@ PATCH /acs/credentials/assign ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.credentials.assign({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.credentials.assign( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_credential_id="66666666-6666-6666-6666-666666666666", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.credentials.assign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->credentials->assign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Assign( - context.Background(), - credentials.CredentialsAssignRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: Yes ID of the desired credential. --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired user. diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index a3da70180..27ac8ee2a 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -6,6 +6,7 @@ Creates a new [credential](../../../capability-guides/access-systems/managing-cr ``` POST /acs/credentials/create ⇒ { acs_credential } ``` +{% endhint %}
@@ -15,306 +16,80 @@ POST /acs/credentials/create ⇒ { acs_credential } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.credentials.create({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "mobile_key", - allowed_acs_entrance_ids: [ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z", -}); -``` - -#### Output - -```javascript -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.credentials.create( - acs_user_id="33333333-3333-3333-3333-333333333333", - access_method="mobile_key", - allowed_acs_entrance_ids=[ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - ], - credential_manager_acs_system_id="88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential=true, - starts_at="2024-03-01T10:40:00Z", - ends_at="2024-03-04T10:40:00Z", -) -``` - -#### Output - -```python -AcsCredential( - acs_credential_id="99999999-9999-9999-9999-999999999999", - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Multi Phone Sync Credential", - code=None, - acs_system_id="88888888-8888-8888-8888-888888888888", - access_method="mobile_key", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-12T03:56:22.396Z", - is_multi_phone_sync_credential=true, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.credentials.create( - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "mobile_key", - allowed_acs_entrance_ids: %w[ - 55555555-5555-5555-5555-555555555555 - 55555555-5555-5555-5555-000000000000 - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z", -) -``` - -#### Output - -```ruby -{ - "acs_credential_id" => "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => nil, - "acs_system_id" => "88888888-8888-8888-8888-888888888888", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->credentials->create( - acs_user_id: "33333333-3333-3333-3333-333333333333", - access_method: "mobile_key", - allowed_acs_entrance_ids: [ - "55555555-5555-5555-5555-555555555555", - "55555555-5555-5555-5555-000000000000", - ], - credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", - is_multi_phone_sync_credential: true, - starts_at: "2024-03-01T10:40:00Z", - ends_at: "2024-03-04T10:40:00Z" -); -``` - -#### Output - -```php - "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => null, - "acs_system_id" => "88888888-8888-8888-8888-888888888888", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z" -``` - -#### Output - -```seam_cli -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "88888888-8888-8888-8888-888888888888", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Create( - context.Background(), - credentials.CredentialsCreateRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AccessMethod: api.String("mobile_key"), - AllowedAcsEntranceIds: [2]string{api.String("55555555-5555-5555-5555-555555555555"), api.String("55555555-5555-5555-5555-000000000000")}, - CredentialManagerAcsSystemId: api.String("88888888-8888-8888-8888-888888888888"), - IsMultiPhoneSyncCredential: api.Bool(true), - StartsAt: api.String("2024-03-01T10:40:00Z"), - EndsAt: api.String("2024-03-04T10:40:00Z"), - }, - ) -} -``` - -#### Output - -```go -api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `access_method` - -Type: `string` +**`access_method`** *string* Required: Yes Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the ACS user to whom the new credential belongs. --- -### `allowed_acs_entrance_ids` - -Type: `array` -Item format: `UUID` +**`allowed_acs_entrance_ids`** *array* *of UUIDs* Required: No Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. --- -### `assa_abloy_vostio_metadata` - -Type: `object` +**`assa_abloy_vostio_metadata`** *object* Required: No Vostio-specific metadata for the new credential. --- -### `code` - -Type: `string` +**`code`** *string* Required: No Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). --- -### `credential_manager_acs_system_id` - -Type: `string` +**`credential_manager_acs_system_id`** *string* Required: No ACS system ID of the credential manager for the new credential. --- -### `ends_at` - -Type: `string` +**`ends_at`** *string* Required: No Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- -### `is_multi_phone_sync_credential` - -Type: `boolean` +**`is_multi_phone_sync_credential`** *boolean* Required: No Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- -### `salto_space_metadata` - -Type: `object` +**`salto_space_metadata`** *object* Required: No Salto Space-specific metadata for the new credential. --- -### `starts_at` - -Type: `string` +**`starts_at`** *string* Required: No Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -### `visionline_metadata` - -Type: `object` +**`visionline_metadata`** *object* Required: No Visionline-specific metadata for the new credential. diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index b45fc59f2..ad4becd15 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -6,6 +6,7 @@ Deletes a specified [credential](../../../capability-guides/access-systems/manag ``` POST /acs/credentials/delete ⇒ void ``` +{% endhint %}
@@ -15,118 +16,10 @@ POST /acs/credentials/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.credentials.delete({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666") -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666") -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->credentials->delete( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Delete( - context.Background(), - credentials.CredentialsDeleteRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: Yes ID of the desired credential. diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index e3d7cbfc2..fd72f40dd 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -6,6 +6,7 @@ Returns a specified [credential](../../../capability-guides/access-systems/manag ``` POST /acs/credentials/get ⇒ { acs_credential } ``` +{% endhint %}
@@ -15,169 +16,10 @@ POST /acs/credentials/get ⇒ { acs_credential } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.credentials.get({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Output - -```javascript -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666") -``` - -#### Output - -```python -AcsCredential( - acs_credential_id="99999999-9999-9999-9999-999999999999", - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Multi Phone Sync Credential", - code=None, - acs_system_id="11111111-1111-1111-1111-111111111111", - access_method="mobile_key", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-12T03:56:22.396Z", - is_multi_phone_sync_credential=true, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666") -``` - -#### Output - -```ruby -{ - "acs_credential_id" => "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => nil, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->credentials->get( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Output - -```php - "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => null, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Output - -```seam_cli -{ - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Get( - context.Background(), - credentials.CredentialsGetRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Output - -```go -api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: Yes ID of the desired credential. diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 0dfb706a2..af1f1b636 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -6,6 +6,7 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/ma ``` POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ``` +{% endhint %}
@@ -16,243 +17,45 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.credentials.list({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential: true, -}); -``` - -#### Output - -```javascript -[ - { - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.credentials.list( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_system_id="11111111-1111-1111-1111-111111111111", - user_identity_id="22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential=true, -) -``` - -#### Output - -```python -[ - AcsCredential( - acs_credential_id="99999999-9999-9999-9999-999999999999", - acs_user_id="33333333-3333-3333-3333-333333333333", - display_name="Multi Phone Sync Credential", - code=None, - acs_system_id="11111111-1111-1111-1111-111111111111", - access_method="mobile_key", - workspace_id="00000000-0000-0000-0000-000000000000", - created_at="2024-04-12T03:56:22.396Z", - is_multi_phone_sync_credential=true, - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.credentials.list( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential: true, -) -``` - -#### Output - -```ruby -[ - { - "acs_credential_id" => "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => nil, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->credentials->list( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_system_id: "11111111-1111-1111-1111-111111111111", - user_identity_id: "22222222-2222-2222-2222-222222222222", - is_multi_phone_sync_credential: true -); -``` - -#### Output - -```php - "99999999-9999-9999-9999-999999999999", - "acs_user_id" => "33333333-3333-3333-3333-333333333333", - "display_name" => "Multi Phone Sync Credential", - "code" => null, - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "access_method" => "mobile_key", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "created_at" => "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential" => true, - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true -``` - -#### Output - -```seam_cli -[ - { - "acs_credential_id": "99999999-9999-9999-9999-999999999999", - "acs_user_id": "33333333-3333-3333-3333-333333333333", - "display_name": "Multi Phone Sync Credential", - "code": null, - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "access_method": "mobile_key", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "created_at": "2024-04-12T03:56:22.396Z", - "is_multi_phone_sync_credential": true - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.List( - context.Background(), - credentials.CredentialsListRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), - UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"), - IsMultiPhoneSyncCredential: api.Bool(true), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_system_id` - -Type: `string` +**`acs_system_id`** *string* Required: No ID of the access control system for which you want to retrieve all credentials. --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: No ID of the ACS user for which you want to retrieve all credentials. --- -### `created_before` - -Type: `string` +**`created_before`** *string* Required: No Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. --- -### `is_multi_phone_sync_credential` - -Type: `boolean` +**`is_multi_phone_sync_credential`** *boolean* Required: No Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. --- -### `limit` - -Type: `number` +**`limit`** *number* Required: No Number of credentials to return. --- -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: No ID of the user identity for which you want to retrieve all credentials. diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 1e07dc0b6..000055b58 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -6,6 +6,7 @@ Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) ``` POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endhint %}
@@ -15,213 +16,10 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.credentials.listAccessibleEntrances({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Output - -```javascript -[ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.credentials.list_accessible_entrances( - acs_credential_id="66666666-6666-6666-6666-666666666666" -) -``` - -#### Output - -```python -[ - AcsEntrance( - acs_entrance_id="55555555-5555-5555-5555-555555555555", - acs_system_id="11111111-1111-1111-1111-111111111111", - workspace_id="00000000-0000-0000-0000-000000000000", - visionline_metadata={ - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE", - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest", - }, - latch_metadata=None, - display_name="Guest Lock 2", - created_at="2024-03-26T14:31:18.979Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.credentials.list_accessible_entrances( - acs_credential_id: "66666666-6666-6666-6666-666666666666", -) -``` - -#### Output - -```ruby -[ - { - "acs_entrance_id" => "55555555-5555-5555-5555-555555555555", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "visionline_metadata" => { - profiles: [{ visionline_door_profile_id: "Guest Door", visionline_door_profile_type: "BLE" }], - door_name: "Guest Lock 2", - door_category: "guest", - }, - "latch_metadata" => nil, - "display_name" => "Guest Lock 2", - "created_at" => "2024-03-26T14:31:18.979Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->credentials->list_accessible_entrances( - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Output - -```php - "55555555-5555-5555-5555-555555555555", - "acs_system_id" => "11111111-1111-1111-1111-111111111111", - "workspace_id" => "00000000-0000-0000-0000-000000000000", - "visionline_metadata" => [ - "profiles" => [ - [ - "visionline_door_profile_id" => "Guest Door", - "visionline_door_profile_type" => "BLE", - ], - ], - "door_name" => "Guest Lock 2", - "door_category" => "guest", - ], - "latch_metadata" => null, - "display_name" => "Guest Lock 2", - "created_at" => "2024-03-26T14:31:18.979Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Output - -```seam_cli -[ - { - "acs_entrance_id": "55555555-5555-5555-5555-555555555555", - "acs_system_id": "11111111-1111-1111-1111-111111111111", - "workspace_id": "00000000-0000-0000-0000-000000000000", - "visionline_metadata": { - "profiles": [ - { - "visionline_door_profile_id": "Guest Door", - "visionline_door_profile_type": "BLE" - } - ], - "door_name": "Guest Lock 2", - "door_category": "guest" - }, - "latch_metadata": null, - "display_name": "Guest Lock 2", - "created_at": "2024-03-26T14:31:18.979Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.ListAccessibleEntrances( - context.Background(), - credentials.CredentialsListAccessibleEntrancesRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: Yes ID of the credential for which you want to retrieve all entrances to which this credential grants access. diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 2eb528752..7097b79d6 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -6,6 +6,7 @@ Unassigns a specified [credential](../../../capability-guides/access-systems/man ``` PATCH /acs/credentials/unassign ⇒ void ``` +{% endhint %}
@@ -15,136 +16,17 @@ PATCH /acs/credentials/unassign ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.credentials.unassign({ - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.credentials.unassign( - acs_user_id="33333333-3333-3333-3333-333333333333", - acs_credential_id="66666666-6666-6666-6666-666666666666", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.credentials.unassign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->credentials->unassign( - acs_user_id: "33333333-3333-3333-3333-333333333333", - acs_credential_id: "66666666-6666-6666-6666-666666666666" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Unassign( - context.Background(), - credentials.CredentialsUnassignRequest{ - AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: Yes ID of the desired credential. --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired user. diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index bc5568ed7..38faed8fa 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -6,6 +6,7 @@ Updates the code and ends at date and time for a specified [credential](../../.. ``` PATCH /acs/credentials/update ⇒ void ``` +{% endhint %}
@@ -15,141 +16,24 @@ PATCH /acs/credentials/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.credentials.update({ - acs_credential_id: "66666666-6666-6666-6666-666666666666", - code: "7890", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.credentials.update( - acs_credential_id="66666666-6666-6666-6666-666666666666", code="7890" -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890") -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->credentials->update( - acs_credential_id: "66666666-6666-6666-6666-666666666666", - code: "7890" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import credentials "github.com/seamapi/go/credentials" - -func main() { - client.Acs.Credentials.Update( - context.Background(), - credentials.CredentialsUpdateRequest{ - AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), - Code: api.String("7890"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: Yes ID of the desired credential. --- -### `code` - -Type: `string` +**`code`** *string* Required: No Replacement access (PIN) code for the credential. --- -### `ends_at` - -Type: `string` +**`ends_at`** *string* Required: No Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 2cbc7462b..f390a7501 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -6,6 +6,7 @@ Encodes an existing [credential](../../../capability-guides/access-systems/manag ``` POST /acs/encoders/encode_credential ⇒ { action_attempt } ``` +{% endhint %}
@@ -15,23 +16,17 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: Yes ID of the `acs_credential` to encode onto a card. --- -### `acs_encoder_id` - -Type: `string` +**`acs_encoder_id`** *string* Required: Yes ID of the `acs_encoder` to use to encode the `acs_credential`. diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 89250ee24..ea6dde14e 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -6,6 +6,7 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/worki ``` POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ``` +{% endhint %}
@@ -15,43 +16,31 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_encoder_ids` - -Type: `array` -Item format: `UUID` +**`acs_encoder_ids`** *array* *of UUIDs* Required: No IDs of the `acs_encoder`s that you want to retrieve. --- -### `acs_system_id` - -Type: `string` +**`acs_system_id`** *string* Required: No ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. --- -### `acs_system_ids` - -Type: `array` -Item format: `UUID` +**`acs_system_ids`** *array* *of UUIDs* Required: No IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. --- -### `limit` - -Type: `number` +**`limit`** *number* Required: No Number of `acs_encoders` to return. diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index ed33e632e..83c73c6be 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -6,6 +6,7 @@ Scans an encoded [acs_credential](../../../capability-guides/access-systems/mana ``` POST /acs/encoders/scan_credential ⇒ { action_attempt } ``` +{% endhint %}
@@ -15,14 +16,10 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_encoder_id` - -Type: `string` +**`acs_encoder_id`** *string* Required: Yes ID of the `acs_encoder` to use for the scan. diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 8e0c593a8..557ef5b3a 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -6,6 +6,7 @@ Simulates that the next attempt to encode a [credential](../../../../capability- ``` POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ``` +{% endhint %}
@@ -15,32 +16,24 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_encoder_id` - -Type: `string` +**`acs_encoder_id`** *string* Required: Yes ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: No ID of the `acs_credential` that will fail to be encoded onto a card in the next request. --- -### `error_code` - -Type: `string` +**`error_code`** *string* Required: No Code of the error to simulate. diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 54ca990e4..b407d7c6a 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -6,6 +6,7 @@ Simulates that the next attempt to encode a [credential](../../../../capability- ``` POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ``` +{% endhint %}
@@ -15,23 +16,17 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_encoder_id` - -Type: `string` +**`acs_encoder_id`** *string* Required: Yes ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- -### `scenario` - -Type: `string` +**`scenario`** *string* Required: No Scenario to simulate. diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 3c60f669a..16c3ace58 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -6,6 +6,7 @@ Simulates that the next attempt to scan a [credential](../../../../capability-gu ``` POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ``` +{% endhint %}
@@ -15,30 +16,22 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_encoder_id` - -Type: `string` +**`acs_encoder_id`** *string* Required: Yes ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. --- -### `acs_credential_id_on_seam` - -Type: `string` +**`acs_credential_id_on_seam`** *string* Required: No --- -### `error_code` - -Type: `string` +**`error_code`** *string* Required: No --- diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 4fb607782..a7157602a 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -6,6 +6,7 @@ Simulates that the next attempt to scan a [credential](../../../../capability-gu ``` POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ``` +{% endhint %}
@@ -15,32 +16,24 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_encoder_id` - -Type: `string` +**`acs_encoder_id`** *string* Required: Yes ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. --- -### `acs_credential_id_on_seam` - -Type: `string` +**`acs_credential_id_on_seam`** *string* Required: No ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. --- -### `scenario` - -Type: `string` +**`scenario`** *string* Required: No Scenario to simulate. diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index f4c598666..6c9178265 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -6,6 +6,7 @@ Returns a specified [ACS entrance](../../../capability-guides/access-systems/ret ``` POST /acs/entrances/get ⇒ { acs_entrance } ``` +{% endhint %}
@@ -14,144 +15,10 @@ POST /acs/entrances/get ⇒ { acs_entrance } - API key - Client session token
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.entrances.get({ - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Output - -```javascript -{ - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Output - -```python -AcsEntrance( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="text", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Output - -```ruby -{ - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->entrances->get( - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Output - -```seam_cli -{ - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import entrances "github.com/seamapi/go/entrances" - -func main() { - client.Acs.Entrances.Get( - context.Background(), - entrances.EntrancesGetRequest{ - AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Output - -```go -api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_entrance_id` - -Type: `string` +**`acs_entrance_id`** *string* Required: Yes --- diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 6d6d64d64..4b456fe98 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -6,6 +6,7 @@ ``` POST /acs/entrances/grant_access ⇒ void ``` +{% endhint %}
@@ -15,21 +16,15 @@ POST /acs/entrances/grant_access ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_entrance_id` - -Type: `string` +**`acs_entrance_id`** *string* Required: Yes --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 4f301e5bc..fe3c83bd5 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -6,6 +6,7 @@ Returns a list of all [ACS entrances](../../../capability-guides/access-systems/ ``` POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endhint %}
@@ -16,149 +17,15 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.entrances.list(); -``` - -#### Output - -```javascript -[ - { - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.entrances.list() -``` - -#### Output - -```python -[ - AcsEntrance( - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="text", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.entrances.list() -``` - -#### Output - -```ruby -[ - { - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->entrances->list(); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "text", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs entrances list -``` - -#### Output - -```seam_cli -[ - { - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "text" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -func main() { - client.Acs.Entrances.List(context.Background()) -} -``` - -#### Output - -```go -[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: No --- -### `acs_system_id` - -Type: `string` +**`acs_system_id`** *string* Required: No --- diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 9f114fc0c..fbb964a8d 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -6,6 +6,7 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/ma ``` POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_credential, …] } ``` +{% endhint %}
@@ -16,251 +17,23 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.entrances.listCredentialsWithAccess({ - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Output - -```javascript -[ - { - "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "display_name": "text", - "code": "text", - "card_number": "text", - "is_issued": false, - "issued_at": "2024-10-15T12:54:04.155Z", - "access_method": "code", - "external_type": "pti_card", - "external_type_display_name": "text", - "created_at": "2024-10-15T12:54:04.155Z", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "starts_at": "text", - "ends_at": "text", - "is_multi_phone_sync_credential": false, - "is_latest_desired_state_synced_with_provider": false, - "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.entrances.list_credentials_with_access( - acs_entrance_id="123e4567-e89b-12d3-a456-426614174000" -) -``` - -#### Output - -```python -[ - AcsCredential( - acs_credential_id="123e4567-e89b-12d3-a456-426614174000", - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_credential_pool_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - parent_acs_credential_id="123e4567-e89b-12d3-a456-426614174000", - display_name="text", - code="text", - card_number="text", - is_issued=false, - issued_at="2024-10-15T12:54:04.155Z", - access_method="code", - external_type="pti_card", - external_type_display_name="text", - created_at="2024-10-15T12:54:04.155Z", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - starts_at="text", - ends_at="text", - is_multi_phone_sync_credential=false, - is_latest_desired_state_synced_with_provider=false, - latest_desired_state_synced_with_provider_at="2024-10-15T12:54:04.155Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.entrances.list_credentials_with_access( - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Output - -```ruby -[ - { - "acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", - "display_name" => "text", - "code" => "text", - "card_number" => "text", - "is_issued" => false, - "issued_at" => "2024-10-15T12:54:04.155Z", - "access_method" => "code", - "external_type" => "pti_card", - "external_type_display_name" => "text", - "created_at" => "2024-10-15T12:54:04.155Z", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "starts_at" => "text", - "ends_at" => "text", - "is_multi_phone_sync_credential" => false, - "is_latest_desired_state_synced_with_provider" => false, - "latest_desired_state_synced_with_provider_at" => "2024-10-15T12:54:04.155Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->entrances->list_credentials_with_access( - acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", - "display_name" => "text", - "code" => "text", - "card_number" => "text", - "is_issued" => false, - "issued_at" => "2024-10-15T12:54:04.155Z", - "access_method" => "code", - "external_type" => "pti_card", - "external_type_display_name" => "text", - "created_at" => "2024-10-15T12:54:04.155Z", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "starts_at" => "text", - "ends_at" => "text", - "is_multi_phone_sync_credential" => false, - "is_latest_desired_state_synced_with_provider" => false, - "latest_desired_state_synced_with_provider_at" => - "2024-10-15T12:54:04.155Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Output - -```seam_cli -[ - { - "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", - "display_name": "text", - "code": "text", - "card_number": "text", - "is_issued": false, - "issued_at": "2024-10-15T12:54:04.155Z", - "access_method": "code", - "external_type": "pti_card", - "external_type_display_name": "text", - "created_at": "2024-10-15T12:54:04.155Z", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "starts_at": "text", - "ends_at": "text", - "is_multi_phone_sync_credential": false, - "is_latest_desired_state_synced_with_provider": false, - "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import entrances "github.com/seamapi/go/entrances" - -func main() { - client.Acs.Entrances.ListCredentialsWithAccess( - context.Background(), - entrances.EntrancesListCredentialsWithAccessRequest{ - AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_entrance_id` - -Type: `string` +**`acs_entrance_id`** *string* Required: Yes --- -### `include_if` - -Type: `array` -Item format: `Enum` +**`include_if`** *array* *of Enums* Required: No +
+ +Enum values Possible enum values: - `visionline_metadata.is_valid` +
--- diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 3075bfacf..83ac96fc6 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -8,6 +8,7 @@ Specify the desired access control system by including the corresponding `acs_sy ``` POST /acs/systems/get ⇒ { acs_system } ``` +{% endhint %}
@@ -17,117 +18,10 @@ POST /acs/systems/get ⇒ { acs_system } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.systems.get({ - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Output - -```javascript -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```python -[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```ruby -[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Output - -```php - "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Output - -```seam_cli -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import systems "github.com/seamapi/go/systems" - -func main() { - client.Acs.Systems.Get( - context.Background(), - systems.SystemsGetRequest{ - AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_system_id` - -Type: `string` +**`acs_system_id`** *string* Required: Yes ID of the desired access control system. diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 2cc8fa892..9d022fad5 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -8,6 +8,7 @@ To filter the list of returned access control systems by a specific connected ac ``` POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ``` +{% endhint %}
@@ -18,119 +19,10 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.systems.list({ - connected_account_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Output - -```javascript -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Output - -```python -[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Output - -```ruby -[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->systems->list( - connected_account_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Output - -```php - "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Output - -```seam_cli -[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import systems "github.com/seamapi/go/systems" - -func main() { - client.Acs.Systems.List( - context.Background(), - systems.SystemsListRequest{ - ConnectedAccountId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `connected_account_id` - -Type: `string` +**`connected_account_id`** *string* Required: No ID of the connected account by which to filter the list of returned access control systems. diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index ddb49e74b..a0d36eb27 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -10,6 +10,7 @@ systems by including the corresponding `acs_system_id` in the request body. ``` POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` +{% endhint %}
@@ -19,123 +20,10 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Output - -```javascript -[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.systems.list_compatible_credential_manager_acs_systems( - acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33" -) -``` - -#### Output - -```python -[AcsSystem(acs_system_id="aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4")] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.systems.list_compatible_credential_manager_acs_systems( - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -) -``` - -#### Output - -```ruby -[{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->systems->list_compatible_credential_manager_acs_systems( - acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -); -``` - -#### Output - -```php - "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"]]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Output - -```seam_cli -[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import systems "github.com/seamapi/go/systems" - -func main() { - client.Acs.Systems.ListCompatibleCredentialManagerAcsSystems( - context.Background(), - systems.SystemsListCompatibleCredentialManagerAcsSystemsRequest{ - AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_system_id` - -Type: `string` +**`acs_system_id`** *string* Required: Yes ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 845acd0ae..a0acab3e9 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -6,6 +6,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access ``` PUT /acs/users/add_to_access_group ⇒ void ``` +{% endhint %}
@@ -15,136 +16,17 @@ PUT /acs/users/add_to_access_group ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.users.addToAccessGroup({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.users.add_to_access_group( - acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.users.add_to_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->users->add_to_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.AddToAccessGroup( - context.Background(), - users.UsersAddToAccessGroupRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_access_group_id` - -Type: `string` +**`acs_access_group_id`** *string* Required: Yes ID of the desired access group. --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired `acs_user`. diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index d183d5450..f0ad91aa9 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -6,6 +6,7 @@ Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-sy ``` POST /acs/users/create ⇒ { acs_user } ``` +{% endhint %}
@@ -15,7 +16,75 @@ POST /acs/users/create ⇒ { acs_user } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} + +## Request Parameters + +**`acs_system_id`** *string* +Required: Yes + +ID of the `acs_system` to which to add the new `acs_user`. + +--- + +**`full_name`** *string* +Required: Yes + +Full name of the new `acs_user`. + +--- + +**`access_schedule`** *object* +Required: No + +`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. + +--- + +**`acs_access_group_ids`** *array* *of UUIDs* +Required: No + +Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. + +--- + +**`email`** *string* +Required: No + +--- + +**`email_address`** *string* +Required: No + +Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +--- + +**`phone_number`** *string* +Required: No + +Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). + +--- + +**`user_identity_id`** *string* +Required: No + +ID of the user identity with which to associate the new `acs_user`. + +--- + + +## Return Type + +[acs\_user](./) + +--- + +## Examples + +### Create a new ACS user + +Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% tabs %} {% tab title="JavaScript" %} @@ -187,88 +256,6 @@ api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123 {% endtabs %} -## Request Parameters - -### `acs_system_id` - -Type: `string` -Required: Yes - -ID of the `acs_system` to which to add the new `acs_user`. - ---- - -### `full_name` - -Type: `string` -Required: Yes - -Full name of the new `acs_user`. - ---- - -### `access_schedule` - -Type: `object` -Required: No - -`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. - ---- - -### `acs_access_group_ids` - -Type: `array` -Item format: `UUID` -Required: No - -Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. - ---- - -### `email` - -Type: `string` -Required: No - ---- - -### `email_address` - -Type: `string` -Required: No - -Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ---- - -### `phone_number` - -Type: `string` -Required: No - -Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). - ---- - -### `user_identity_id` - -Type: `string` -Required: No - -ID of the user identity with which to associate the new `acs_user`. - ---- - - -## Return Type - -[acs\_user](./) - ---- - -## Code Samples - ### Create a new ACS user Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with an access schedule. diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 6ab9e02fd..59fcbfeeb 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -6,6 +6,7 @@ Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc ``` POST /acs/users/delete ⇒ void ``` +{% endhint %}
@@ -15,116 +16,10 @@ POST /acs/users/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.users.delete({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Delete( - context.Background(), - users.UsersDeleteRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired `acs_user`. diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index e0840b283..3adc8bf01 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -6,6 +6,7 @@ Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc ``` POST /acs/users/get ⇒ { acs_user } ``` +{% endhint %}
@@ -15,162 +16,10 @@ POST /acs/users/get ⇒ { acs_user } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.users.get({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Output - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Output - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Get( - context.Background(), - users.UsersGetRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Output - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired `acs_user`. diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index c38bb4144..57f5b55e4 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -6,6 +6,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ ``` POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ``` +{% endhint %}
@@ -16,213 +17,57 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.users.list(); -``` - -#### Output - -```javascript -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.users.list() -``` - -#### Output - -```python -AcsUser( - acs_user_id="123e4567-e89b-12d3-a456-426614174000", - acs_system_id="123e4567-e89b-12d3-a456-426614174000", - workspace_id="123e4567-e89b-12d3-a456-426614174000", - created_at="2024-04-05T07:57:05.323Z", - display_name="Jane Doe", - full_name="Jane Doe", - email_address="jane@example.com", - phone_number="+15555550100", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.users.list() -``` - -#### Output - -```ruby -{ - "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->users->list(); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - "display_name" => "Jane Doe", - "full_name" => "Jane Doe", - "email_address" => "jane@example.com", - "phone_number" => "+15555550100", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs users list -``` - -#### Output - -```seam_cli -{ - "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", - "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - "display_name": "Jane Doe", - "full_name": "Jane Doe", - "email_address": "jane@example.com", - "phone_number": "+15555550100" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -func main() { - client.Acs.Users.List(context.Background()) -} -``` - -#### Output - -```go -api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_system_id` - -Type: `string` +**`acs_system_id`** *string* Required: No ID of the `acs_system` for which you want to retrieve all `acs_user`s. --- -### `created_before` - -Type: `string` +**`created_before`** *string* Required: No --- -### `limit` - -Type: `number` +**`limit`** *number* Required: No Maximum number of records to return per page. --- -### `page_cursor` - -Type: `string` +**`page_cursor`** *string* Required: No Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. --- -### `search` - -Type: `string` +**`search`** *string* Required: No String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, or `email_address`. --- -### `user_identity_email_address` - -Type: `string` +**`user_identity_email_address`** *string* Required: No Email address of the user identity for which you want to retrieve all `acs_user`s. --- -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: No ID of the user identity for which you want to retrieve all `acs_user`s. --- -### `user_identity_phone_number` - -Type: `string` +**`user_identity_phone_number`** *string* Required: No Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 5133b835d..570a71665 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -6,6 +6,7 @@ Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a ``` POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` +{% endhint %}
@@ -16,14 +17,10 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired `acs_user`. diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 9aa0586d4..f91ea5acd 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -6,6 +6,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc ``` POST /acs/users/remove_from_access_group ⇒ void ``` +{% endhint %}
@@ -15,136 +16,17 @@ POST /acs/users/remove_from_access_group ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.users.removeFromAccessGroup({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.users.remove_from_access_group( - acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.users.remove_from_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->users->remove_from_access_group( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.RemoveFromAccessGroup( - context.Background(), - users.UsersRemoveFromAccessGroupRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_access_group_id` - -Type: `string` +**`acs_access_group_id`** *string* Required: Yes ID of the desired access group. --- -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired `acs_user`. diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 50e5d84a2..8d3067057 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -6,6 +6,7 @@ Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) ``` POST /acs/users/revoke_access_to_all_entrances ⇒ void ``` +{% endhint %}
@@ -15,14 +16,10 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired `acs_user`. diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index ea0acfd6f..37562d54e 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -6,6 +6,7 @@ ``` POST /acs/users/suspend ⇒ void ``` +{% endhint %}
@@ -15,116 +16,10 @@ POST /acs/users/suspend ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.users.suspend({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Suspend( - context.Background(), - users.UsersSuspendRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired `acs_user`. diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 54d80529b..ac43a2f58 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -6,6 +6,7 @@ ``` POST /acs/users/unsuspend ⇒ void ``` +{% endhint %}
@@ -15,118 +16,10 @@ POST /acs/users/unsuspend ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.users.unsuspend({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->users->unsuspend( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Unsuspend( - context.Background(), - users.UsersUnsuspendRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired `acs_user`. diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 8e5492505..f621a9ca4 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -6,6 +6,7 @@ Updates the properties of a specified [ACS user](https://docs.seam.co/latest/cap ``` PATCH /acs/users/update ⇒ void ``` +{% endhint %}
@@ -15,176 +16,48 @@ PATCH /acs/users/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.acs.users.update({ - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - phone_number: "+15555550222", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.acs.users.update( - acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", phone_number="+15555550222" -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.acs.users.update( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - phone_number: "+15555550222", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -acs->users->update( - acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", - phone_number: "+15555550222" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import users "github.com/seamapi/go/users" - -func main() { - client.Acs.Users.Update( - context.Background(), - users.UsersUpdateRequest{ - AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), - PhoneNumber: api.String("+15555550222"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `access_schedule` - -Type: `object` +**`access_schedule`** *object* Required: No `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. --- -### `email` - -Type: `string` +**`email`** *string* Required: No --- -### `email_address` - -Type: `string` +**`email_address`** *string* Required: No Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `full_name` - -Type: `string` +**`full_name`** *string* Required: No Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -### `hid_acs_system_id` - -Type: `string` +**`hid_acs_system_id`** *string* Required: No --- -### `phone_number` - -Type: `string` +**`phone_number`** *string* Required: No Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 21a34280d..30c0914ea 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -6,6 +6,7 @@ Deactivates a phone, which is useful, for example, if a user has lost their phon ``` POST /phones/deactivate ⇒ void ``` +{% endhint %}
@@ -16,14 +17,10 @@ POST /phones/deactivate ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes Device ID of the desired phone. diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 534cd1651..434d94255 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -6,6 +6,7 @@ Returns a single phone entry matching the provided `device_id`. ``` POST /phones/get ⇒ { phone } ``` +{% endhint %}
@@ -15,14 +16,10 @@ POST /phones/get ⇒ { phone } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes Device ID of the desired phone. diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index f2b200458..463e5b2fb 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -6,6 +6,7 @@ Returns a list of all phones. To filter the list of returned phones by a specifi ``` POST /phones/list ⇒ { phones: [phone, …] } ``` +{% endhint %}
@@ -15,23 +16,17 @@ POST /phones/list ⇒ { phones: [phone, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `acs_credential_id` - -Type: `string` +**`acs_credential_id`** *string* Required: No ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. --- -### `owner_user_identity_id` - -Type: `string` +**`owner_user_identity_id`** *string* Required: No ID of the user identity that represents the owner by which to filter the list of returned phones. diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 7cc9ce1ad..14cb8497a 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -6,6 +6,7 @@ Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/wo ``` POST /phones/simulate/create_sandbox_phone ⇒ { phone } ``` +{% endhint %}
@@ -15,41 +16,31 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the user identity to associate with the simulated phone. --- -### `assa_abloy_metadata` - -Type: `object` +**`assa_abloy_metadata`** *object* Required: No ASSA ABLOY metadata to associate with the simulated phone. --- -### `custom_sdk_installation_id` - -Type: `string` +**`custom_sdk_installation_id`** *string* Required: No ID of the custom SDK installation to use for the simulated phone. --- -### `phone_metadata` - -Type: `object` +**`phone_metadata`** *object* Required: No Metadata to associate with the simulated phone. diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index b5756efcb..8abdf8c64 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -6,6 +6,7 @@ Activates a specified [climate preset](../../capability-guides/thermostats/creat ``` POST /thermostats/activate_climate_preset ⇒ { action_attempt } ``` +{% endhint %}
@@ -15,155 +16,17 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.activateClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -}); -``` - -#### Output - -```javascript -{ - "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", - "status": "pending", - "action_type": "ACTIVATE_CLIMATE_PRESET" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.activate_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" -) -``` - -#### Output - -```python -ActionAttempt( - action_attempt_id="05de2295-d1dc-4748-aae3-9931658bde20", - status="pending", - action_type="ACTIVATE_CLIMATE_PRESET", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.activate_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -) -``` - -#### Output - -```ruby -{ - "action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20", - "status" => "pending", - "action_type" => "ACTIVATE_CLIMATE_PRESET", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->activate_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied" -); -``` - -#### Output - -```php - "05de2295-d1dc-4748-aae3-9931658bde20", - "status" => "pending", - "action_type" => "ACTIVATE_CLIMATE_PRESET", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" -``` - -#### Output - -```seam_cli -{ - "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", - "status": "pending", - "action_type": "ACTIVATE_CLIMATE_PRESET" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.ActivateClimatePreset( - context.Background(), - api.ThermostatsActivateClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - }, - ) -} -``` - -#### Output - -```go -api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `climate_preset_key` - -Type: `string` +**`climate_preset_key`** *string* Required: Yes Climate preset key of the desired climate preset. --- -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index db4d828e4..d4510c2e4 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -6,6 +6,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther ``` POST /thermostats/cool ⇒ { action_attempt } ``` +{% endhint %}
@@ -16,164 +17,24 @@ POST /thermostats/cool ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.cool({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, -}); -``` - -#### Output - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_COOL" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.cool( - device_id="123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius=25 -) -``` - -#### Output - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_COOL", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, -) -``` - -#### Output - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_COOL", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25 -); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_COOL", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 -``` - -#### Output - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_COOL" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.Cool( - context.Background(), - api.ThermostatsCoolRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - CoolingSetPointCelsius: api.Float64(25), - }, - ) -} -``` - -#### Output - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `cooling_set_point_celsius` - -Type: `number` +**`cooling_set_point_celsius`** *number* Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -### `cooling_set_point_fahrenheit` - -Type: `number` +**`cooling_set_point_fahrenheit`** *number* Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 35acb9648..63d9e0e57 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -6,6 +6,7 @@ Creates a [climate preset](../../capability-guides/thermostats/creating-and-mana ``` POST /thermostats/create_climate_preset ⇒ void ``` +{% endhint %}
@@ -16,237 +17,73 @@ POST /thermostats/create_climate_preset ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.createClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - name: "Occupied", - fan_mode_setting: "auto", - hvac_mode_setting: "heat_cool", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, - manual_override_allowed: true, -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.create_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", - climate_preset_key="occupied", - name="Occupied", - fan_mode_setting="auto", - hvac_mode_setting="heat_cool", - cooling_set_point_celsius=25, - heating_set_point_celsius=20, - manual_override_allowed=true, -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.create_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - name: "Occupied", - fan_mode_setting: "auto", - hvac_mode_setting: "heat_cool", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, - manual_override_allowed: true, -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->create_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - name: "Occupied", - fan_mode_setting: "auto", - hvac_mode_setting: "heat_cool", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, - manual_override_allowed: true -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.CreateClimatePreset( - context.Background(), - api.ThermostatsCreateClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - Name: api.String("Occupied"), - FanModeSetting: api.String("auto"), - HvacModeSetting: api.String("heat_cool"), - CoolingSetPointCelsius: api.Float64(25), - HeatingSetPointCelsius: api.Float64(20), - ManualOverrideAllowed: api.Bool(true), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `climate_preset_key` - -Type: `string` +**`climate_preset_key`** *string* Required: Yes Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `cooling_set_point_celsius` - -Type: `number` +**`cooling_set_point_celsius`** *number* Required: No 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` - -Type: `number` +**`cooling_set_point_fahrenheit`** *number* Required: No Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -### `fan_mode_setting` - -Type: `string` +**`fan_mode_setting`** *string* Required: No 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`. --- -### `heating_set_point_celsius` - -Type: `number` +**`heating_set_point_celsius`** *number* Required: No 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` - -Type: `number` +**`heating_set_point_fahrenheit`** *number* Required: No 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` - -Type: `string` +**`hvac_mode_setting`** *string* Required: No Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- -### `manual_override_allowed` - -Type: `boolean` +**`manual_override_allowed`** *boolean* Required: No Indicates whether a person at the thermostat or using the API can change the thermostat's settings. --- -### `name` - -Type: `string` +**`name`** *string* Required: No User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 0ed380cd7..4bb5f2075 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -6,6 +6,7 @@ Deletes a specified [climate preset](../../capability-guides/thermostats/creatin ``` POST /thermostats/delete_climate_preset ⇒ void ``` +{% endhint %}
@@ -16,134 +17,17 @@ POST /thermostats/delete_climate_preset ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.deleteClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.delete_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.delete_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->delete_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.DeleteClimatePreset( - context.Background(), - api.ThermostatsDeleteClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `climate_preset_key` - -Type: `string` +**`climate_preset_key`** *string* Required: Yes Climate preset key of the desired climate preset. --- -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 72f8da487..140b86d1f 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -6,6 +6,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther ``` POST /thermostats/heat ⇒ { action_attempt } ``` +{% endhint %}
@@ -16,164 +17,24 @@ POST /thermostats/heat ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.heat({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - heating_set_point_celsius: 20, -}); -``` - -#### Output - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.heat( - device_id="123e4567-e89b-12d3-a456-426614174000", heating_set_point_celsius=20 -) -``` - -#### Output - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_HEAT", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.heat( - device_id: "123e4567-e89b-12d3-a456-426614174000", - heating_set_point_celsius: 20, -) -``` - -#### Output - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->heat( - device_id: "123e4567-e89b-12d3-a456-426614174000", - heating_set_point_celsius: 20 -); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20 -``` - -#### Output - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.Heat( - context.Background(), - api.ThermostatsHeatRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - HeatingSetPointCelsius: api.Float64(20), - }, - ) -} -``` - -#### Output - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `heating_set_point_celsius` - -Type: `number` +**`heating_set_point_celsius`** *number* Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -### `heating_set_point_fahrenheit` - -Type: `number` +**`heating_set_point_fahrenheit`** *number* Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 638ca12ad..5eb536860 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -6,6 +6,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther ``` POST /thermostats/heat_cool ⇒ { action_attempt } ``` +{% endhint %}
@@ -16,188 +17,38 @@ POST /thermostats/heat_cool ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.heatCool({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, -}); -``` - -#### Output - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT_COOL" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.heat_cool( - device_id="123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius=25, - heating_set_point_celsius=20, -) -``` - -#### Output - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_HEAT_COOL", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.heat_cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20, -) -``` - -#### Output - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT_COOL", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->heat_cool( - device_id: "123e4567-e89b-12d3-a456-426614174000", - cooling_set_point_celsius: 25, - heating_set_point_celsius: 20 -); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_HEAT_COOL", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 -``` - -#### Output - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_HEAT_COOL" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.HeatCool( - context.Background(), - api.ThermostatsHeatCoolRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - CoolingSetPointCelsius: api.Float64(25), - HeatingSetPointCelsius: api.Float64(20), - }, - ) -} -``` - -#### Output - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `cooling_set_point_celsius` - -Type: `number` +**`cooling_set_point_celsius`** *number* Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -### `cooling_set_point_fahrenheit` - -Type: `number` +**`cooling_set_point_fahrenheit`** *number* Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- -### `heating_set_point_celsius` - -Type: `number` +**`heating_set_point_celsius`** *number* Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -### `heating_set_point_fahrenheit` - -Type: `number` +**`heating_set_point_fahrenheit`** *number* Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 9a8860507..c196e52e0 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -6,6 +6,7 @@ Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guide ``` POST /thermostats/list ⇒ { devices: [device, …] } ``` +{% endhint %}
@@ -16,296 +17,65 @@ POST /thermostats/list ⇒ { devices: [device, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.list(); -``` - -#### Output - -```javascript -[ - { - "device_id": "123e4567-e89b-12d3-a456-426614174000", - "device_type": "ecobee_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "name": "Entryway", - "online": "true,", - "relative_humidity": 0.36, - "temperature_farenheit": 70, - "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "cooling_set_point_farenheit": 75, - "heating_set_point_farenheit": 65, - "manual_override_allowed": false - }, - "location": null, - "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z" - } - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.list() -``` - -#### Output - -```python -[ - Device( - device_id="123e4567-e89b-12d3-a456-426614174000", - device_type="ecobee_thermostat", - capabilities_supported=["thermostat"], - properties={ - "name": "Entryway", - "online": "true,", - "relative_humidity": 0.36, - "temperature_farenheit": 70, - "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "cooling_set_point_farenheit": 75, - "heating_set_point_farenheit": 65, - "manual_override_allowed": false, - }, - "location": null, - "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z", - }, - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.list() -``` - -#### Output - -```ruby -[ - { - "device_id" => "123e4567-e89b-12d3-a456-426614174000", - "device_type" => "ecobee_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => { - name: "Entryway", - online: "true,", - relative_humidity: 0.36, - temperature_farenheit: 70, - available_hvac_mode_settings: %w[cool heat heat_cool off], - current_climate_setting: { - hvac_mode_setting: "heat_cool", - cooling_set_point_farenheit: 75, - heating_set_point_farenheit: 65, - manual_override_allowed: false, - }, - location: null, - connected_account_id: "123e4567-e89b-12d3-a456-426614174000", - workspace_id: "123e4567-e89b-12d3-a456-426614174000", - created_at: "2024-04-05T07:57:05.323Z", - }, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->list(); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "device_type" => "ecobee_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => [ - "name" => "Entryway", - "online" => "true,", - "relative_humidity" => 0.36, - "temperature_farenheit" => 70, - "available_hvac_mode_settings" => [ - "cool", - "heat", - "heat_cool", - "off", - ], - "current_climate_setting" => [ - "hvac_mode_setting" => "heat_cool", - "cooling_set_point_farenheit" => 75, - "heating_set_point_farenheit" => 65, - "manual_override_allowed" => false, - ], - "location" => null, - "connected_account_id" => "123e4567-e89b-12d3-a456-426614174000", - "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", - "created_at" => "2024-04-05T07:57:05.323Z", - ], - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats list -``` - -#### Output - -```seam_cli -[ - { - "device_id": "123e4567-e89b-12d3-a456-426614174000", - "device_type": "ecobee_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "name": "Entryway", - "online": "true,", - "relative_humidity": 0.36, - "temperature_farenheit": 70, - "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "cooling_set_point_farenheit": 75, - "heating_set_point_farenheit": 65, - "manual_override_allowed": false - }, - "location": null, - "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", - "workspace_id": "123e4567-e89b-12d3-a456-426614174000", - "created_at": "2024-04-05T07:57:05.323Z" - } - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -func main() { - client.Thermostats.List(context.Background()) -} -``` - -#### Output - -```go -[]api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `connect_webview_id` - -Type: `string` +**`connect_webview_id`** *string* Required: No ID of the Connect Webview by which to filter devices. --- -### `connected_account_id` - -Type: `string` +**`connected_account_id`** *string* Required: No ID of the connected account by which to filter. --- -### `connected_account_ids` - -Type: `array` -Item format: `UUID` +**`connected_account_ids`** *array* *of UUIDs* Required: No Array of IDs of the connected accounts by which to filter devices. --- -### `created_before` - -Type: `string` +**`created_before`** *string* Required: No Date threshold for devices to return. If specified, returns only devices created before the specified date. --- -### `custom_metadata_has` - -Type: `object` +**`custom_metadata_has`** *object* Required: No Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. --- -### `device_ids` - -Type: `array` -Item format: `UUID` +**`device_ids`** *array* *of UUIDs* Required: No Array of device IDs by which to filter devices. --- -### `device_type` - -Type: `string` +**`device_type`** *string* Required: No Device type by which to filter devices. --- -### `device_types` - -Type: `array` -Item format: `Enum` +**`device_types`** *array* *of Enums* Required: No Array of device types by which to filter devices. +
+ +Enum values Possible enum values: - `akuvox_lock` @@ -343,30 +113,25 @@ Possible enum values: - `tado_thermostat` - `ios_phone` - `android_phone` +
--- -### `limit` - -Type: `number` +**`limit`** *number* Required: No Numerical limit on the number of devices to return. --- -### `manufacturer` - -Type: `string` +**`manufacturer`** *string* Required: No Manufacturer by which to filter devices. --- -### `user_identifier_key` - -Type: `string` +**`user_identifier_key`** *string* Required: No Your own internal user ID for the user by which to filter devices. diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 4f707dcff..4cbb9fb39 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -6,6 +6,7 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/ther ``` POST /thermostats/off ⇒ { action_attempt } ``` +{% endhint %}
@@ -16,136 +17,10 @@ POST /thermostats/off ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.off({ - device_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Output - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_THERMOSTAT_OFF" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Output - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_THERMOSTAT_OFF", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Output - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_THERMOSTAT_OFF", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_THERMOSTAT_OFF", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Output - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_THERMOSTAT_OFF" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.Off( - context.Background(), - api.ThermostatsOffRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Output - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 198ba8b13..c99fc4769 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -6,6 +6,7 @@ Creates a [thermostat schedule](../../../capability-guides/thermostats/creating- ``` POST /thermostats/schedules/create ⇒ { thermostat_schedule } ``` +{% endhint %}
@@ -16,242 +17,52 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.schedules.create({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - name: "Reservation 1", - climate_preset_key: "occupied", - starts_at: "2024-11-01T15:00:00Z", - ends_at: "2024-11-05T12:00:00Z", - max_override_period_minutes: 90, -}); -``` - -#### Output - -```javascript -{ - "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name": "Reservation 1", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-01T15:00:00.000Z", - "ends_at": "2024-11-05T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.schedules.create( - device_id="123e4567-e89b-12d3-a456-426614174000", - name="Reservation 1", - climate_preset_key="occupied", - starts_at="2024-11-01T15:00:00Z", - ends_at="2024-11-05T12:00:00Z", - max_override_period_minutes=90, -) -``` - -#### Output - -```python -ThermostatSchedule( - thermostat_schedule_id="56d29fcf-0674-4db5-8e03-b2370a77460a", - name="Reservation 1", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-01T15:00:00.000Z", - ends_at="2024-11-05T12:00:00.000Z", - max_override_period_minutes=90, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.schedules.create( - device_id: "123e4567-e89b-12d3-a456-426614174000", - name: "Reservation 1", - climate_preset_key: "occupied", - starts_at: "2024-11-01T15:00:00Z", - ends_at: "2024-11-05T12:00:00Z", - max_override_period_minutes: 90, -) -``` - -#### Output - -```ruby -{ - "thermostat_schedule_id" => "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name" => "Reservation 1", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-01T15:00:00.000Z", - "ends_at" => "2024-11-05T12:00:00.000Z", - "max_override_period_minutes" => 90, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->schedules->create( - device_id: "123e4567-e89b-12d3-a456-426614174000", - name: "Reservation 1", - climate_preset_key: "occupied", - starts_at: "2024-11-01T15:00:00Z", - ends_at: "2024-11-05T12:00:00Z", - max_override_period_minutes: 90 -); -``` - -#### Output - -```php - "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name" => "Reservation 1", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-01T15:00:00.000Z", - "ends_at" => "2024-11-05T12:00:00.000Z", - "max_override_period_minutes" => 90, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90 -``` - -#### Output - -```seam_cli -{ - "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", - "name": "Reservation 1", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-01T15:00:00.000Z", - "ends_at": "2024-11-05T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Create( - context.Background(), - schedules.SchedulesCreateRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - Name: api.String("Reservation 1"), - ClimatePresetKey: api.String("occupied"), - StartsAt: api.String("2024-11-01T15:00:00Z"), - EndsAt: api.String("2024-11-05T12:00:00Z"), - MaxOverridePeriodMinutes: api.Float64(90), - }, - ) -} -``` - -#### Output - -```go -api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `climate_preset_key` - -Type: `string` +**`climate_preset_key`** *string* Required: Yes Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `ends_at` - -Type: `string` +**`ends_at`** *string* Required: Yes Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -### `starts_at` - -Type: `string` +**`starts_at`** *string* Required: Yes Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -### `is_override_allowed` - -Type: `boolean` +**`is_override_allowed`** *boolean* Required: No Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -### `max_override_period_minutes` - -Type: `number` +**`max_override_period_minutes`** *number* Required: No Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -### `name` - -Type: `string` +**`name`** *string* Required: No User-friendly name to identify the thermostat schedule. diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 64d9d659c..b24373440 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -6,6 +6,7 @@ Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating- ``` POST /thermostats/schedules/delete ⇒ void ``` +{% endhint %}
@@ -16,120 +17,10 @@ POST /thermostats/schedules/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.schedules.delete({ - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.schedules.delete( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->schedules->delete( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Delete( - context.Background(), - schedules.SchedulesDeleteRequest{ - ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `thermostat_schedule_id` - -Type: `string` +**`thermostat_schedule_id`** *string* Required: Yes ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index bee713b42..284131cc7 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -6,6 +6,7 @@ Returns a specified [thermostat schedule](../../../capability-guides/thermostats ``` POST /thermostats/schedules/get ⇒ { thermostat_schedule } ``` +{% endhint %}
@@ -16,161 +17,10 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.schedules.get({ - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", -}); -``` - -#### Output - -```javascript -{ - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.schedules.get( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" -) -``` - -#### Output - -```python -ThermostatSchedule( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", - name="Reservation 2", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-10T15:00:00.000Z", - ends_at="2024-11-15T12:00:00.000Z", - max_override_period_minutes=90, -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") -``` - -#### Output - -```ruby -{ - "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->schedules->get( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -); -``` - -#### Output - -```php - "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" -``` - -#### Output - -```seam_cli -{ - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Get( - context.Background(), - schedules.SchedulesGetRequest{ - ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), - }, - ) -} -``` - -#### Output - -```go -api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `thermostat_schedule_id` - -Type: `string` +**`thermostat_schedule_id`** *string* Required: Yes ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index d2de655ba..65cf92ab2 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -6,6 +6,7 @@ Returns a list of all [thermostat schedules](../../../capability-guides/thermost ``` POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedule, …] } ``` +{% endhint %}
@@ -16,223 +17,17 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.schedules.list({ - device_id: "123e4567-e89b-12d3-a456-426614174000", -}); -``` - -#### Output - -```javascript -[ - { - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 - }, - { - "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", - "name": "Reservation 3", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-16T15:00:00.000Z", - "ends_at": "2024-11-18T12:00:00.000Z", - "max_override_period_minutes": 90 - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000") -``` - -#### Output - -```python -[ - ThermostatSchedule( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", - name="Reservation 2", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-10T15:00:00.000Z", - ends_at="2024-11-15T12:00:00.000Z", - max_override_period_minutes=90, - ), - ThermostatSchedule( - thermostat_schedule_id="665553d1-94f9-4e92-9739-06ac6362c959", - name="Reservation 3", - device_id="2d488679-6f07-4810-aed2-e726872c1dd5", - climate_preset_key="occupied", - starts_at="2024-11-16T15:00:00.000Z", - ends_at="2024-11-18T12:00:00.000Z", - max_override_period_minutes=90, - ), -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000") -``` - -#### Output - -```ruby -[ - { - "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, - }, - { - "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", - "name" => "Reservation 3", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-16T15:00:00.000Z", - "ends_at" => "2024-11-18T12:00:00.000Z", - "max_override_period_minutes" => 90, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->schedules->list( - device_id: "123e4567-e89b-12d3-a456-426614174000" -); -``` - -#### Output - -```php - "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name" => "Reservation 2", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-10T15:00:00.000Z", - "ends_at" => "2024-11-15T12:00:00.000Z", - "max_override_period_minutes" => 90, - ], - [ - "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", - "name" => "Reservation 3", - "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key" => "occupied", - "starts_at" => "2024-11-16T15:00:00.000Z", - "ends_at" => "2024-11-18T12:00:00.000Z", - "max_override_period_minutes" => 90, - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000" -``` - -#### Output - -```seam_cli -[ - { - "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - "name": "Reservation 2", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-10T15:00:00.000Z", - "ends_at": "2024-11-15T12:00:00.000Z", - "max_override_period_minutes": 90 - }, - { - "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", - "name": "Reservation 3", - "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", - "climate_preset_key": "occupied", - "starts_at": "2024-11-16T15:00:00.000Z", - "ends_at": "2024-11-18T12:00:00.000Z", - "max_override_period_minutes": 90 - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.List( - context.Background(), - schedules.SchedulesListRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - }, - ) -} -``` - -#### Output - -```go -[]api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `user_identifier_key` - -Type: `string` +**`user_identifier_key`** *string* Required: No User identifier key by which to filter the list of returned thermostat schedules. diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index bada31c7b..1ce3e8382 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -6,6 +6,7 @@ Updates a specified [thermostat schedule](../../../capability-guides/thermostats ``` PATCH /thermostats/schedules/update ⇒ void ``` +{% endhint %}
@@ -16,181 +17,52 @@ PATCH /thermostats/schedules/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.schedules.update({ - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at: "2024-11-15T15:00:00Z", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.schedules.update( - thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at="2024-11-15T15:00:00Z", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.schedules.update( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at: "2024-11-15T15:00:00Z", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->schedules->update( - thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", - ends_at: "2024-11-15T15:00:00Z" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import schedules "github.com/seamapi/go/schedules" - -func main() { - client.Thermostats.Schedules.Update( - context.Background(), - schedules.SchedulesUpdateRequest{ - ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), - EndsAt: api.String("2024-11-15T15:00:00Z"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `thermostat_schedule_id` - -Type: `string` +**`thermostat_schedule_id`** *string* Required: Yes ID of the desired thermostat schedule. --- -### `climate_preset_key` - -Type: `string` +**`climate_preset_key`** *string* Required: No Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- -### `ends_at` - -Type: `string` +**`ends_at`** *string* Required: No Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -### `is_override_allowed` - -Type: `boolean` +**`is_override_allowed`** *boolean* Required: No Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -### `max_override_period_minutes` - -Type: `number` +**`max_override_period_minutes`** *number* Required: No Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -### `name` - -Type: `string` +**`name`** *string* Required: No User-friendly name to identify the thermostat schedule. --- -### `starts_at` - -Type: `string` +**`starts_at`** *string* Required: No Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 2fa76584d..e051a6f75 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -6,6 +6,7 @@ Sets a specified [climate preset](../../capability-guides/thermostats/creating-a ``` POST /thermostats/set_fallback_climate_preset ⇒ void ``` +{% endhint %}
@@ -15,134 +16,17 @@ POST /thermostats/set_fallback_climate_preset ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.setFallbackClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "eco", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.set_fallback_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="eco" -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.set_fallback_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "eco", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->set_fallback_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "eco" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetFallbackClimatePreset( - context.Background(), - api.ThermostatsSetFallbackClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("eco"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `climate_preset_key` - -Type: `string` +**`climate_preset_key`** *string* Required: Yes Climate preset key of the desired climate preset. --- -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index aa17cfa74..c89a1607c 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -6,6 +6,7 @@ Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermo ``` POST /thermostats/set_fan_mode ⇒ { action_attempt } ``` +{% endhint %}
@@ -16,160 +17,20 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.setFanMode({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - fan_mode_setting: "auto", -}); -``` - -#### Output - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_FAN_MODE" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.set_fan_mode( - device_id="123e4567-e89b-12d3-a456-426614174000", fan_mode_setting="auto" -) -``` - -#### Output - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="pending", - action_type="SET_FAN_MODE", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.set_fan_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - fan_mode_setting: "auto", -) -``` - -#### Output - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_FAN_MODE", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->set_fan_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - fan_mode_setting: "auto" -); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "pending", - "action_type" => "SET_FAN_MODE", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto" -``` - -#### Output - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "pending", - "action_type": "SET_FAN_MODE" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetFanMode( - context.Background(), - api.ThermostatsSetFanModeRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - FanModeSetting: api.String("auto"), - }, - ) -} -``` - -#### Output - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes --- -### `fan_mode` - -Type: `string` +**`fan_mode`** *string* Required: No --- -### `fan_mode_setting` - -Type: `string` +**`fan_mode_setting`** *string* Required: No Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 21a6f8c07..96f47f7af 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -6,6 +6,7 @@ Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/c ``` POST /thermostats/set_hvac_mode ⇒ { action_attempt } ``` +{% endhint %}
@@ -16,200 +17,43 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.setHvacMode({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting: "heat_cool", - heating_set_point_celsius: 20, - cooling_set_point_celsius: 25, -}); -``` - -#### Output - -```javascript -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "success", - "action_type": "SET_HVAC_MODE" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.set_hvac_mode( - device_id="123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting="heat_cool", - heating_set_point_celsius=20, - cooling_set_point_celsius=25, -) -``` - -#### Output - -```python -ActionAttempt( - action_attempt_id="123e4567-e89b-12d3-a456-426614174000", - status="success", - action_type="SET_HVAC_MODE", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.set_hvac_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting: "heat_cool", - heating_set_point_celsius: 20, - cooling_set_point_celsius: 25, -) -``` - -#### Output - -```ruby -{ - "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", - "status" => "success", - "action_type" => "SET_HVAC_MODE", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->set_hvac_mode( - device_id: "123e4567-e89b-12d3-a456-426614174000", - hvac_mode_setting: "heat_cool", - heating_set_point_celsius: 20, - cooling_set_point_celsius: 25 -); -``` - -#### Output - -```php - "123e4567-e89b-12d3-a456-426614174000", - "status" => "success", - "action_type" => "SET_HVAC_MODE", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25 -``` - -#### Output - -```seam_cli -{ - "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", - "status": "success", - "action_type": "SET_HVAC_MODE" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetHvacMode( - context.Background(), - api.ThermostatsSetHvacModeRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - HvacModeSetting: api.String("heat_cool"), - HeatingSetPointCelsius: api.Float64(20), - CoolingSetPointCelsius: api.Float64(25), - }, - ) -} -``` - -#### Output - -```go -api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `hvac_mode_setting` - -Type: `string` +**`hvac_mode_setting`** *string* Required: Yes --- -### `cooling_set_point_celsius` - -Type: `number` +**`cooling_set_point_celsius`** *number* Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -### `cooling_set_point_fahrenheit` - -Type: `number` +**`cooling_set_point_fahrenheit`** *number* Required: No Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- -### `heating_set_point_celsius` - -Type: `number` +**`heating_set_point_celsius`** *number* Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -### `heating_set_point_fahrenheit` - -Type: `number` +**`heating_set_point_fahrenheit`** *number* Required: No Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 4aabd1217..f900da537 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -6,6 +6,7 @@ Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-m ``` PATCH /thermostats/set_temperature_threshold ⇒ void ``` +{% endhint %}
@@ -15,167 +16,38 @@ PATCH /thermostats/set_temperature_threshold ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.setTemperatureThreshold({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius: 4, - upper_limit_celsius: 30, -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.set_temperature_threshold( - device_id="123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius=4, - upper_limit_celsius=30, -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.set_temperature_threshold( - device_id: "123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius: 4, - upper_limit_celsius: 30, -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->set_temperature_threshold( - device_id: "123e4567-e89b-12d3-a456-426614174000", - lower_limit_celsius: 4, - upper_limit_celsius: 30 -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30 -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.SetTemperatureThreshold( - context.Background(), - api.ThermostatsSetTemperatureThresholdRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - LowerLimitCelsius: api.Float64(4), - UpperLimitCelsius: api.Float64(30), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `lower_limit_celsius` - -Type: `number` +**`lower_limit_celsius`** *number* Required: No Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- -### `lower_limit_fahrenheit` - -Type: `number` +**`lower_limit_fahrenheit`** *number* Required: No Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- -### `upper_limit_celsius` - -Type: `number` +**`upper_limit_celsius`** *number* Required: No Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. --- -### `upper_limit_fahrenheit` - -Type: `number` +**`upper_limit_fahrenheit`** *number* Required: No Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 2c8bc7958..5e685218d 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -6,6 +6,7 @@ Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats ``` POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ``` +{% endhint %}
@@ -15,59 +16,45 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `hvac_mode` - -Type: `string` +**`hvac_mode`** *string* Required: Yes Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate. --- -### `cooling_set_point_celsius` - -Type: `number` +**`cooling_set_point_celsius`** *number* Required: No Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. --- -### `cooling_set_point_fahrenheit` - -Type: `number` +**`cooling_set_point_fahrenheit`** *number* Required: No Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. --- -### `heating_set_point_celsius` - -Type: `number` +**`heating_set_point_celsius`** *number* Required: No Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. --- -### `heating_set_point_fahrenheit` - -Type: `number` +**`heating_set_point_fahrenheit`** *number* Required: No Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index e936a3bba..59ecb0005 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -6,6 +6,7 @@ Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermosta ``` POST /thermostats/simulate/temperature_reached ⇒ void ``` +{% endhint %}
@@ -15,32 +16,24 @@ POST /thermostats/simulate/temperature_reached ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `temperature_celsius` - -Type: `number` +**`temperature_celsius`** *number* Required: No Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. --- -### `temperature_fahrenheit` - -Type: `number` +**`temperature_fahrenheit`** *number* Required: No Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index cf7214201..a6b7938f0 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -6,6 +6,7 @@ Updates a specified [climate preset](../../capability-guides/thermostats/creatin ``` PATCH /thermostats/update_climate_preset ⇒ void ``` +{% endhint %}
@@ -16,217 +17,73 @@ PATCH /thermostats/update_climate_preset ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.thermostats.updateClimatePreset({ - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - cooling_set_point_celsius: 24, - manual_override_allowed: true, -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.thermostats.update_climate_preset( - device_id="123e4567-e89b-12d3-a456-426614174000", - climate_preset_key="occupied", - cooling_set_point_celsius=24, - manual_override_allowed=true, -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.thermostats.update_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - cooling_set_point_celsius: 24, - manual_override_allowed: true, -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -thermostats->update_climate_preset( - device_id: "123e4567-e89b-12d3-a456-426614174000", - climate_preset_key: "occupied", - cooling_set_point_celsius: 24, - manual_override_allowed: true -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.Thermostats.UpdateClimatePreset( - context.Background(), - api.ThermostatsUpdateClimatePresetRequest{ - DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), - ClimatePresetKey: api.String("occupied"), - CoolingSetPointCelsius: api.Float64(24), - ManualOverrideAllowed: api.Bool(true), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `climate_preset_key` - -Type: `string` +**`climate_preset_key`** *string* Required: Yes Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired thermostat device. --- -### `manual_override_allowed` - -Type: `boolean` +**`manual_override_allowed`** *boolean* Required: Yes Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -### `cooling_set_point_celsius` - -Type: `number` +**`cooling_set_point_celsius`** *number* Required: No 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` - -Type: `number` +**`cooling_set_point_fahrenheit`** *number* Required: No Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -### `fan_mode_setting` - -Type: `string` +**`fan_mode_setting`** *string* Required: No 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`. --- -### `heating_set_point_celsius` - -Type: `number` +**`heating_set_point_celsius`** *number* Required: No 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` - -Type: `number` +**`heating_set_point_fahrenheit`** *number* Required: No 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` - -Type: `string` +**`hvac_mode_setting`** *string* Required: No Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- -### `name` - -Type: `string` +**`name`** *string* Required: No User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index aaa926331..2ba453bd2 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -6,6 +6,7 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access ``` PUT /user_identities/add_acs_user ⇒ void ``` +{% endhint %}
@@ -15,135 +16,17 @@ PUT /user_identities/add_acs_user ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.addAcsUser({ - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.add_acs_user( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.add_acs_user( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->add_acs_user( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.AddAcsUser( - context.Background(), - api.UserIdentitiesAddAcsUserRequest{ - UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), - AcsUserId: api.String("4d223973-0874-4831-8630-bfcb29e6bce0"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the desired ACS user. --- -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the desired user identity. diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 7902f2fd0..dd3719fff 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -6,6 +6,7 @@ Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobi ``` POST /user_identities/create ⇒ { user_identity } ``` +{% endhint %}
@@ -15,209 +16,31 @@ POST /user_identities/create ⇒ { user_identity } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.create({ - user_identity_key: "jean_doe", - email_address: "jean@example.com", - phone_number: "+15555550110", - full_name: "Jean Doe", -}); -``` - -#### Output - -```javascript -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.create( - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - full_name="Jean Doe", -) -``` - -#### Output - -```python -UserIdentity( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - display_name="Jean Doe", - full_name="Jean Doe", - created_at="2024-01-11T05:37:50.264Z", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.create( - user_identity_key: "jean_doe", - email_address: "jean@example.com", - phone_number: "+15555550110", - full_name: "Jean Doe", -) -``` - -#### Output - -```ruby -{ - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->create( - user_identity_key: "jean_doe", - email_address: "jean@example.com", - phone_number: "+15555550110", - full_name: "Jean Doe" -); -``` - -#### Output - -```php - "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe" -``` - -#### Output - -```seam_cli -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.Create( - context.Background(), - api.UserIdentitiesCreateRequest{ - UserIdentityKey: api.String("jean_doe"), - EmailAddress: api.String("jean@example.com"), - PhoneNumber: api.String("+15555550110"), - FullName: api.String("Jean Doe"), - }, - ) -} -``` - -#### Output - -```go -api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `email_address` - -Type: `string` +**`email_address`** *string* Required: No Unique email address for the user identity. --- -### `full_name` - -Type: `string` +**`full_name`** *string* Required: No Full name of the user associated with the user identity. --- -### `phone_number` - -Type: `string` +**`phone_number`** *string* Required: No Unique phone number for the user identity in E.164 format (for example, +15555550100). --- -### `user_identity_key` - -Type: `string` +**`user_identity_key`** *string* Required: No Unique key for the user identity. diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index af29b2faf..dd225bd66 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -6,6 +6,7 @@ Deletes a specified [user identity](https://docs.seam.co/latest/capability-guide ``` POST /user_identities/delete ⇒ void ``` +{% endhint %}
@@ -15,117 +16,10 @@ POST /user_identities/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.delete({ - user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135") -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135") -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->delete( - user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.Delete( - context.Background(), - api.UserIdentitiesDeleteRequest{ - UserIdentityId: api.String("44d48b20-0dbe-419d-91ca-ab8bceecd135"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the desired user identity. diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 23c3389c5..45dc38233 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -6,6 +6,7 @@ Deletes a specified [enrollment automation](https://docs.seam.co/latest/capabili ``` POST /user_identities/enrollment_automations/delete ⇒ void ``` +{% endhint %}
@@ -15,122 +16,10 @@ POST /user_identities/enrollment_automations/delete ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.enrollmentAutomations.delete({ - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.enrollment_automations.delete( - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.enrollment_automations.delete( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->enrollment_automations->delete( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.Delete( - context.Background(), - enrollmentautomations.EnrollmentAutomationsDeleteRequest{ - EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `enrollment_automation_id` - -Type: `string` +**`enrollment_automation_id`** *string* Required: Yes ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 1ae0264d3..32ec0c0d4 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -6,6 +6,7 @@ Returns a specified [enrollment automation](https://docs.seam.co/latest/capabili ``` POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ``` +{% endhint %}
@@ -16,165 +17,10 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.enrollmentAutomations.get({ - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -}); -``` - -#### Output - -```javascript -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.enrollment_automations.get( - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" -) -``` - -#### Output - -```python -EnrollmentAutomation( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", - acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - is_running=true, - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-09T05:45:33.068Z", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.enrollment_automations.get( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", -) -``` - -#### Output - -```ruby -{ - "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->enrollment_automations->get( - enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" -); -``` - -#### Output - -```php - "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => - "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => - "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" -``` - -#### Output - -```seam_cli -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.Get( - context.Background(), - enrollmentautomations.EnrollmentAutomationsGetRequest{ - EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), - }, - ) -} -``` - -#### Output - -```go -api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `enrollment_automation_id` - -Type: `string` +**`enrollment_automation_id`** *string* Required: Yes ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 282a3f943..41bcc953e 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -6,6 +6,7 @@ Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-gui ``` POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation } ``` +{% endhint %}
@@ -15,216 +16,38 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.enrollmentAutomations.launch({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user: true, -}); -``` - -#### Output - -```javascript -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.enrollment_automations.launch( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id="3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user=true, -) -``` - -#### Output - -```python -Unknown( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", - acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - is_running=true, - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-09T05:45:33.068Z", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.enrollment_automations.launch( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user: true, -) -``` - -#### Output - -```ruby -{ - "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->enrollment_automations->launch( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", - acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", - create_credential_manager_user: true -); -``` - -#### Output - -```php - "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => - "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => - "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true -``` - -#### Output - -```seam_cli -{ - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.Launch( - context.Background(), - enrollmentautomations.EnrollmentAutomationsLaunchRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - CredentialManagerAcsSystemId: api.String("6737e186-8d54-48ce-a7da-a0be4d252172"), - AcsCredentialPoolId: api.String("3fa85f64-5717-4562-b3fc-2c963f66afa6"), - CreateCredentialManagerUser: api.Bool(true), - }, - ) -} -``` - -#### Output - -```go -api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `credential_manager_acs_system_id` - -Type: `string` +**`credential_manager_acs_system_id`** *string* Required: Yes ID of the desired ACS system that serves as the credential manager. --- -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the desired user identity. --- -### `acs_credential_pool_id` - -Type: `string` +**`acs_credential_pool_id`** *string* Required: No ID of the ACS credential pool from which to obtain credentials for the user identity. --- -### `create_credential_manager_user` - -Type: `boolean` +**`create_credential_manager_user`** *boolean* Required: No Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. --- -### `credential_manager_acs_user_id` - -Type: `string` +**`credential_manager_acs_user_id`** *string* Required: No ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index fd1c9cd2e..593c78ab0 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -6,6 +6,7 @@ Returns a list of all [enrollment automations](https://docs.seam.co/latest/capab ``` POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: [enrollment_automation, …] } ``` +{% endhint %}
@@ -16,175 +17,10 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.enrollmentAutomations.list({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", -}); -``` - -#### Output - -```javascript -[ - { - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.enrollment_automations.list( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" -) -``` - -#### Output - -```python -[ - EnrollmentAutomation( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", - acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", - credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - is_running=true, - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-09T05:45:33.068Z", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.enrollment_automations.list( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", -) -``` - -#### Output - -```ruby -[ - { - "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->enrollment_automations->list( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -); -``` - -#### Output - -```php - "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id" => - "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id" => - "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running" => true, - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-09T05:45:33.068Z", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -``` - -#### Output - -```seam_cli -[ - { - "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", - "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "is_running": true, - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-09T05:45:33.068Z" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" -import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" - -func main() { - client.UserIdentities.EnrollmentAutomations.List( - context.Background(), - enrollmentautomations.EnrollmentAutomationsListRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - }, - ) -} -``` - -#### Output - -```go -[]api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the user identity for which you want to retrieve all enrollment automations. diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index f3a291988..2326f654d 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -6,6 +6,7 @@ Returns a specified [user identity](https://docs.seam.co/latest/capability-guide ``` POST /user_identities/get ⇒ { user_identity } ``` +{% endhint %}
@@ -15,172 +16,17 @@ POST /user_identities/get ⇒ { user_identity } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.get({ - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", -}); -``` - -#### Output - -```javascript -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") -``` - -#### Output - -```python -UserIdentity( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - display_name="Jean Doe", - full_name="Jean Doe", - created_at="2024-01-11T05:37:50.264Z", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", -) -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") -``` - -#### Output - -```ruby -{ - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -} -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->get( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -); -``` - -#### Output - -```php - "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -``` - -#### Output - -```seam_cli -{ - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" -} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.Get( - context.Background(), - api.UserIdentitiesGetRequest{ - UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), - }, - ) -} -``` - -#### Output - -```go -api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: No ID of the desired user identity. --- -### `user_identity_key` - -Type: `string` +**`user_identity_key`** *string* Required: No --- diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index aa479250e..260ac9805 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -6,6 +6,7 @@ Grants a specified [user identity](https://docs.seam.co/latest/capability-guides ``` PUT /user_identities/grant_access_to_device ⇒ void ``` +{% endhint %}
@@ -15,135 +16,17 @@ PUT /user_identities/grant_access_to_device ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.grantAccessToDevice({ - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.grant_access_to_device( - user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id="054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.grant_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->grant_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.GrantAccessToDevice( - context.Background(), - api.UserIdentitiesGrantAccessToDeviceRequest{ - UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), - DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired managed device. --- -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the desired user identity. diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 141dac8ca..85ccf1d55 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -6,6 +6,7 @@ Returns a list of all [user identities](https://docs.seam.co/latest/capability-g ``` POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ``` +{% endhint %}
@@ -16,162 +17,10 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.list(); -``` - -#### Output - -```javascript -[ - { - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.list() -``` - -#### Output - -```python -[ - UserIdentity( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_key="jean_doe", - email_address="jean@example.com", - phone_number="+15555550110", - display_name="Jean Doe", - full_name="Jean Doe", - created_at="2024-01-11T05:37:50.264Z", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.list() -``` - -#### Output - -```ruby -[ - { - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->list(); -``` - -#### Output - -```php - "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key" => "jean_doe", - "email_address" => "jean@example.com", - "phone_number" => "+15555550110", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "created_at" => "2024-01-11T05:37:50.264Z", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities list -``` - -#### Output - -```seam_cli -[ - { - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_key": "jean_doe", - "email_address": "jean@example.com", - "phone_number": "+15555550110", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "created_at": "2024-01-11T05:37:50.264Z", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -func main() { - client.UserIdentities.List(context.Background()) -} -``` - -#### Output - -```go -[]api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `credential_manager_acs_system_id` - -Type: `string` +**`credential_manager_acs_system_id`** *string* Required: No --- diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 5d74ea314..57ece2248 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -6,6 +6,7 @@ Returns a list of all [devices](../../core-concepts/devices/README.md) associate ``` POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ``` +{% endhint %}
@@ -15,393 +16,10 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.listAccessibleDevices({ - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", -}); -``` - -#### Output - -```javascript -[ - { - "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname": "", - "display_name": "Seam Thermostat", - "device_type": "nest_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "online": true, - "is_cooling": false, - "is_heating": false, - "manufacturer": "nest", - "nest_metadata": { - "custom_name": "", - "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" - }, - "is_fan_running": false, - "has_direct_power": true, - "relative_humidity": 0.46, - "temperature_celsius": 24.64, - "temperature_fahrenheit": 76.352, - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "manual_override_allowed": true, - "cooling_set_point_celsius": 21.5, - "heating_set_point_celsius": 20, - "cooling_set_point_fahrenheit": 70.7, - "heating_set_point_fahrenheit": 68 - }, - "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], - "is_temporary_manual_override_active": false, - "name": "", - "appearance": { "name": "" }, - "model": { - "display_name": "Thermostat", - "manufacturer_display_name": "Nest", - "accessory_keypad_supported": false - }, - "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text": "Placeholder Lock Image", - "is_climate_setting_schedule_active": false - }, - "location": null, - "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-02-29T21:57:33.397Z", - "errors": [], - "warnings": [], - "is_managed": true, - "custom_metadata": {} - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.list_accessible_devices( - user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf" -) -``` - -#### Output - -```python -[ - Device( - device_id="054765c8-a2fc-4599-b486-14c19f462c45", - nickname="", - display_name="Seam Thermostat", - device_type="nest_thermostat", - capabilities_supported=["thermostat"], - properties={ - "online": true, - "is_cooling": false, - "is_heating": false, - "manufacturer": "nest", - "nest_metadata": { - "custom_name": "", - "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a", - }, - "is_fan_running": false, - "has_direct_power": true, - "relative_humidity": 0.46, - "temperature_celsius": 24.64, - "temperature_fahrenheit": 76.352, - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "manual_override_allowed": true, - "cooling_set_point_celsius": 21.5, - "heating_set_point_celsius": 20, - "cooling_set_point_fahrenheit": 70.7, - "heating_set_point_fahrenheit": 68, - }, - "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], - "is_temporary_manual_override_active": false, - "name": "", - "appearance": {"name": ""}, - "model": { - "display_name": "Thermostat", - "manufacturer_display_name": "Nest", - "accessory_keypad_supported": false, - }, - "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text": "Placeholder Lock Image", - "is_climate_setting_schedule_active": false, - }, - location=None, - connected_account_id="44284499-a50b-4947-86c1-58264f014be5", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-02-29T21:57:33.397Z", - errors=[], - warnings=[], - is_managed=true, - custom_metadata={}, - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.list_accessible_devices( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", -) -``` - -#### Output - -```ruby -[ - { - "device_id" => "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname" => "", - "display_name" => "Seam Thermostat", - "device_type" => "nest_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => { - online: true, - is_cooling: false, - is_heating: false, - manufacturer: "nest", - nest_metadata: { - custom_name: "", - device_name: - "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - nest_device_id: "bcca8c5f-1854-4906-9911-c877d513e00a", - }, - is_fan_running: false, - has_direct_power: true, - relative_humidity: 0.46, - temperature_celsius: 24.64, - temperature_fahrenheit: 76.352, - current_climate_setting: { - hvac_mode_setting: "heat_cool", - manual_override_allowed: true, - cooling_set_point_celsius: 21.5, - heating_set_point_celsius: 20, - cooling_set_point_fahrenheit: 70.7, - heating_set_point_fahrenheit: 68, - }, - available_hvac_mode_settings: %w[heat cool heat_cool off], - is_temporary_manual_override_active: false, - name: "", - appearance: { - name: "", - }, - model: { - display_name: "Thermostat", - manufacturer_display_name: "Nest", - accessory_keypad_supported: false, - }, - image_url: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - image_alt_text: "Placeholder Lock Image", - is_climate_setting_schedule_active: false, - }, - "location" => nil, - "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-02-29T21:57:33.397Z", - "errors" => [], - "warnings" => [], - "is_managed" => true, - "custom_metadata" => { - }, - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->list_accessible_devices( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf" -); -``` - -#### Output - -```php - "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname" => "", - "display_name" => "Seam Thermostat", - "device_type" => "nest_thermostat", - "capabilities_supported" => ["thermostat"], - "properties" => [ - "online" => true, - "is_cooling" => false, - "is_heating" => false, - "manufacturer" => "nest", - "nest_metadata" => [ - "custom_name" => "", - "device_name" => - "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id" => "bcca8c5f-1854-4906-9911-c877d513e00a", - ], - "is_fan_running" => false, - "has_direct_power" => true, - "relative_humidity" => 0.46, - "temperature_celsius" => 24.64, - "temperature_fahrenheit" => 76.352, - "current_climate_setting" => [ - "hvac_mode_setting" => "heat_cool", - "manual_override_allowed" => true, - "cooling_set_point_celsius" => 21.5, - "heating_set_point_celsius" => 20, - "cooling_set_point_fahrenheit" => 70.7, - "heating_set_point_fahrenheit" => 68, - ], - "available_hvac_mode_settings" => [ - "heat", - "cool", - "heat_cool", - "off", - ], - "is_temporary_manual_override_active" => false, - "name" => "", - "appearance" => ["name" => ""], - "model" => [ - "display_name" => "Thermostat", - "manufacturer_display_name" => "Nest", - "accessory_keypad_supported" => false, - ], - "image_url" => - "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text" => "Placeholder Lock Image", - "is_climate_setting_schedule_active" => false, - ], - "location" => null, - "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-02-29T21:57:33.397Z", - "errors" => [], - "warnings" => [], - "is_managed" => true, - "custom_metadata" => [], - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" -``` - -#### Output - -```seam_cli -[ - { - "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", - "nickname": "", - "display_name": "Seam Thermostat", - "device_type": "nest_thermostat", - "capabilities_supported": ["thermostat"], - "properties": { - "online": true, - "is_cooling": false, - "is_heating": false, - "manufacturer": "nest", - "nest_metadata": { - "custom_name": "", - "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", - "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" - }, - "is_fan_running": false, - "has_direct_power": true, - "relative_humidity": 0.46, - "temperature_celsius": 24.64, - "temperature_fahrenheit": 76.352, - "current_climate_setting": { - "hvac_mode_setting": "heat_cool", - "manual_override_allowed": true, - "cooling_set_point_celsius": 21.5, - "heating_set_point_celsius": 20, - "cooling_set_point_fahrenheit": 70.7, - "heating_set_point_fahrenheit": 68 - }, - "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], - "is_temporary_manual_override_active": false, - "name": "", - "appearance": { "name": "" }, - "model": { - "display_name": "Thermostat", - "manufacturer_display_name": "Nest", - "accessory_keypad_supported": false - }, - "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", - "image_alt_text": "Placeholder Lock Image", - "is_climate_setting_schedule_active": false - }, - "location": null, - "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-02-29T21:57:33.397Z", - "errors": [], - "warnings": [], - "is_managed": true, - "custom_metadata": {} - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.ListAccessibleDevices( - context.Background(), - api.UserIdentitiesListAccessibleDevicesRequest{ - UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), - }, - ) -} -``` - -#### Output - -```go -[]api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the user identity for which you want to retrieve all accessible devices. diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 98bc6d8ce..b8d0662d7 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -6,6 +6,7 @@ Returns a list of all [access control systems](https://docs.seam.co/latest/capab ``` POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` +{% endhint %}
@@ -16,180 +17,10 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.listAcsSystems({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", -}); -``` - -#### Output - -```javascript -[ - { - "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "name": "Assa Abloy Credential Service", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-05T07:16:51.971Z", - "system_type": "assa_abloy_credential_service", - "system_type_display_name": "Assa Abloy Credential Service", - "external_type": "assa_abloy_credential_service", - "external_type_display_name": "Assa Abloy Credential Service", - "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.list_acs_systems( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" -) -``` - -#### Output - -```python -[ - AcsSystem( - acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", - name="Assa Abloy Credential Service", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-05T07:16:51.971Z", - system_type="assa_abloy_credential_service", - system_type_display_name="Assa Abloy Credential Service", - external_type="assa_abloy_credential_service", - external_type_display_name="Assa Abloy Credential Service", - connected_account_ids=["dc08066f-d9b8-42f0-9c4b-c781cd900153"], - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f") -``` - -#### Output - -```ruby -[ - { - "acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", - "name" => "Assa Abloy Credential Service", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-05T07:16:51.971Z", - "system_type" => "assa_abloy_credential_service", - "system_type_display_name" => "Assa Abloy Credential Service", - "external_type" => "assa_abloy_credential_service", - "external_type_display_name" => "Assa Abloy Credential Service", - "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->list_acs_systems( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -); -``` - -#### Output - -```php - "6737e186-8d54-48ce-a7da-a0be4d252172", - "name" => "Assa Abloy Credential Service", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-05T07:16:51.971Z", - "system_type" => "assa_abloy_credential_service", - "system_type_display_name" => "Assa Abloy Credential Service", - "external_type" => "assa_abloy_credential_service", - "external_type_display_name" => "Assa Abloy Credential Service", - "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" -``` - -#### Output - -```seam_cli -[ - { - "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", - "name": "Assa Abloy Credential Service", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-05T07:16:51.971Z", - "system_type": "assa_abloy_credential_service", - "system_type_display_name": "Assa Abloy Credential Service", - "external_type": "assa_abloy_credential_service", - "external_type_display_name": "Assa Abloy Credential Service", - "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.ListAcsSystems( - context.Background(), - api.UserIdentitiesListAcsSystemsRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the user identity for which you want to retrieve all access control systems. diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index fbb1e1f52..efa6267cf 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -6,6 +6,7 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/ ``` POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ``` +{% endhint %}
@@ -15,190 +16,10 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.listAcsUsers({ - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", -}); -``` - -#### Output - -```javascript -[ - { - "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "email_address": "jean@example.com", - "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-11T05:45:41.349Z", - "is_suspended": false, - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address": "jean@example.com", - "user_identity_phone_number": "+15555550110" - } -] -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.list_acs_users( - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -) -``` - -#### Output - -```python -[ - AcsUser( - acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", - display_name="Jean Doe", - full_name="Jean Doe", - email_address="jean@example.com", - acs_system_id="8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", - created_at="2024-01-11T05:45:41.349Z", - is_suspended=false, - user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - user_identity_email_address="jean@example.com", - user_identity_phone_number="+15555550110", - ) -] -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") -``` - -#### Output - -```ruby -[ - { - "acs_user_id" => "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "email_address" => "jean@example.com", - "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-11T05:45:41.349Z", - "is_suspended" => false, - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address" => "jean@example.com", - "user_identity_phone_number" => "+15555550110", - }, -] -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->list_acs_users( - user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -); -``` - -#### Output - -```php - "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name" => "Jean Doe", - "full_name" => "Jean Doe", - "email_address" => "jean@example.com", - "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at" => "2024-01-11T05:45:41.349Z", - "is_suspended" => false, - "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address" => "jean@example.com", - "user_identity_phone_number" => "+15555550110", - ], -]; -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" -``` - -#### Output - -```seam_cli -[ - { - "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", - "display_name": "Jean Doe", - "full_name": "Jean Doe", - "email_address": "jean@example.com", - "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", - "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", - "created_at": "2024-01-11T05:45:41.349Z", - "is_suspended": false, - "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", - "user_identity_email_address": "jean@example.com", - "user_identity_phone_number": "+15555550110" - } -] -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.ListAcsUsers( - context.Background(), - api.UserIdentitiesListAcsUsersRequest{ - UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), - }, - ) -} -``` - -#### Output - -```go -[]api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}} -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the user identity for which you want to retrieve all ACS users. diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 859d3f70e..366183ed0 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -6,6 +6,7 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/acc ``` POST /user_identities/remove_acs_user ⇒ void ``` +{% endhint %}
@@ -15,135 +16,17 @@ POST /user_identities/remove_acs_user ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.removeAcsUser({ - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.remove_acs_user( - user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id="c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.remove_acs_user( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->remove_acs_user( - user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", - acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.RemoveAcsUser( - context.Background(), - api.UserIdentitiesRemoveAcsUserRequest{ - UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), - AcsUserId: api.String("c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `acs_user_id` - -Type: `string` +**`acs_user_id`** *string* Required: Yes ID of the ACS user. --- -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the desired user identity. diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 3b8b9e8b6..c2e4856dd 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -6,6 +6,7 @@ Revokes access to a specified [device](../../core-concepts/devices/README.md) fr ``` POST /user_identities/revoke_access_to_device ⇒ void ``` +{% endhint %}
@@ -15,135 +16,17 @@ POST /user_identities/revoke_access_to_device ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - -{% tabs %} -{% tab title="JavaScript" %} -#### Code - -```javascript -await seam.userIdentities.revokeAccessToDevice({ - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -}); -``` - -#### Output - -```javascript -// void -``` -{% endtab %} - -{% tab title="Python" %} -#### Code - -```python -seam.user_identities.revoke_access_to_device( - user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id="054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Output - -```python -None -``` -{% endtab %} - -{% tab title="Ruby" %} -#### Code - -```ruby -seam.user_identities.revoke_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45", -) -``` - -#### Output - -```ruby -nil -``` -{% endtab %} - -{% tab title="PHP" %} -#### Code - -```php -user_identities->revoke_access_to_device( - user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", - device_id: "054765c8-a2fc-4599-b486-14c19f462c45" -); -``` - -#### Output - -```php -null -``` -{% endtab %} - -{% tab title="Seam CLI" %} -#### Code - -```seam_cli -seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" -``` - -#### Output - -```seam_cli -{} -``` -{% endtab %} - -{% tab title="Go" %} -#### Code - -```go -package main - -import api "github.com/seamapi/go" - -func main() { - client.UserIdentities.RevokeAccessToDevice( - context.Background(), - api.UserIdentitiesRevokeAccessToDeviceRequest{ - UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), - DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), - }, - ) -} -``` - -#### Output - -```go -nil -``` -{% endtab %} - -{% endtabs %} - ## Request Parameters -### `device_id` - -Type: `string` +**`device_id`** *string* Required: Yes ID of the desired managed device. --- -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the desired user identity. diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 210282b15..6528ed35c 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -6,6 +6,7 @@ ``` PATCH /user_identities/update ⇒ void ``` +{% endhint %}
@@ -15,48 +16,36 @@ PATCH /user_identities/update ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request.
-{% endhint %} - ## Request Parameters -### `user_identity_id` - -Type: `string` +**`user_identity_id`** *string* Required: Yes ID of the user identity. --- -### `email_address` - -Type: `string` +**`email_address`** *string* Required: No Unique email address for the user identity. --- -### `full_name` - -Type: `string` +**`full_name`** *string* Required: No --- -### `phone_number` - -Type: `string` +**`phone_number`** *string* Required: No Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- -### `user_identity_key` - -Type: `string` +**`user_identity_key`** *string* Required: No Unique key for the user identity. From 0edf580c55b42f1498c71dda7749dfa83d64ffcb Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 18:43:17 -0400 Subject: [PATCH 150/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 2a6ddafa9..c0b9a113b 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -26,8 +26,7 @@ {{#if request.parameters.length}} {{#each request.parameters}} -**`{{this.name}}`** *{{this.jsonType}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}} -Required: {{#if this.required}}Yes{{else}}No{{/if}} +**`{{this.name}}`** *{{this.format}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}}{{#if this.required}} (Required){{/if}} {{#if this.description}} {{this.description}} From fbbd898c6a628efb4c471e6dcc3a11e119f5cf05 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 22:44:20 +0000 Subject: [PATCH 151/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 6 ++-- docs/api/acs/access_groups/get.md | 3 +- docs/api/acs/access_groups/list.md | 6 ++-- .../list_accessible_entrances.md | 3 +- docs/api/acs/access_groups/list_users.md | 3 +- docs/api/acs/access_groups/remove_user.md | 6 ++-- docs/api/acs/credentials/assign.md | 6 ++-- docs/api/acs/credentials/create.md | 33 +++++++------------ docs/api/acs/credentials/delete.md | 3 +- docs/api/acs/credentials/get.md | 3 +- docs/api/acs/credentials/list.md | 18 ++++------ .../credentials/list_accessible_entrances.md | 3 +- docs/api/acs/credentials/unassign.md | 6 ++-- docs/api/acs/credentials/update.md | 9 ++--- docs/api/acs/encoders/encode_credential.md | 6 ++-- docs/api/acs/encoders/list.md | 12 +++---- docs/api/acs/encoders/scan_credential.md | 3 +- .../next_credential_encode_will_fail.md | 9 ++--- .../next_credential_encode_will_succeed.md | 6 ++-- .../next_credential_scan_will_fail.md | 9 ++--- .../next_credential_scan_will_succeed.md | 9 ++--- docs/api/acs/entrances/get.md | 3 +- docs/api/acs/entrances/grant_access.md | 6 ++-- docs/api/acs/entrances/list.md | 6 ++-- .../entrances/list_credentials_with_access.md | 6 ++-- docs/api/acs/systems/get.md | 3 +- docs/api/acs/systems/list.md | 3 +- ...mpatible_credential_manager_acs_systems.md | 3 +- docs/api/acs/users/add_to_access_group.md | 6 ++-- docs/api/acs/users/create.md | 24 +++++--------- docs/api/acs/users/delete.md | 3 +- docs/api/acs/users/get.md | 3 +- docs/api/acs/users/list.md | 24 +++++--------- .../acs/users/list_accessible_entrances.md | 3 +- .../api/acs/users/remove_from_access_group.md | 6 ++-- .../users/revoke_access_to_all_entrances.md | 3 +- docs/api/acs/users/suspend.md | 3 +- docs/api/acs/users/unsuspend.md | 3 +- docs/api/acs/users/update.md | 21 ++++-------- docs/api/phones/deactivate.md | 3 +- docs/api/phones/get.md | 3 +- docs/api/phones/list.md | 6 ++-- .../phones/simulate/create_sandbox_phone.md | 12 +++---- .../thermostats/activate_climate_preset.md | 6 ++-- docs/api/thermostats/cool.md | 9 ++--- docs/api/thermostats/create_climate_preset.md | 30 ++++++----------- docs/api/thermostats/delete_climate_preset.md | 6 ++-- docs/api/thermostats/heat.md | 9 ++--- docs/api/thermostats/heat_cool.md | 15 +++------ docs/api/thermostats/list.md | 33 +++++++------------ docs/api/thermostats/off.md | 3 +- docs/api/thermostats/schedules/create.md | 21 ++++-------- docs/api/thermostats/schedules/delete.md | 3 +- docs/api/thermostats/schedules/get.md | 3 +- docs/api/thermostats/schedules/list.md | 6 ++-- docs/api/thermostats/schedules/update.md | 21 ++++-------- .../set_fallback_climate_preset.md | 6 ++-- docs/api/thermostats/set_fan_mode.md | 9 ++--- docs/api/thermostats/set_hvac_mode.md | 18 ++++------ .../thermostats/set_temperature_threshold.md | 15 +++------ .../simulate/hvac_mode_adjusted.md | 18 ++++------ .../simulate/temperature_reached.md | 9 ++--- docs/api/thermostats/update_climate_preset.md | 30 ++++++----------- docs/api/user_identities/add_acs_user.md | 6 ++-- docs/api/user_identities/create.md | 12 +++---- docs/api/user_identities/delete.md | 3 +- .../enrollment_automations/delete.md | 3 +- .../enrollment_automations/get.md | 3 +- .../enrollment_automations/launch.md | 15 +++------ .../enrollment_automations/list.md | 3 +- docs/api/user_identities/get.md | 6 ++-- .../user_identities/grant_access_to_device.md | 6 ++-- docs/api/user_identities/list.md | 3 +- .../list_accessible_devices.md | 3 +- docs/api/user_identities/list_acs_systems.md | 3 +- docs/api/user_identities/list_acs_users.md | 3 +- docs/api/user_identities/remove_acs_user.md | 6 ++-- .../revoke_access_to_device.md | 6 ++-- docs/api/user_identities/update.md | 15 +++------ 79 files changed, 227 insertions(+), 454 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index e7e4cfc49..b2327c7fe 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -19,15 +19,13 @@ PUT /acs/access_groups/add_user ⇒ void ## Request Parameters -**`acs_access_group_id`** *string* -Required: Yes +**`acs_access_group_id`** ** (Required) ID of the desired access group. --- -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired user. diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index ab407e0ba..0721d711d 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -19,8 +19,7 @@ POST /acs/access_groups/get ⇒ { acs_access_group } ## Request Parameters -**`acs_access_group_id`** *string* -Required: Yes +**`acs_access_group_id`** ** (Required) ID of the desired access group. diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 54e37c763..4596bff72 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -19,15 +19,13 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ## Request Parameters -**`acs_system_id`** *string* -Required: No +**`acs_system_id`** ** ID of the access control system for which you want to retrieve all access groups. --- -**`acs_user_id`** *string* -Required: No +**`acs_user_id`** ** ID of the user for which you want to retrieve all access groups. diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 1d6f6b35c..df914feff 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -19,8 +19,7 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr ## Request Parameters -**`acs_access_group_id`** *string* -Required: Yes +**`acs_access_group_id`** ** (Required) ID of the access group for which you want to retrieve all accessible entrances. diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index ff68112e6..8d4b6f6a4 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -19,8 +19,7 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ## Request Parameters -**`acs_access_group_id`** *string* -Required: Yes +**`acs_access_group_id`** ** (Required) ID of the access group for which you want to retrieve all users. diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 631ca0762..fbe804632 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -19,15 +19,13 @@ POST /acs/access_groups/remove_user ⇒ void ## Request Parameters -**`acs_access_group_id`** *string* -Required: Yes +**`acs_access_group_id`** ** (Required) ID of the desired access group. --- -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired user. diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 462c5b399..5f41ad2eb 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -19,15 +19,13 @@ PATCH /acs/credentials/assign ⇒ void ## Request Parameters -**`acs_credential_id`** *string* -Required: Yes +**`acs_credential_id`** ** (Required) ID of the desired credential. --- -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired user. diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 27ac8ee2a..62fdab80a 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -19,78 +19,67 @@ POST /acs/credentials/create ⇒ { acs_credential } ## Request Parameters -**`access_method`** *string* -Required: Yes +**`access_method`** ** (Required) Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. --- -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the ACS user to whom the new credential belongs. --- -**`allowed_acs_entrance_ids`** *array* *of UUIDs* -Required: No +**`allowed_acs_entrance_ids`** ** *of UUIDs* Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. --- -**`assa_abloy_vostio_metadata`** *object* -Required: No +**`assa_abloy_vostio_metadata`** ** Vostio-specific metadata for the new credential. --- -**`code`** *string* -Required: No +**`code`** ** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). --- -**`credential_manager_acs_system_id`** *string* -Required: No +**`credential_manager_acs_system_id`** ** ACS system ID of the credential manager for the new credential. --- -**`ends_at`** *string* -Required: No +**`ends_at`** ** Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- -**`is_multi_phone_sync_credential`** *boolean* -Required: No +**`is_multi_phone_sync_credential`** ** Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- -**`salto_space_metadata`** *object* -Required: No +**`salto_space_metadata`** ** Salto Space-specific metadata for the new credential. --- -**`starts_at`** *string* -Required: No +**`starts_at`** ** Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`visionline_metadata`** *object* -Required: No +**`visionline_metadata`** ** Visionline-specific metadata for the new credential. diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index ad4becd15..a68064d45 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -19,8 +19,7 @@ POST /acs/credentials/delete ⇒ void ## Request Parameters -**`acs_credential_id`** *string* -Required: Yes +**`acs_credential_id`** ** (Required) ID of the desired credential. diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index fd72f40dd..f5b6734f5 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -19,8 +19,7 @@ POST /acs/credentials/get ⇒ { acs_credential } ## Request Parameters -**`acs_credential_id`** *string* -Required: Yes +**`acs_credential_id`** ** (Required) ID of the desired credential. diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index af1f1b636..fdfe052e1 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -20,43 +20,37 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ## Request Parameters -**`acs_system_id`** *string* -Required: No +**`acs_system_id`** ** ID of the access control system for which you want to retrieve all credentials. --- -**`acs_user_id`** *string* -Required: No +**`acs_user_id`** ** ID of the ACS user for which you want to retrieve all credentials. --- -**`created_before`** *string* -Required: No +**`created_before`** ** Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. --- -**`is_multi_phone_sync_credential`** *boolean* -Required: No +**`is_multi_phone_sync_credential`** ** Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. --- -**`limit`** *number* -Required: No +**`limit`** ** Number of credentials to return. --- -**`user_identity_id`** *string* -Required: No +**`user_identity_id`** ** ID of the user identity for which you want to retrieve all credentials. diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 000055b58..2d591f54e 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -19,8 +19,7 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran ## Request Parameters -**`acs_credential_id`** *string* -Required: Yes +**`acs_credential_id`** ** (Required) ID of the credential for which you want to retrieve all entrances to which this credential grants access. diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 7097b79d6..7b0907160 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -19,15 +19,13 @@ PATCH /acs/credentials/unassign ⇒ void ## Request Parameters -**`acs_credential_id`** *string* -Required: Yes +**`acs_credential_id`** ** (Required) ID of the desired credential. --- -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired user. diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 38faed8fa..e29b30408 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -19,22 +19,19 @@ PATCH /acs/credentials/update ⇒ void ## Request Parameters -**`acs_credential_id`** *string* -Required: Yes +**`acs_credential_id`** ** (Required) ID of the desired credential. --- -**`code`** *string* -Required: No +**`code`** ** Replacement access (PIN) code for the credential. --- -**`ends_at`** *string* -Required: No +**`ends_at`** ** Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index f390a7501..526818e3f 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -19,15 +19,13 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt } ## Request Parameters -**`acs_credential_id`** *string* -Required: Yes +**`acs_credential_id`** ** (Required) ID of the `acs_credential` to encode onto a card. --- -**`acs_encoder_id`** *string* -Required: Yes +**`acs_encoder_id`** ** (Required) ID of the `acs_encoder` to use to encode the `acs_credential`. diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index ea6dde14e..70cbbb3fc 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -19,29 +19,25 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ## Request Parameters -**`acs_encoder_ids`** *array* *of UUIDs* -Required: No +**`acs_encoder_ids`** ** *of UUIDs* IDs of the `acs_encoder`s that you want to retrieve. --- -**`acs_system_id`** *string* -Required: No +**`acs_system_id`** ** ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. --- -**`acs_system_ids`** *array* *of UUIDs* -Required: No +**`acs_system_ids`** ** *of UUIDs* IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. --- -**`limit`** *number* -Required: No +**`limit`** ** Number of `acs_encoders` to return. diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 83c73c6be..695c161d2 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -19,8 +19,7 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt } ## Request Parameters -**`acs_encoder_id`** *string* -Required: Yes +**`acs_encoder_id`** ** (Required) ID of the `acs_encoder` to use for the scan. diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 557ef5b3a..533d4fd73 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -19,22 +19,19 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ## Request Parameters -**`acs_encoder_id`** *string* -Required: Yes +**`acs_encoder_id`** ** (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- -**`acs_credential_id`** *string* -Required: No +**`acs_credential_id`** ** ID of the `acs_credential` that will fail to be encoded onto a card in the next request. --- -**`error_code`** *string* -Required: No +**`error_code`** ** Code of the error to simulate. diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index b407d7c6a..ee4ab35ff 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -19,15 +19,13 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ## Request Parameters -**`acs_encoder_id`** *string* -Required: Yes +**`acs_encoder_id`** ** (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- -**`scenario`** *string* -Required: No +**`scenario`** ** Scenario to simulate. diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 16c3ace58..a4b8a8775 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -19,20 +19,17 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ## Request Parameters -**`acs_encoder_id`** *string* -Required: Yes +**`acs_encoder_id`** ** (Required) ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. --- -**`acs_credential_id_on_seam`** *string* -Required: No +**`acs_credential_id_on_seam`** ** --- -**`error_code`** *string* -Required: No +**`error_code`** ** --- diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index a7157602a..ae6f1b236 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -19,22 +19,19 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ## Request Parameters -**`acs_encoder_id`** *string* -Required: Yes +**`acs_encoder_id`** ** (Required) ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. --- -**`acs_credential_id_on_seam`** *string* -Required: No +**`acs_credential_id_on_seam`** ** ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. --- -**`scenario`** *string* -Required: No +**`scenario`** ** Scenario to simulate. diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 6c9178265..f93fabc2a 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -18,8 +18,7 @@ POST /acs/entrances/get ⇒ { acs_entrance } ## Request Parameters -**`acs_entrance_id`** *string* -Required: Yes +**`acs_entrance_id`** ** (Required) --- diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 4b456fe98..160000196 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -19,13 +19,11 @@ POST /acs/entrances/grant_access ⇒ void ## Request Parameters -**`acs_entrance_id`** *string* -Required: Yes +**`acs_entrance_id`** ** (Required) --- -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index fe3c83bd5..8c1d4b02b 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -20,13 +20,11 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ## Request Parameters -**`acs_credential_id`** *string* -Required: No +**`acs_credential_id`** ** --- -**`acs_system_id`** *string* -Required: No +**`acs_system_id`** ** --- diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index fbb964a8d..cde547fbe 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -20,13 +20,11 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre ## Request Parameters -**`acs_entrance_id`** *string* -Required: Yes +**`acs_entrance_id`** ** (Required) --- -**`include_if`** *array* *of Enums* -Required: No +**`include_if`** ** *of Enums*
Enum values diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 83ac96fc6..72c029a7a 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -21,8 +21,7 @@ POST /acs/systems/get ⇒ { acs_system } ## Request Parameters -**`acs_system_id`** *string* -Required: Yes +**`acs_system_id`** ** (Required) ID of the desired access control system. diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 9d022fad5..eb80b527f 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -22,8 +22,7 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ## Request Parameters -**`connected_account_id`** *string* -Required: No +**`connected_account_id`** ** ID of the connected account by which to filter the list of returned access control systems. diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index a0d36eb27..354ca3973 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -23,8 +23,7 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste ## Request Parameters -**`acs_system_id`** *string* -Required: Yes +**`acs_system_id`** ** (Required) ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index a0acab3e9..e274271c9 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -19,15 +19,13 @@ PUT /acs/users/add_to_access_group ⇒ void ## Request Parameters -**`acs_access_group_id`** *string* -Required: Yes +**`acs_access_group_id`** ** (Required) ID of the desired access group. --- -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index f0ad91aa9..24023f25f 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -19,55 +19,47 @@ POST /acs/users/create ⇒ { acs_user } ## Request Parameters -**`acs_system_id`** *string* -Required: Yes +**`acs_system_id`** ** (Required) ID of the `acs_system` to which to add the new `acs_user`. --- -**`full_name`** *string* -Required: Yes +**`full_name`** ** (Required) Full name of the new `acs_user`. --- -**`access_schedule`** *object* -Required: No +**`access_schedule`** ** `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. --- -**`acs_access_group_ids`** *array* *of UUIDs* -Required: No +**`acs_access_group_ids`** ** *of UUIDs* Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. --- -**`email`** *string* -Required: No +**`email`** ** --- -**`email_address`** *string* -Required: No +**`email_address`** ** Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`phone_number`** *string* -Required: No +**`phone_number`** ** Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -**`user_identity_id`** *string* -Required: No +**`user_identity_id`** ** ID of the user identity with which to associate the new `acs_user`. diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 59fcbfeeb..e9b637d00 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -19,8 +19,7 @@ POST /acs/users/delete ⇒ void ## Request Parameters -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 3adc8bf01..4f33d703f 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -19,8 +19,7 @@ POST /acs/users/get ⇒ { acs_user } ## Request Parameters -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 57f5b55e4..cfcc512f0 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -20,55 +20,47 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ## Request Parameters -**`acs_system_id`** *string* -Required: No +**`acs_system_id`** ** ID of the `acs_system` for which you want to retrieve all `acs_user`s. --- -**`created_before`** *string* -Required: No +**`created_before`** ** --- -**`limit`** *number* -Required: No +**`limit`** ** Maximum number of records to return per page. --- -**`page_cursor`** *string* -Required: No +**`page_cursor`** ** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. --- -**`search`** *string* -Required: No +**`search`** ** String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, or `email_address`. --- -**`user_identity_email_address`** *string* -Required: No +**`user_identity_email_address`** ** Email address of the user identity for which you want to retrieve all `acs_user`s. --- -**`user_identity_id`** *string* -Required: No +**`user_identity_id`** ** ID of the user identity for which you want to retrieve all `acs_user`s. --- -**`user_identity_phone_number`** *string* -Required: No +**`user_identity_phone_number`** ** Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 570a71665..752b0d822 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -20,8 +20,7 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, ## Request Parameters -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index f91ea5acd..d168db59b 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -19,15 +19,13 @@ POST /acs/users/remove_from_access_group ⇒ void ## Request Parameters -**`acs_access_group_id`** *string* -Required: Yes +**`acs_access_group_id`** ** (Required) ID of the desired access group. --- -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 8d3067057..335e91e1f 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -19,8 +19,7 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void ## Request Parameters -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 37562d54e..3547ac710 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -19,8 +19,7 @@ POST /acs/users/suspend ⇒ void ## Request Parameters -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index ac43a2f58..dc9b3edcd 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -19,8 +19,7 @@ POST /acs/users/unsuspend ⇒ void ## Request Parameters -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index f621a9ca4..f8942898a 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -19,46 +19,39 @@ PATCH /acs/users/update ⇒ void ## Request Parameters -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`access_schedule`** *object* -Required: No +**`access_schedule`** ** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. --- -**`email`** *string* -Required: No +**`email`** ** --- -**`email_address`** *string* -Required: No +**`email_address`** ** Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`full_name`** *string* -Required: No +**`full_name`** ** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`hid_acs_system_id`** *string* -Required: No +**`hid_acs_system_id`** ** --- -**`phone_number`** *string* -Required: No +**`phone_number`** ** Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 30c0914ea..7d413e61a 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -20,8 +20,7 @@ POST /phones/deactivate ⇒ void ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) Device ID of the desired phone. diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 434d94255..5d264802e 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -19,8 +19,7 @@ POST /phones/get ⇒ { phone } ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) Device ID of the desired phone. diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 463e5b2fb..ef58b3fac 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -19,15 +19,13 @@ POST /phones/list ⇒ { phones: [phone, …] } ## Request Parameters -**`acs_credential_id`** *string* -Required: No +**`acs_credential_id`** ** ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. --- -**`owner_user_identity_id`** *string* -Required: No +**`owner_user_identity_id`** ** ID of the user identity that represents the owner by which to filter the list of returned phones. diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 14cb8497a..4db1388fc 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -19,29 +19,25 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone } ## Request Parameters -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the user identity to associate with the simulated phone. --- -**`assa_abloy_metadata`** *object* -Required: No +**`assa_abloy_metadata`** ** ASSA ABLOY metadata to associate with the simulated phone. --- -**`custom_sdk_installation_id`** *string* -Required: No +**`custom_sdk_installation_id`** ** ID of the custom SDK installation to use for the simulated phone. --- -**`phone_metadata`** *object* -Required: No +**`phone_metadata`** ** Metadata to associate with the simulated phone. diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 8abdf8c64..fd31e97ae 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -19,15 +19,13 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } ## Request Parameters -**`climate_preset_key`** *string* -Required: Yes +**`climate_preset_key`** ** (Required) Climate preset key of the desired climate preset. --- -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index d4510c2e4..49a29ac52 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -20,22 +20,19 @@ POST /thermostats/cool ⇒ { action_attempt } ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`cooling_set_point_celsius`** *number* -Required: No +**`cooling_set_point_celsius`** ** Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -**`cooling_set_point_fahrenheit`** *number* -Required: No +**`cooling_set_point_fahrenheit`** ** Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 63d9e0e57..1f3477176 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -20,71 +20,61 @@ POST /thermostats/create_climate_preset ⇒ void ## Request Parameters -**`climate_preset_key`** *string* -Required: Yes +**`climate_preset_key`** ** (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`cooling_set_point_celsius`** *number* -Required: No +**`cooling_set_point_celsius`** ** 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* -Required: No +**`cooling_set_point_fahrenheit`** ** Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`fan_mode_setting`** *string* -Required: No +**`fan_mode_setting`** ** 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`. --- -**`heating_set_point_celsius`** *number* -Required: No +**`heating_set_point_celsius`** ** 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* -Required: No +**`heating_set_point_fahrenheit`** ** 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`** *string* -Required: No +**`hvac_mode_setting`** ** Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- -**`manual_override_allowed`** *boolean* -Required: No +**`manual_override_allowed`** ** Indicates whether a person at the thermostat or using the API can change the thermostat's settings. --- -**`name`** *string* -Required: No +**`name`** ** User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 4bb5f2075..5002f1990 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -20,15 +20,13 @@ POST /thermostats/delete_climate_preset ⇒ void ## Request Parameters -**`climate_preset_key`** *string* -Required: Yes +**`climate_preset_key`** ** (Required) Climate preset key of the desired climate preset. --- -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 140b86d1f..af16b8a18 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -20,22 +20,19 @@ POST /thermostats/heat ⇒ { action_attempt } ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`heating_set_point_celsius`** *number* -Required: No +**`heating_set_point_celsius`** ** Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -**`heating_set_point_fahrenheit`** *number* -Required: No +**`heating_set_point_fahrenheit`** ** Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 5eb536860..e7bc91143 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -20,36 +20,31 @@ POST /thermostats/heat_cool ⇒ { action_attempt } ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`cooling_set_point_celsius`** *number* -Required: No +**`cooling_set_point_celsius`** ** Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -**`cooling_set_point_fahrenheit`** *number* -Required: No +**`cooling_set_point_fahrenheit`** ** Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- -**`heating_set_point_celsius`** *number* -Required: No +**`heating_set_point_celsius`** ** Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -**`heating_set_point_fahrenheit`** *number* -Required: No +**`heating_set_point_fahrenheit`** ** Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index c196e52e0..537524876 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -20,57 +20,49 @@ POST /thermostats/list ⇒ { devices: [device, …] } ## Request Parameters -**`connect_webview_id`** *string* -Required: No +**`connect_webview_id`** ** ID of the Connect Webview by which to filter devices. --- -**`connected_account_id`** *string* -Required: No +**`connected_account_id`** ** ID of the connected account by which to filter. --- -**`connected_account_ids`** *array* *of UUIDs* -Required: No +**`connected_account_ids`** ** *of UUIDs* Array of IDs of the connected accounts by which to filter devices. --- -**`created_before`** *string* -Required: No +**`created_before`** ** Date threshold for devices to return. If specified, returns only devices created before the specified date. --- -**`custom_metadata_has`** *object* -Required: No +**`custom_metadata_has`** ** Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. --- -**`device_ids`** *array* *of UUIDs* -Required: No +**`device_ids`** ** *of UUIDs* Array of device IDs by which to filter devices. --- -**`device_type`** *string* -Required: No +**`device_type`** ** Device type by which to filter devices. --- -**`device_types`** *array* *of Enums* -Required: No +**`device_types`** ** *of Enums* Array of device types by which to filter devices.
@@ -117,22 +109,19 @@ Possible enum values: --- -**`limit`** *number* -Required: No +**`limit`** ** Numerical limit on the number of devices to return. --- -**`manufacturer`** *string* -Required: No +**`manufacturer`** ** Manufacturer by which to filter devices. --- -**`user_identifier_key`** *string* -Required: No +**`user_identifier_key`** ** Your own internal user ID for the user by which to filter devices. diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 4cbb9fb39..df2122226 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -20,8 +20,7 @@ POST /thermostats/off ⇒ { action_attempt } ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index c99fc4769..bd0380b6d 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -20,50 +20,43 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } ## Request Parameters -**`climate_preset_key`** *string* -Required: Yes +**`climate_preset_key`** ** (Required) Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`ends_at`** *string* -Required: Yes +**`ends_at`** ** (Required) Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`starts_at`** *string* -Required: Yes +**`starts_at`** ** (Required) Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`is_override_allowed`** *boolean* -Required: No +**`is_override_allowed`** ** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`max_override_period_minutes`** *number* -Required: No +**`max_override_period_minutes`** ** Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`name`** *string* -Required: No +**`name`** ** User-friendly name to identify the thermostat schedule. diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index b24373440..fe763a56e 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -20,8 +20,7 @@ POST /thermostats/schedules/delete ⇒ void ## Request Parameters -**`thermostat_schedule_id`** *string* -Required: Yes +**`thermostat_schedule_id`** ** (Required) ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 284131cc7..469a0d3db 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -20,8 +20,7 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } ## Request Parameters -**`thermostat_schedule_id`** *string* -Required: Yes +**`thermostat_schedule_id`** ** (Required) ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 65cf92ab2..e89a238f2 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -20,15 +20,13 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`user_identifier_key`** *string* -Required: No +**`user_identifier_key`** ** User identifier key by which to filter the list of returned thermostat schedules. diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 1ce3e8382..cf7791508 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -20,50 +20,43 @@ PATCH /thermostats/schedules/update ⇒ void ## Request Parameters -**`thermostat_schedule_id`** *string* -Required: Yes +**`thermostat_schedule_id`** ** (Required) ID of the desired thermostat schedule. --- -**`climate_preset_key`** *string* -Required: No +**`climate_preset_key`** ** Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- -**`ends_at`** *string* -Required: No +**`ends_at`** ** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`is_override_allowed`** *boolean* -Required: No +**`is_override_allowed`** ** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`max_override_period_minutes`** *number* -Required: No +**`max_override_period_minutes`** ** Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`name`** *string* -Required: No +**`name`** ** User-friendly name to identify the thermostat schedule. --- -**`starts_at`** *string* -Required: No +**`starts_at`** ** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index e051a6f75..e801bee74 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -19,15 +19,13 @@ POST /thermostats/set_fallback_climate_preset ⇒ void ## Request Parameters -**`climate_preset_key`** *string* -Required: Yes +**`climate_preset_key`** ** (Required) Climate preset key of the desired climate preset. --- -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index c89a1607c..7347d5935 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -20,18 +20,15 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) --- -**`fan_mode`** *string* -Required: No +**`fan_mode`** ** --- -**`fan_mode_setting`** *string* -Required: No +**`fan_mode_setting`** ** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 96f47f7af..e92ae5734 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -20,41 +20,35 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`hvac_mode_setting`** *string* -Required: Yes +**`hvac_mode_setting`** ** (Required) --- -**`cooling_set_point_celsius`** *number* -Required: No +**`cooling_set_point_celsius`** ** Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -**`cooling_set_point_fahrenheit`** *number* -Required: No +**`cooling_set_point_fahrenheit`** ** Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- -**`heating_set_point_celsius`** *number* -Required: No +**`heating_set_point_celsius`** ** Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -**`heating_set_point_fahrenheit`** *number* -Required: No +**`heating_set_point_fahrenheit`** ** Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index f900da537..626f9daf0 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -19,36 +19,31 @@ PATCH /thermostats/set_temperature_threshold ⇒ void ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`lower_limit_celsius`** *number* -Required: No +**`lower_limit_celsius`** ** Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- -**`lower_limit_fahrenheit`** *number* -Required: No +**`lower_limit_fahrenheit`** ** Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- -**`upper_limit_celsius`** *number* -Required: No +**`upper_limit_celsius`** ** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. --- -**`upper_limit_fahrenheit`** *number* -Required: No +**`upper_limit_fahrenheit`** ** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 5e685218d..08ca90935 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -19,43 +19,37 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`hvac_mode`** *string* -Required: Yes +**`hvac_mode`** ** (Required) Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate. --- -**`cooling_set_point_celsius`** *number* -Required: No +**`cooling_set_point_celsius`** ** Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. --- -**`cooling_set_point_fahrenheit`** *number* -Required: No +**`cooling_set_point_fahrenheit`** ** Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. --- -**`heating_set_point_celsius`** *number* -Required: No +**`heating_set_point_celsius`** ** Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. --- -**`heating_set_point_fahrenheit`** *number* -Required: No +**`heating_set_point_fahrenheit`** ** Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 59ecb0005..a6f742201 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -19,22 +19,19 @@ POST /thermostats/simulate/temperature_reached ⇒ void ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`temperature_celsius`** *number* -Required: No +**`temperature_celsius`** ** Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. --- -**`temperature_fahrenheit`** *number* -Required: No +**`temperature_fahrenheit`** ** Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index a6b7938f0..24127680f 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -20,71 +20,61 @@ PATCH /thermostats/update_climate_preset ⇒ void ## Request Parameters -**`climate_preset_key`** *string* -Required: Yes +**`climate_preset_key`** ** (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired thermostat device. --- -**`manual_override_allowed`** *boolean* -Required: Yes +**`manual_override_allowed`** ** (Required) Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`cooling_set_point_celsius`** *number* -Required: No +**`cooling_set_point_celsius`** ** 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* -Required: No +**`cooling_set_point_fahrenheit`** ** Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- -**`fan_mode_setting`** *string* -Required: No +**`fan_mode_setting`** ** 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`. --- -**`heating_set_point_celsius`** *number* -Required: No +**`heating_set_point_celsius`** ** 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* -Required: No +**`heating_set_point_fahrenheit`** ** 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`** *string* -Required: No +**`hvac_mode_setting`** ** Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- -**`name`** *string* -Required: No +**`name`** ** User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 2ba453bd2..d45b1e2a3 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -19,15 +19,13 @@ PUT /user_identities/add_acs_user ⇒ void ## Request Parameters -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the desired ACS user. --- -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index dd3719fff..1a8314137 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -19,29 +19,25 @@ POST /user_identities/create ⇒ { user_identity } ## Request Parameters -**`email_address`** *string* -Required: No +**`email_address`** ** Unique email address for the user identity. --- -**`full_name`** *string* -Required: No +**`full_name`** ** Full name of the user associated with the user identity. --- -**`phone_number`** *string* -Required: No +**`phone_number`** ** Unique phone number for the user identity in E.164 format (for example, +15555550100). --- -**`user_identity_key`** *string* -Required: No +**`user_identity_key`** ** Unique key for the user identity. diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index dd225bd66..3e14616a8 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -19,8 +19,7 @@ POST /user_identities/delete ⇒ void ## Request Parameters -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 45dc38233..009140996 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -19,8 +19,7 @@ POST /user_identities/enrollment_automations/delete ⇒ void ## Request Parameters -**`enrollment_automation_id`** *string* -Required: Yes +**`enrollment_automation_id`** ** (Required) ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 32ec0c0d4..8804a15a2 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -20,8 +20,7 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ## Request Parameters -**`enrollment_automation_id`** *string* -Required: Yes +**`enrollment_automation_id`** ** (Required) ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 41bcc953e..e25cbfd0f 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -19,36 +19,31 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation ## Request Parameters -**`credential_manager_acs_system_id`** *string* -Required: Yes +**`credential_manager_acs_system_id`** ** (Required) ID of the desired ACS system that serves as the credential manager. --- -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the desired user identity. --- -**`acs_credential_pool_id`** *string* -Required: No +**`acs_credential_pool_id`** ** ID of the ACS credential pool from which to obtain credentials for the user identity. --- -**`create_credential_manager_user`** *boolean* -Required: No +**`create_credential_manager_user`** ** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. --- -**`credential_manager_acs_user_id`** *string* -Required: No +**`credential_manager_acs_user_id`** ** ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 593c78ab0..1f3b8ab69 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -20,8 +20,7 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: ## Request Parameters -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the user identity for which you want to retrieve all enrollment automations. diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 2326f654d..651ea3a39 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -19,15 +19,13 @@ POST /user_identities/get ⇒ { user_identity } ## Request Parameters -**`user_identity_id`** *string* -Required: No +**`user_identity_id`** ** ID of the desired user identity. --- -**`user_identity_key`** *string* -Required: No +**`user_identity_key`** ** --- diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 260ac9805..8c8c4dac9 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -19,15 +19,13 @@ PUT /user_identities/grant_access_to_device ⇒ void ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired managed device. --- -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 85ccf1d55..6aa640142 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -20,8 +20,7 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ## Request Parameters -**`credential_manager_acs_system_id`** *string* -Required: No +**`credential_manager_acs_system_id`** ** --- diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 57ece2248..ee56e2580 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -19,8 +19,7 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ## Request Parameters -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the user identity for which you want to retrieve all accessible devices. diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index b8d0662d7..dd71f94c8 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -20,8 +20,7 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ## Request Parameters -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the user identity for which you want to retrieve all access control systems. diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index efa6267cf..83bc898ed 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -19,8 +19,7 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ## Request Parameters -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the user identity for which you want to retrieve all ACS users. diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 366183ed0..b255c2909 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -19,15 +19,13 @@ POST /user_identities/remove_acs_user ⇒ void ## Request Parameters -**`acs_user_id`** *string* -Required: Yes +**`acs_user_id`** ** (Required) ID of the ACS user. --- -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index c2e4856dd..f8e1b1c0d 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -19,15 +19,13 @@ POST /user_identities/revoke_access_to_device ⇒ void ## Request Parameters -**`device_id`** *string* -Required: Yes +**`device_id`** ** (Required) ID of the desired managed device. --- -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 6528ed35c..7eacdb3f9 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -19,34 +19,29 @@ PATCH /user_identities/update ⇒ void ## Request Parameters -**`user_identity_id`** *string* -Required: Yes +**`user_identity_id`** ** (Required) ID of the user identity. --- -**`email_address`** *string* -Required: No +**`email_address`** ** Unique email address for the user identity. --- -**`full_name`** *string* -Required: No +**`full_name`** ** --- -**`phone_number`** *string* -Required: No +**`phone_number`** ** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- -**`user_identity_key`** *string* -Required: No +**`user_identity_key`** ** Unique key for the user identity. From 35a61fa37c80eb809802249dbb3a49e7c5f7576b Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 18:56:38 -0400 Subject: [PATCH 152/233] Update api-route.hbs --- src/layouts/api-route.hbs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index d90e3ae92..efecacf7b 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -2,6 +2,12 @@ The {{title}} route contains the following resources: +{{#if resources.length}} +{{#each resources}} +- [`{{name}}`](./#{{name}}) +{{/each}} +{{/if}} + {{#each resources}} {{> api-resource }} {{#if errors.length}} From f5fd6e0b014b984e7bd06c6d5f5499b626314dd8 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 22:57:40 +0000 Subject: [PATCH 153/233] ci: Generate docs --- docs/api/access_codes/README.md | 2 ++ docs/api/acs/access_groups/README.md | 2 ++ docs/api/acs/credentials/README.md | 2 ++ docs/api/acs/encoders/README.md | 2 ++ docs/api/acs/encoders/simulate/README.md | 1 + docs/api/acs/entrances/README.md | 2 ++ docs/api/acs/systems/README.md | 2 ++ docs/api/acs/users/README.md | 2 ++ docs/api/phones/README.md | 2 ++ docs/api/phones/simulate/README.md | 1 + docs/api/thermostats/README.md | 1 + docs/api/thermostats/schedules/README.md | 2 ++ docs/api/thermostats/simulate/README.md | 1 + docs/api/user_identities/README.md | 2 ++ docs/api/user_identities/enrollment_automations/README.md | 2 ++ 15 files changed, 26 insertions(+) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 34b4ad938..c9738efc0 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -2,6 +2,8 @@ The Access Codes route contains the following resources: +- [`access_code`](./#access_code) + ## The `access_code` Resource {% tabs %} diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 3dc21555c..4cc8a9f15 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -2,6 +2,8 @@ The Access Groups route contains the following resources: +- [`acs_access_group`](./#acs_access_group) + ## The `acs_access_group` Resource 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. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index aa839df15..8b87364c9 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -2,6 +2,8 @@ The Credentials route contains the following resources: +- [`acs_credential`](./#acs_credential) + ## The `acs_credential` Resource Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 14f109cf2..7a646c663 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -2,6 +2,8 @@ The Encoders route contains the following resources: +- [`acs_encoder`](./#acs_encoder) + ## The `acs_encoder` Resource Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index 041564aad..988f7da0f 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -2,6 +2,7 @@ The Encoder Simulations route contains the following resources: + ## Endpoints diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 17026d490..72b7ed724 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -2,6 +2,8 @@ The Entrances route contains the following resources: +- [`acs_entrance`](./#acs_entrance) + ## The `acs_entrance` Resource Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 092f0b9ea..7a3ad54e8 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -2,6 +2,8 @@ The Systems route contains the following resources: +- [`acs_system`](./#acs_system) + ## The `acs_system` Resource Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 87b0c819a..a94abc26b 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -2,6 +2,8 @@ The ACS Users route contains the following resources: +- [`acs_user`](./#acs_user) + ## The `acs_user` Resource Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index c8a86769a..275d1229e 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -2,6 +2,8 @@ The Phones route contains the following resources: +- [`phone`](./#phone) + ## The `phone` Resource Represents an app user's mobile phone. diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index 4f2e3d8bb..f025bda7a 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -2,6 +2,7 @@ The Phone Simulations route contains the following resources: + ## Endpoints diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index d32978ee5..c7a28f5d9 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -2,6 +2,7 @@ The Thermostats route contains the following resources: + ## Endpoints diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index bac5f59fe..d56cac0e6 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -2,6 +2,8 @@ The Thermostat Schedules route contains the following resources: +- [`thermostat_schedule`](./#thermostat_schedule) + ## The `thermostat_schedule` Resource Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index 87837884e..b785755d5 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -2,6 +2,7 @@ The Thermostat Simulations route contains the following resources: + ## Endpoints diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 9a6954794..d83a3df5f 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -2,6 +2,8 @@ The User Identities route contains the following resources: +- [`user_identity`](./#user_identity) + ## The `user_identity` Resource Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 6f5e3ada3..036202043 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -2,6 +2,8 @@ The Enrollment Automations route contains the following resources: +- [`enrollment_automation`](./#enrollment_automation) + ## The `enrollment_automation` Resource Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). From 3fe4931088379069a45ff6590ca3e61a3949d4d6 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 18:57:47 -0400 Subject: [PATCH 154/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index c0b9a113b..196892a14 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -8,21 +8,7 @@ ``` {% endhint %} -{{#if authMethods}} -
- -Authentication Methods - -{{#each authMethods}} -- {{this}} -{{#if (eq this 'Personal access token')}} -
{{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} -{{/if}} -{{/each}} -
-{{/if}} - -## Request Parameters +## Parameters {{#if request.parameters.length}} {{#each request.parameters}} @@ -48,6 +34,20 @@ None {{/if}} +{{#if authMethods}} +
+ +Authentication Methods + +{{#each authMethods}} +- {{this}} +{{#if (eq this 'Personal access token')}} +
{{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} +{{/if}} +{{/each}} +
+{{/if}} + ## Return Type {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} From ac11dd3f4fa2b9abf9c8fdffeb177e4ac6da27ba Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 22:58:48 +0000 Subject: [PATCH 155/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 20 ++++++++--------- docs/api/acs/access_groups/get.md | 18 +++++++-------- docs/api/acs/access_groups/list.md | 20 ++++++++--------- .../list_accessible_entrances.md | 18 +++++++-------- docs/api/acs/access_groups/list_users.md | 18 +++++++-------- docs/api/acs/access_groups/remove_user.md | 20 ++++++++--------- docs/api/acs/credentials/assign.md | 20 ++++++++--------- docs/api/acs/credentials/create.md | 20 ++++++++--------- docs/api/acs/credentials/delete.md | 18 +++++++-------- docs/api/acs/credentials/get.md | 18 +++++++-------- docs/api/acs/credentials/list.md | 22 +++++++++---------- .../credentials/list_accessible_entrances.md | 18 +++++++-------- docs/api/acs/credentials/unassign.md | 20 ++++++++--------- docs/api/acs/credentials/update.md | 20 ++++++++--------- docs/api/acs/encoders/encode_credential.md | 20 ++++++++--------- docs/api/acs/encoders/list.md | 20 ++++++++--------- docs/api/acs/encoders/scan_credential.md | 18 +++++++-------- .../next_credential_encode_will_fail.md | 20 ++++++++--------- .../next_credential_encode_will_succeed.md | 20 ++++++++--------- .../next_credential_scan_will_fail.md | 20 ++++++++--------- .../next_credential_scan_will_succeed.md | 20 ++++++++--------- docs/api/acs/entrances/get.md | 14 ++++++------ docs/api/acs/entrances/grant_access.md | 20 ++++++++--------- docs/api/acs/entrances/list.md | 22 +++++++++---------- .../entrances/list_credentials_with_access.md | 22 +++++++++---------- docs/api/acs/systems/get.md | 18 +++++++-------- docs/api/acs/systems/list.md | 18 +++++++-------- ...mpatible_credential_manager_acs_systems.md | 18 +++++++-------- docs/api/acs/users/add_to_access_group.md | 20 ++++++++--------- docs/api/acs/users/create.md | 20 ++++++++--------- docs/api/acs/users/delete.md | 18 +++++++-------- docs/api/acs/users/get.md | 18 +++++++-------- docs/api/acs/users/list.md | 22 +++++++++---------- .../acs/users/list_accessible_entrances.md | 18 +++++++-------- .../api/acs/users/remove_from_access_group.md | 20 ++++++++--------- .../users/revoke_access_to_all_entrances.md | 18 +++++++-------- docs/api/acs/users/suspend.md | 18 +++++++-------- docs/api/acs/users/unsuspend.md | 18 +++++++-------- docs/api/acs/users/update.md | 20 ++++++++--------- docs/api/phones/deactivate.md | 18 +++++++-------- docs/api/phones/get.md | 18 +++++++-------- docs/api/phones/list.md | 20 ++++++++--------- .../phones/simulate/create_sandbox_phone.md | 20 ++++++++--------- .../thermostats/activate_climate_preset.md | 20 ++++++++--------- docs/api/thermostats/cool.md | 22 +++++++++---------- docs/api/thermostats/create_climate_preset.md | 22 +++++++++---------- docs/api/thermostats/delete_climate_preset.md | 22 +++++++++---------- docs/api/thermostats/heat.md | 22 +++++++++---------- docs/api/thermostats/heat_cool.md | 22 +++++++++---------- docs/api/thermostats/list.md | 22 +++++++++---------- docs/api/thermostats/off.md | 18 +++++++-------- docs/api/thermostats/schedules/create.md | 22 +++++++++---------- docs/api/thermostats/schedules/delete.md | 18 +++++++-------- docs/api/thermostats/schedules/get.md | 18 +++++++-------- docs/api/thermostats/schedules/list.md | 22 +++++++++---------- docs/api/thermostats/schedules/update.md | 22 +++++++++---------- .../set_fallback_climate_preset.md | 20 ++++++++--------- docs/api/thermostats/set_fan_mode.md | 22 +++++++++---------- docs/api/thermostats/set_hvac_mode.md | 22 +++++++++---------- .../thermostats/set_temperature_threshold.md | 20 ++++++++--------- .../simulate/hvac_mode_adjusted.md | 20 ++++++++--------- .../simulate/temperature_reached.md | 20 ++++++++--------- docs/api/thermostats/update_climate_preset.md | 22 +++++++++---------- docs/api/user_identities/add_acs_user.md | 20 ++++++++--------- docs/api/user_identities/create.md | 20 ++++++++--------- docs/api/user_identities/delete.md | 18 +++++++-------- .../enrollment_automations/delete.md | 18 +++++++-------- .../enrollment_automations/get.md | 18 +++++++-------- .../enrollment_automations/launch.md | 20 ++++++++--------- .../enrollment_automations/list.md | 18 +++++++-------- docs/api/user_identities/get.md | 20 ++++++++--------- .../user_identities/grant_access_to_device.md | 20 ++++++++--------- docs/api/user_identities/list.md | 14 ++++++------ .../list_accessible_devices.md | 18 +++++++-------- docs/api/user_identities/list_acs_systems.md | 18 +++++++-------- docs/api/user_identities/list_acs_users.md | 18 +++++++-------- docs/api/user_identities/remove_acs_user.md | 20 ++++++++--------- .../revoke_access_to_device.md | 20 ++++++++--------- docs/api/user_identities/update.md | 20 ++++++++--------- 79 files changed, 772 insertions(+), 772 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index b2327c7fe..ecba211a4 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -8,16 +8,7 @@ PUT /acs/access_groups/add_user ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_access_group_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired user. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 0721d711d..30b2bf584 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -8,6 +8,15 @@ POST /acs/access_groups/get ⇒ { acs_access_group } ``` {% endhint %} +## Parameters + +**`acs_access_group_id`** ** (Required) + +ID of the desired access group. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/access_groups/get ⇒ { acs_access_group }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_access_group_id`** ** (Required) - -ID of the desired access group. - ---- - - ## Return Type [acs\_access\_group](./) diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 4596bff72..9a625a9fa 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -8,16 +8,7 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_system_id`** ** @@ -32,6 +23,15 @@ ID of the user for which you want to retrieve all access groups. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type Array<[acs\_access\_group](./)> diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index df914feff..f875f1bdd 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -8,6 +8,15 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr ``` {% endhint %} +## Parameters + +**`acs_access_group_id`** ** (Required) + +ID of the access group for which you want to retrieve all accessible entrances. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_access_group_id`** ** (Required) - -ID of the access group for which you want to retrieve all accessible entrances. - ---- - - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 8d4b6f6a4..8fc754218 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -8,6 +8,15 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ``` {% endhint %} +## Parameters + +**`acs_access_group_id`** ** (Required) + +ID of the access group for which you want to retrieve all users. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_access_group_id`** ** (Required) - -ID of the access group for which you want to retrieve all users. - ---- - - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index fbe804632..cd96b838d 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -8,16 +8,7 @@ POST /acs/access_groups/remove_user ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_access_group_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired user. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 5f41ad2eb..7b522138d 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -8,16 +8,7 @@ PATCH /acs/credentials/assign ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_credential_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired user. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 62fdab80a..c17a32e3e 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -8,16 +8,7 @@ POST /acs/credentials/create ⇒ { acs_credential } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`access_method`** ** (Required) @@ -86,6 +77,15 @@ Visionline-specific metadata for the new credential. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index a68064d45..2b0cb06cd 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -8,6 +8,15 @@ POST /acs/credentials/delete ⇒ void ``` {% endhint %} +## Parameters + +**`acs_credential_id`** ** (Required) + +ID of the desired credential. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/credentials/delete ⇒ void
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_credential_id`** ** (Required) - -ID of the desired credential. - ---- - - ## Return Type void diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index f5b6734f5..b9fff7112 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -8,6 +8,15 @@ POST /acs/credentials/get ⇒ { acs_credential } ``` {% endhint %} +## Parameters + +**`acs_credential_id`** ** (Required) + +ID of the desired credential. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/credentials/get ⇒ { acs_credential }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_credential_id`** ** (Required) - -ID of the desired credential. - ---- - - ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index fdfe052e1..c59c3913f 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -8,17 +8,7 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_system_id`** ** @@ -57,6 +47,16 @@ ID of the user identity for which you want to retrieve all credentials. --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 2d591f54e..072961a58 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -8,6 +8,15 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran ``` {% endhint %} +## Parameters + +**`acs_credential_id`** ** (Required) + +ID of the credential for which you want to retrieve all entrances to which this credential grants access. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_credential_id`** ** (Required) - -ID of the credential for which you want to retrieve all entrances to which this credential grants access. - ---- - - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 7b0907160..9dbce54cf 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -8,16 +8,7 @@ PATCH /acs/credentials/unassign ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_credential_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired user. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index e29b30408..0ab11cabb 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -8,16 +8,7 @@ PATCH /acs/credentials/update ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_credential_id`** ** (Required) @@ -38,6 +29,15 @@ Replacement date and time at which the validity of the credential ends, in [ISO --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 526818e3f..a3179b0c1 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -8,16 +8,7 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_credential_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 70cbbb3fc..32bd8ef3d 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -8,16 +8,7 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_encoder_ids`** ** *of UUIDs* @@ -44,6 +35,15 @@ Number of `acs_encoders` to return. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type Array<[acs\_encoder](./)> diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 695c161d2..1749077e6 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -8,6 +8,15 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt } ``` {% endhint %} +## Parameters + +**`acs_encoder_id`** ** (Required) + +ID of the `acs_encoder` to use for the scan. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_encoder_id`** ** (Required) - -ID of the `acs_encoder` to use for the scan. - ---- - - ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 533d4fd73..31b856824 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -8,16 +8,7 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_encoder_id`** ** (Required) @@ -38,6 +29,15 @@ Code of the error to simulate. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index ee4ab35ff..a5e70cdbf 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -8,16 +8,7 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_encoder_id`** ** (Required) @@ -32,6 +23,15 @@ Scenario to simulate. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index a4b8a8775..aa0441db7 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -8,16 +8,7 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_encoder_id`** ** (Required) @@ -34,6 +25,15 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index ae6f1b236..02960bb58 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -8,16 +8,7 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_encoder_id`** ** (Required) @@ -38,6 +29,15 @@ Scenario to simulate. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index f93fabc2a..d26d4dc8f 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -8,6 +8,13 @@ POST /acs/entrances/get ⇒ { acs_entrance } ``` {% endhint %} +## Parameters + +**`acs_entrance_id`** ** (Required) + +--- + +
Authentication Methods @@ -16,13 +23,6 @@ POST /acs/entrances/get ⇒ { acs_entrance } - Client session token
-## Request Parameters - -**`acs_entrance_id`** ** (Required) - ---- - - ## Return Type [acs\_entrance](./) diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 160000196..28c7c68c7 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -8,16 +8,7 @@ POST /acs/entrances/grant_access ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_entrance_id`** ** (Required) @@ -28,6 +19,15 @@ POST /acs/entrances/grant_access ⇒ void --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 8c1d4b02b..6f8b4a737 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -8,17 +8,7 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_credential_id`** ** @@ -29,6 +19,16 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index cde547fbe..1a126c41b 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -8,17 +8,7 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_entrance_id`** ** (Required) @@ -36,6 +26,16 @@ Possible enum values: --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 72c029a7a..2a3882e5b 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -10,6 +10,15 @@ POST /acs/systems/get ⇒ { acs_system } ``` {% endhint %} +## Parameters + +**`acs_system_id`** ** (Required) + +ID of the desired access control system. + +--- + +
Authentication Methods @@ -19,15 +28,6 @@ POST /acs/systems/get ⇒ { acs_system }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_system_id`** ** (Required) - -ID of the desired access control system. - ---- - - ## Return Type [acs\_system](./) diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index eb80b527f..a067f8bd8 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -10,6 +10,15 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ``` {% endhint %} +## Parameters + +**`connected_account_id`** ** + +ID of the connected account by which to filter the list of returned access control systems. + +--- + +
Authentication Methods @@ -20,15 +29,6 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`connected_account_id`** ** - -ID of the connected account by which to filter the list of returned access control systems. - ---- - - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 354ca3973..0aac91fa2 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -12,6 +12,15 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste ``` {% endhint %} +## Parameters + +**`acs_system_id`** ** (Required) + +ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. + +--- + +
Authentication Methods @@ -21,15 +30,6 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_system_id`** ** (Required) - -ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. - ---- - - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index e274271c9..365f14ee8 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -8,16 +8,7 @@ PUT /acs/users/add_to_access_group ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_access_group_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired `acs_user`. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 24023f25f..abc389d3a 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -8,16 +8,7 @@ POST /acs/users/create ⇒ { acs_user } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_system_id`** ** (Required) @@ -66,6 +57,15 @@ ID of the user identity with which to associate the new `acs_user`. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index e9b637d00..43c50fbe6 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -8,6 +8,15 @@ POST /acs/users/delete ⇒ void ``` {% endhint %} +## Parameters + +**`acs_user_id`** ** (Required) + +ID of the desired `acs_user`. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/users/delete ⇒ void
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_user_id`** ** (Required) - -ID of the desired `acs_user`. - ---- - - ## Return Type void diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 4f33d703f..ea7bf4552 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -8,6 +8,15 @@ POST /acs/users/get ⇒ { acs_user } ``` {% endhint %} +## Parameters + +**`acs_user_id`** ** (Required) + +ID of the desired `acs_user`. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/users/get ⇒ { acs_user }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_user_id`** ** (Required) - -ID of the desired `acs_user`. - ---- - - ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index cfcc512f0..30b54aca9 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -8,17 +8,7 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_system_id`** ** @@ -67,6 +57,16 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 752b0d822..4a624eeba 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -8,6 +8,15 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, ``` {% endhint %} +## Parameters + +**`acs_user_id`** ** (Required) + +ID of the desired `acs_user`. + +--- + +
Authentication Methods @@ -18,15 +27,6 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance,
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_user_id`** ** (Required) - -ID of the desired `acs_user`. - ---- - - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index d168db59b..f1e83f6d2 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -8,16 +8,7 @@ POST /acs/users/remove_from_access_group ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_access_group_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired `acs_user`. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 335e91e1f..444b58548 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -8,6 +8,15 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void ``` {% endhint %} +## Parameters + +**`acs_user_id`** ** (Required) + +ID of the desired `acs_user`. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_user_id`** ** (Required) - -ID of the desired `acs_user`. - ---- - - ## Return Type void diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 3547ac710..dd35f1a25 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -8,6 +8,15 @@ POST /acs/users/suspend ⇒ void ``` {% endhint %} +## Parameters + +**`acs_user_id`** ** (Required) + +ID of the desired `acs_user`. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/users/suspend ⇒ void
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_user_id`** ** (Required) - -ID of the desired `acs_user`. - ---- - - ## Return Type void diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index dc9b3edcd..b3290b37a 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -8,6 +8,15 @@ POST /acs/users/unsuspend ⇒ void ``` {% endhint %} +## Parameters + +**`acs_user_id`** ** (Required) + +ID of the desired `acs_user`. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /acs/users/unsuspend ⇒ void
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`acs_user_id`** ** (Required) - -ID of the desired `acs_user`. - ---- - - ## Return Type void diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index f8942898a..873b561bb 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -8,16 +8,7 @@ PATCH /acs/users/update ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_user_id`** ** (Required) @@ -58,6 +49,15 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 7d413e61a..7ea9d854e 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -8,6 +8,15 @@ POST /phones/deactivate ⇒ void ``` {% endhint %} +## Parameters + +**`device_id`** ** (Required) + +Device ID of the desired phone. + +--- + +
Authentication Methods @@ -18,15 +27,6 @@ POST /phones/deactivate ⇒ void
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`device_id`** ** (Required) - -Device ID of the desired phone. - ---- - - ## Return Type void diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 5d264802e..f3b2a3311 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -8,6 +8,15 @@ POST /phones/get ⇒ { phone } ``` {% endhint %} +## Parameters + +**`device_id`** ** (Required) + +Device ID of the desired phone. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /phones/get ⇒ { phone }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`device_id`** ** (Required) - -Device ID of the desired phone. - ---- - - ## Return Type [phone](./) diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index ef58b3fac..85bf086a7 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -8,16 +8,7 @@ POST /phones/list ⇒ { phones: [phone, …] } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_credential_id`** ** @@ -32,6 +23,15 @@ ID of the user identity that represents the owner by which to filter the list of --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type Array<[phone](./)> diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 4db1388fc..1f3375fa5 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -8,16 +8,7 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`user_identity_id`** ** (Required) @@ -44,6 +35,15 @@ Metadata to associate with the simulated phone. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [phone](./) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index fd31e97ae..7f2a34504 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -8,16 +8,7 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`climate_preset_key`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired thermostat device. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 49a29ac52..74ac3cb2d 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -8,17 +8,7 @@ POST /thermostats/cool ⇒ { action_attempt } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -39,6 +29,16 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 1f3477176..d9545d2b3 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -8,17 +8,7 @@ POST /thermostats/create_climate_preset ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`climate_preset_key`** ** (Required) @@ -81,6 +71,16 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 5002f1990..8b31afb0d 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -8,17 +8,7 @@ POST /thermostats/delete_climate_preset ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`climate_preset_key`** ** (Required) @@ -33,6 +23,16 @@ ID of the desired thermostat device. --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index af16b8a18..ba80670f2 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -8,17 +8,7 @@ POST /thermostats/heat ⇒ { action_attempt } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -39,6 +29,16 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index e7bc91143..0cf08b9d1 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -8,17 +8,7 @@ POST /thermostats/heat_cool ⇒ { action_attempt } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -51,6 +41,16 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 537524876..fa6acaf31 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -8,17 +8,7 @@ POST /thermostats/list ⇒ { devices: [device, …] } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`connect_webview_id`** ** @@ -128,6 +118,16 @@ Your own internal user ID for the user by which to filter devices. --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type Array<[device](./)> diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index df2122226..3a9bb3578 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -8,6 +8,15 @@ POST /thermostats/off ⇒ { action_attempt } ``` {% endhint %} +## Parameters + +**`device_id`** ** (Required) + +ID of the desired thermostat device. + +--- + +
Authentication Methods @@ -18,15 +27,6 @@ POST /thermostats/off ⇒ { action_attempt }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`device_id`** ** (Required) - -ID of the desired thermostat device. - ---- - - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index bd0380b6d..7b0dfc171 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -8,17 +8,7 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`climate_preset_key`** ** (Required) @@ -63,6 +53,16 @@ User-friendly name to identify the thermostat schedule. --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index fe763a56e..7e847f5b1 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -8,6 +8,15 @@ POST /thermostats/schedules/delete ⇒ void ``` {% endhint %} +## Parameters + +**`thermostat_schedule_id`** ** (Required) + +ID of the desired thermostat schedule. + +--- + +
Authentication Methods @@ -18,15 +27,6 @@ POST /thermostats/schedules/delete ⇒ void
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`thermostat_schedule_id`** ** (Required) - -ID of the desired thermostat schedule. - ---- - - ## Return Type void diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 469a0d3db..f4f2a4377 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -8,6 +8,15 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } ``` {% endhint %} +## Parameters + +**`thermostat_schedule_id`** ** (Required) + +ID of the desired thermostat schedule. + +--- + +
Authentication Methods @@ -18,15 +27,6 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`thermostat_schedule_id`** ** (Required) - -ID of the desired thermostat schedule. - ---- - - ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index e89a238f2..870d0ac47 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -8,17 +8,7 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -33,6 +23,16 @@ User identifier key by which to filter the list of returned thermostat schedules --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type Array<[thermostat\_schedule](./)> diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index cf7791508..98a235d5b 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -8,17 +8,7 @@ PATCH /thermostats/schedules/update ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`thermostat_schedule_id`** ** (Required) @@ -63,6 +53,16 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index e801bee74..4a04d32f8 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -8,16 +8,7 @@ POST /thermostats/set_fallback_climate_preset ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`climate_preset_key`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired thermostat device. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 7347d5935..ca77c0706 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -8,17 +8,7 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -35,6 +25,16 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index e92ae5734..b46b9f4e9 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -8,17 +8,7 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -55,6 +45,16 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 626f9daf0..96962a06b 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -8,16 +8,7 @@ PATCH /thermostats/set_temperature_threshold ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -50,6 +41,15 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 08ca90935..38d85a7cc 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -8,16 +8,7 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -56,6 +47,15 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index a6f742201..237983c12 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -8,16 +8,7 @@ POST /thermostats/simulate/temperature_reached ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -38,6 +29,15 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 24127680f..766577ef0 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -8,17 +8,7 @@ PATCH /thermostats/update_climate_preset ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`climate_preset_key`** ** (Required) @@ -81,6 +71,16 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index d45b1e2a3..95284961f 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -8,16 +8,7 @@ PUT /user_identities/add_acs_user ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_user_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired user identity. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 1a8314137..c18b3bd3c 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -8,16 +8,7 @@ POST /user_identities/create ⇒ { user_identity } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`email_address`** ** @@ -44,6 +35,15 @@ Unique key for the user identity. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 3e14616a8..976f4f8c9 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -8,6 +8,15 @@ POST /user_identities/delete ⇒ void ``` {% endhint %} +## Parameters + +**`user_identity_id`** ** (Required) + +ID of the desired user identity. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /user_identities/delete ⇒ void
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`user_identity_id`** ** (Required) - -ID of the desired user identity. - ---- - - ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 009140996..1710a9e65 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -8,6 +8,15 @@ POST /user_identities/enrollment_automations/delete ⇒ void ``` {% endhint %} +## Parameters + +**`enrollment_automation_id`** ** (Required) + +ID of the desired enrollment automation. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /user_identities/enrollment_automations/delete ⇒ void
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`enrollment_automation_id`** ** (Required) - -ID of the desired enrollment automation. - ---- - - ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 8804a15a2..c41232807 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -8,6 +8,15 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ``` {% endhint %} +## Parameters + +**`enrollment_automation_id`** ** (Required) + +ID of the desired enrollment automation. + +--- + +
Authentication Methods @@ -18,15 +27,6 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`enrollment_automation_id`** ** (Required) - -ID of the desired enrollment automation. - ---- - - ## Return Type [enrollment\_automation](./) diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index e25cbfd0f..52f2d184a 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -8,16 +8,7 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`credential_manager_acs_system_id`** ** (Required) @@ -50,6 +41,15 @@ ID of the associated ACS user within the credential manager. If you specify a `c --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [unknown](./) diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 1f3b8ab69..17feae81f 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -8,6 +8,15 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: ``` {% endhint %} +## Parameters + +**`user_identity_id`** ** (Required) + +ID of the user identity for which you want to retrieve all enrollment automations. + +--- + +
Authentication Methods @@ -18,15 +27,6 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations:
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`user_identity_id`** ** (Required) - -ID of the user identity for which you want to retrieve all enrollment automations. - ---- - - ## Return Type Array<[enrollment\_automation](./)> diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 651ea3a39..b423b093f 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -8,16 +8,7 @@ POST /user_identities/get ⇒ { user_identity } ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`user_identity_id`** ** @@ -30,6 +21,15 @@ ID of the desired user identity. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 8c8c4dac9..23de7683f 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -8,16 +8,7 @@ PUT /user_identities/grant_access_to_device ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired user identity. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 6aa640142..61f072a5e 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -8,6 +8,13 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ``` {% endhint %} +## Parameters + +**`credential_manager_acs_system_id`** ** + +--- + +
Authentication Methods @@ -18,13 +25,6 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`credential_manager_acs_system_id`** ** - ---- - - ## Return Type Array<[user\_identity](./)> diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index ee56e2580..7adba860c 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -8,6 +8,15 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ``` {% endhint %} +## Parameters + +**`user_identity_id`** ** (Required) + +ID of the user identity for which you want to retrieve all accessible devices. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`user_identity_id`** ** (Required) - -ID of the user identity for which you want to retrieve all accessible devices. - ---- - - ## Return Type Array<[device](./)> diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index dd71f94c8..201ea314a 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -8,6 +8,15 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` {% endhint %} +## Parameters + +**`user_identity_id`** ** (Required) + +ID of the user identity for which you want to retrieve all access control systems. + +--- + +
Authentication Methods @@ -18,15 +27,6 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`user_identity_id`** ** (Required) - -ID of the user identity for which you want to retrieve all access control systems. - ---- - - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 83bc898ed..9ce62b026 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -8,6 +8,15 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ``` {% endhint %} +## Parameters + +**`user_identity_id`** ** (Required) + +ID of the user identity for which you want to retrieve all ACS users. + +--- + +
Authentication Methods @@ -17,15 +26,6 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] }
Must also include the `seam-workspace` header in the request.
-## Request Parameters - -**`user_identity_id`** ** (Required) - -ID of the user identity for which you want to retrieve all ACS users. - ---- - - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index b255c2909..3308a58b3 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -8,16 +8,7 @@ POST /user_identities/remove_acs_user ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`acs_user_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired user identity. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index f8e1b1c0d..73dd6384e 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -8,16 +8,7 @@ POST /user_identities/revoke_access_to_device ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`device_id`** ** (Required) @@ -32,6 +23,15 @@ ID of the desired user identity. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 7eacdb3f9..548f9451a 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -8,16 +8,7 @@ PATCH /user_identities/update ⇒ void ``` {% endhint %} -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- -## Request Parameters +## Parameters **`user_identity_id`** ** (Required) @@ -48,6 +39,15 @@ Unique key for the user identity. --- +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Return Type void From a6ea7c5f9a70044591be2feaf5ab1a9cd9783ff3 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 18:59:08 -0400 Subject: [PATCH 156/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 1 - 1 file changed, 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 196892a14..9c55b8776 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -47,7 +47,6 @@ None {{/each}}
{{/if}} - ## Return Type {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} From 6763530a5c9387d34eba27ef8f687a384e3fca2f Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 23:00:09 +0000 Subject: [PATCH 157/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 1 - docs/api/acs/access_groups/get.md | 1 - docs/api/acs/access_groups/list.md | 1 - docs/api/acs/access_groups/list_accessible_entrances.md | 1 - docs/api/acs/access_groups/list_users.md | 1 - docs/api/acs/access_groups/remove_user.md | 1 - docs/api/acs/credentials/assign.md | 1 - docs/api/acs/credentials/create.md | 1 - docs/api/acs/credentials/delete.md | 1 - docs/api/acs/credentials/get.md | 1 - docs/api/acs/credentials/list.md | 1 - docs/api/acs/credentials/list_accessible_entrances.md | 1 - docs/api/acs/credentials/unassign.md | 1 - docs/api/acs/credentials/update.md | 1 - docs/api/acs/encoders/encode_credential.md | 1 - docs/api/acs/encoders/list.md | 1 - docs/api/acs/encoders/scan_credential.md | 1 - .../acs/encoders/simulate/next_credential_encode_will_fail.md | 1 - .../acs/encoders/simulate/next_credential_encode_will_succeed.md | 1 - docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md | 1 - .../acs/encoders/simulate/next_credential_scan_will_succeed.md | 1 - docs/api/acs/entrances/get.md | 1 - docs/api/acs/entrances/grant_access.md | 1 - docs/api/acs/entrances/list.md | 1 - docs/api/acs/entrances/list_credentials_with_access.md | 1 - docs/api/acs/systems/get.md | 1 - docs/api/acs/systems/list.md | 1 - .../systems/list_compatible_credential_manager_acs_systems.md | 1 - docs/api/acs/users/add_to_access_group.md | 1 - docs/api/acs/users/create.md | 1 - docs/api/acs/users/delete.md | 1 - docs/api/acs/users/get.md | 1 - docs/api/acs/users/list.md | 1 - docs/api/acs/users/list_accessible_entrances.md | 1 - docs/api/acs/users/remove_from_access_group.md | 1 - docs/api/acs/users/revoke_access_to_all_entrances.md | 1 - docs/api/acs/users/suspend.md | 1 - docs/api/acs/users/unsuspend.md | 1 - docs/api/acs/users/update.md | 1 - docs/api/phones/deactivate.md | 1 - docs/api/phones/get.md | 1 - docs/api/phones/list.md | 1 - docs/api/phones/simulate/create_sandbox_phone.md | 1 - docs/api/thermostats/activate_climate_preset.md | 1 - docs/api/thermostats/cool.md | 1 - docs/api/thermostats/create_climate_preset.md | 1 - docs/api/thermostats/delete_climate_preset.md | 1 - docs/api/thermostats/heat.md | 1 - docs/api/thermostats/heat_cool.md | 1 - docs/api/thermostats/list.md | 1 - docs/api/thermostats/off.md | 1 - docs/api/thermostats/schedules/create.md | 1 - docs/api/thermostats/schedules/delete.md | 1 - docs/api/thermostats/schedules/get.md | 1 - docs/api/thermostats/schedules/list.md | 1 - docs/api/thermostats/schedules/update.md | 1 - docs/api/thermostats/set_fallback_climate_preset.md | 1 - docs/api/thermostats/set_fan_mode.md | 1 - docs/api/thermostats/set_hvac_mode.md | 1 - docs/api/thermostats/set_temperature_threshold.md | 1 - docs/api/thermostats/simulate/hvac_mode_adjusted.md | 1 - docs/api/thermostats/simulate/temperature_reached.md | 1 - docs/api/thermostats/update_climate_preset.md | 1 - docs/api/user_identities/add_acs_user.md | 1 - docs/api/user_identities/create.md | 1 - docs/api/user_identities/delete.md | 1 - docs/api/user_identities/enrollment_automations/delete.md | 1 - docs/api/user_identities/enrollment_automations/get.md | 1 - docs/api/user_identities/enrollment_automations/launch.md | 1 - docs/api/user_identities/enrollment_automations/list.md | 1 - docs/api/user_identities/get.md | 1 - docs/api/user_identities/grant_access_to_device.md | 1 - docs/api/user_identities/list.md | 1 - docs/api/user_identities/list_accessible_devices.md | 1 - docs/api/user_identities/list_acs_systems.md | 1 - docs/api/user_identities/list_acs_users.md | 1 - docs/api/user_identities/remove_acs_user.md | 1 - docs/api/user_identities/revoke_access_to_device.md | 1 - docs/api/user_identities/update.md | 1 - 79 files changed, 79 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index ecba211a4..26a195fdd 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -31,7 +31,6 @@ ID of the desired user. - Personal access token
Must also include the `seam-workspace` header in the request.
- ## Return Type void diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 30b2bf584..6f6bdc785 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -25,7 +25,6 @@ ID of the desired access group. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [acs\_access\_group](./) diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 9a625a9fa..d8db13425 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -31,7 +31,6 @@ ID of the user for which you want to retrieve all access groups. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_access\_group](./)> diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index f875f1bdd..99613e7ac 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -25,7 +25,6 @@ ID of the access group for which you want to retrieve all accessible entrances. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 8fc754218..498029b12 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -25,7 +25,6 @@ ID of the access group for which you want to retrieve all users. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index cd96b838d..75db26a1b 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -31,7 +31,6 @@ ID of the desired user. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 7b522138d..3a80ad9e0 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -31,7 +31,6 @@ ID of the desired user. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index c17a32e3e..d1290f908 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -85,7 +85,6 @@ Visionline-specific metadata for the new credential. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 2b0cb06cd..081f01778 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -25,7 +25,6 @@ ID of the desired credential. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index b9fff7112..ee8d95825 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -25,7 +25,6 @@ ID of the desired credential. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index c59c3913f..0308b3b95 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -56,7 +56,6 @@ ID of the user identity for which you want to retrieve all credentials. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 072961a58..38e698381 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -25,7 +25,6 @@ ID of the credential for which you want to retrieve all entrances to which this - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 9dbce54cf..845183673 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -31,7 +31,6 @@ ID of the desired user. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 0ab11cabb..549604a62 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -37,7 +37,6 @@ Replacement date and time at which the validity of the credential ends, in [ISO - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index a3179b0c1..417675b33 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -31,7 +31,6 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 32bd8ef3d..ed5691217 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -43,7 +43,6 @@ Number of `acs_encoders` to return. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_encoder](./)> diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 1749077e6..c91b86cde 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -25,7 +25,6 @@ ID of the `acs_encoder` to use for the scan. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 31b856824..81efba200 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -37,7 +37,6 @@ Code of the error to simulate. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index a5e70cdbf..0c6eb1b87 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -31,7 +31,6 @@ Scenario to simulate. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index aa0441db7..8466f6ee2 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -33,7 +33,6 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 02960bb58..6830887c0 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -37,7 +37,6 @@ Scenario to simulate. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index d26d4dc8f..874a7fea5 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -22,7 +22,6 @@ POST /acs/entrances/get ⇒ { acs_entrance } - API key - Client session token - ## Return Type [acs\_entrance](./) diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 28c7c68c7..66d4b612c 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -27,7 +27,6 @@ POST /acs/entrances/grant_access ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 6f8b4a737..d75b32935 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -28,7 +28,6 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 1a126c41b..a7095e978 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -35,7 +35,6 @@ Possible enum values: - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 2a3882e5b..9d18acb32 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -27,7 +27,6 @@ ID of the desired access control system. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [acs\_system](./) diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index a067f8bd8..cc316dea3 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -28,7 +28,6 @@ ID of the connected account by which to filter the list of returned access contr - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 0aac91fa2..6f4789262 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -29,7 +29,6 @@ ID of the ACS system for which you want to retrieve all compatible credential ma - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 365f14ee8..e087adaea 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -31,7 +31,6 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index abc389d3a..b3febd2ea 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -65,7 +65,6 @@ ID of the user identity with which to associate the new `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 43c50fbe6..0c92f6710 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -25,7 +25,6 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index ea7bf4552..b5c5433f7 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -25,7 +25,6 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 30b54aca9..78e0edc8f 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -66,7 +66,6 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 4a624eeba..0ba1e50d8 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -26,7 +26,6 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index f1e83f6d2..30726d7af 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -31,7 +31,6 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 444b58548..1370e8aff 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -25,7 +25,6 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index dd35f1a25..5a7e28bd3 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -25,7 +25,6 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index b3290b37a..0c5209bd7 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -25,7 +25,6 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 873b561bb..63001c68f 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -57,7 +57,6 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 7ea9d854e..30c7fb177 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -26,7 +26,6 @@ Device ID of the desired phone. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index f3b2a3311..5be3d535c 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -25,7 +25,6 @@ Device ID of the desired phone. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [phone](./) diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 85bf086a7..4cd04424c 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -31,7 +31,6 @@ ID of the user identity that represents the owner by which to filter the list of - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[phone](./)> diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 1f3375fa5..39bee1aef 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -43,7 +43,6 @@ Metadata to associate with the simulated phone. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [phone](./) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 7f2a34504..d55ad47ff 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -31,7 +31,6 @@ ID of the desired thermostat device. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 74ac3cb2d..831faa866 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -38,7 +38,6 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index d9545d2b3..47d49bb53 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -80,7 +80,6 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 8b31afb0d..cdb262595 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -32,7 +32,6 @@ ID of the desired thermostat device. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index ba80670f2..39291d8c1 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -38,7 +38,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 0cf08b9d1..23c73c3e0 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -50,7 +50,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index fa6acaf31..129816a2c 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -127,7 +127,6 @@ Your own internal user ID for the user by which to filter devices. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[device](./)> diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 3a9bb3578..80f08eb4a 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -26,7 +26,6 @@ ID of the desired thermostat device. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 7b0dfc171..7aa131a58 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -62,7 +62,6 @@ User-friendly name to identify the thermostat schedule. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 7e847f5b1..8ad81ba25 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -26,7 +26,6 @@ ID of the desired thermostat schedule. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index f4f2a4377..4fadafc71 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -26,7 +26,6 @@ ID of the desired thermostat schedule. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 870d0ac47..0150993e3 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -32,7 +32,6 @@ User identifier key by which to filter the list of returned thermostat schedules - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[thermostat\_schedule](./)> diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 98a235d5b..60c6a4a26 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -62,7 +62,6 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 4a04d32f8..7ac9b2f30 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -31,7 +31,6 @@ ID of the desired thermostat device. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index ca77c0706..e01edc2f0 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -34,7 +34,6 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index b46b9f4e9..c3b541f79 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -54,7 +54,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 96962a06b..f3044ed79 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -49,7 +49,6 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 38d85a7cc..39498e508 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -55,7 +55,6 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 237983c12..07f4d9bbd 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -37,7 +37,6 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 766577ef0..2eedc0a84 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -80,7 +80,6 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 95284961f..f908b79ba 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -31,7 +31,6 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index c18b3bd3c..242fbd200 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -43,7 +43,6 @@ Unique key for the user identity. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 976f4f8c9..f29a663c8 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -25,7 +25,6 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 1710a9e65..c3ba9ecfe 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -25,7 +25,6 @@ ID of the desired enrollment automation. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index c41232807..0f9f8cb52 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -26,7 +26,6 @@ ID of the desired enrollment automation. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [enrollment\_automation](./) diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 52f2d184a..706b03134 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -49,7 +49,6 @@ ID of the associated ACS user within the credential manager. If you specify a `c - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [unknown](./) diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 17feae81f..3c28436d3 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -26,7 +26,6 @@ ID of the user identity for which you want to retrieve all enrollment automation - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[enrollment\_automation](./)> diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index b423b093f..2a29c70ab 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -29,7 +29,6 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 23de7683f..78170f3b8 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -31,7 +31,6 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 61f072a5e..ff5f11048 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -24,7 +24,6 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[user\_identity](./)> diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 7adba860c..1a9da430a 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -25,7 +25,6 @@ ID of the user identity for which you want to retrieve all accessible devices. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[device](./)> diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 201ea314a..dba4264e8 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -26,7 +26,6 @@ ID of the user identity for which you want to retrieve all access control system - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 9ce62b026..a7b6ef1c4 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -25,7 +25,6 @@ ID of the user identity for which you want to retrieve all ACS users. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 3308a58b3..302634159 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -31,7 +31,6 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 73dd6384e..89c98a54f 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -31,7 +31,6 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 548f9451a..e6488b303 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -47,7 +47,6 @@ Unique key for the user identity. - Personal access token
Must also include the `seam-workspace` header in the request. - ## Return Type void From 5a295bdf6fba2d605132200d18867276a5ba4ca6 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 19:00:59 -0400 Subject: [PATCH 158/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 9c55b8776..ab3fa4b01 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -12,7 +12,8 @@ {{#if request.parameters.length}} {{#each request.parameters}} -**`{{this.name}}`** *{{this.format}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}}{{#if this.required}} (Required){{/if}} +**`{{this.name}}`** *{{this.format}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}} +{{#if this.required}} (Required){{/if}} {{#if this.description}} {{this.description}} From c94befbaf4841e57498866d6c215aaee0d994e29 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 23:02:06 +0000 Subject: [PATCH 159/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 6 ++++-- docs/api/acs/access_groups/get.md | 3 ++- docs/api/acs/access_groups/list.md | 2 ++ .../access_groups/list_accessible_entrances.md | 3 ++- docs/api/acs/access_groups/list_users.md | 3 ++- docs/api/acs/access_groups/remove_user.md | 6 ++++-- docs/api/acs/credentials/assign.md | 6 ++++-- docs/api/acs/credentials/create.md | 15 +++++++++++++-- docs/api/acs/credentials/delete.md | 3 ++- docs/api/acs/credentials/get.md | 3 ++- docs/api/acs/credentials/list.md | 6 ++++++ .../acs/credentials/list_accessible_entrances.md | 3 ++- docs/api/acs/credentials/unassign.md | 6 ++++-- docs/api/acs/credentials/update.md | 5 ++++- docs/api/acs/encoders/encode_credential.md | 6 ++++-- docs/api/acs/encoders/list.md | 4 ++++ docs/api/acs/encoders/scan_credential.md | 3 ++- .../simulate/next_credential_encode_will_fail.md | 5 ++++- .../next_credential_encode_will_succeed.md | 4 +++- .../simulate/next_credential_scan_will_fail.md | 5 ++++- .../next_credential_scan_will_succeed.md | 5 ++++- docs/api/acs/entrances/get.md | 3 ++- docs/api/acs/entrances/grant_access.md | 6 ++++-- docs/api/acs/entrances/list.md | 2 ++ .../entrances/list_credentials_with_access.md | 4 +++- docs/api/acs/systems/get.md | 3 ++- docs/api/acs/systems/list.md | 1 + ..._compatible_credential_manager_acs_systems.md | 3 ++- docs/api/acs/users/add_to_access_group.md | 6 ++++-- docs/api/acs/users/create.md | 12 ++++++++++-- docs/api/acs/users/delete.md | 3 ++- docs/api/acs/users/get.md | 3 ++- docs/api/acs/users/list.md | 8 ++++++++ docs/api/acs/users/list_accessible_entrances.md | 3 ++- docs/api/acs/users/remove_from_access_group.md | 6 ++++-- .../acs/users/revoke_access_to_all_entrances.md | 3 ++- docs/api/acs/users/suspend.md | 3 ++- docs/api/acs/users/unsuspend.md | 3 ++- docs/api/acs/users/update.md | 9 ++++++++- docs/api/phones/deactivate.md | 3 ++- docs/api/phones/get.md | 3 ++- docs/api/phones/list.md | 2 ++ docs/api/phones/simulate/create_sandbox_phone.md | 6 +++++- docs/api/thermostats/activate_climate_preset.md | 6 ++++-- docs/api/thermostats/cool.md | 5 ++++- docs/api/thermostats/create_climate_preset.md | 14 ++++++++++++-- docs/api/thermostats/delete_climate_preset.md | 6 ++++-- docs/api/thermostats/heat.md | 5 ++++- docs/api/thermostats/heat_cool.md | 7 ++++++- docs/api/thermostats/list.md | 11 +++++++++++ docs/api/thermostats/off.md | 3 ++- docs/api/thermostats/schedules/create.md | 15 +++++++++++---- docs/api/thermostats/schedules/delete.md | 3 ++- docs/api/thermostats/schedules/get.md | 3 ++- docs/api/thermostats/schedules/list.md | 4 +++- docs/api/thermostats/schedules/update.md | 9 ++++++++- .../thermostats/set_fallback_climate_preset.md | 6 ++++-- docs/api/thermostats/set_fan_mode.md | 5 ++++- docs/api/thermostats/set_hvac_mode.md | 10 ++++++++-- .../api/thermostats/set_temperature_threshold.md | 7 ++++++- .../thermostats/simulate/hvac_mode_adjusted.md | 10 ++++++++-- .../thermostats/simulate/temperature_reached.md | 5 ++++- docs/api/thermostats/update_climate_preset.md | 16 +++++++++++++--- docs/api/user_identities/add_acs_user.md | 6 ++++-- docs/api/user_identities/create.md | 4 ++++ docs/api/user_identities/delete.md | 3 ++- .../enrollment_automations/delete.md | 3 ++- .../enrollment_automations/get.md | 3 ++- .../enrollment_automations/launch.md | 9 +++++++-- .../enrollment_automations/list.md | 3 ++- docs/api/user_identities/get.md | 2 ++ .../user_identities/grant_access_to_device.md | 6 ++++-- docs/api/user_identities/list.md | 1 + .../user_identities/list_accessible_devices.md | 3 ++- docs/api/user_identities/list_acs_systems.md | 3 ++- docs/api/user_identities/list_acs_users.md | 3 ++- docs/api/user_identities/remove_acs_user.md | 6 ++++-- .../user_identities/revoke_access_to_device.md | 6 ++++-- docs/api/user_identities/update.md | 7 ++++++- 79 files changed, 321 insertions(+), 94 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 26a195fdd..615cb10a4 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -10,13 +10,15 @@ PUT /acs/access_groups/add_user ⇒ void ## Parameters -**`acs_access_group_id`** ** (Required) +**`acs_access_group_id`** ** + (Required) ID of the desired access group. --- -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired user. diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 6f6bdc785..67e5c6a88 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -10,7 +10,8 @@ POST /acs/access_groups/get ⇒ { acs_access_group } ## Parameters -**`acs_access_group_id`** ** (Required) +**`acs_access_group_id`** ** + (Required) ID of the desired access group. diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index d8db13425..8e6859ade 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -12,12 +12,14 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } **`acs_system_id`** ** + ID of the access control system for which you want to retrieve all access groups. --- **`acs_user_id`** ** + ID of the user for which you want to retrieve all access groups. --- diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 99613e7ac..165c7241a 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -10,7 +10,8 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr ## Parameters -**`acs_access_group_id`** ** (Required) +**`acs_access_group_id`** ** + (Required) ID of the access group for which you want to retrieve all accessible entrances. diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 498029b12..c3dd64f54 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -10,7 +10,8 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ## Parameters -**`acs_access_group_id`** ** (Required) +**`acs_access_group_id`** ** + (Required) ID of the access group for which you want to retrieve all users. diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 75db26a1b..bc77ff061 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -10,13 +10,15 @@ POST /acs/access_groups/remove_user ⇒ void ## Parameters -**`acs_access_group_id`** ** (Required) +**`acs_access_group_id`** ** + (Required) ID of the desired access group. --- -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired user. diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 3a80ad9e0..6aded158e 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -10,13 +10,15 @@ PATCH /acs/credentials/assign ⇒ void ## Parameters -**`acs_credential_id`** ** (Required) +**`acs_credential_id`** ** + (Required) ID of the desired credential. --- -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired user. diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index d1290f908..bff84e4f5 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -10,13 +10,15 @@ POST /acs/credentials/create ⇒ { acs_credential } ## Parameters -**`access_method`** ** (Required) +**`access_method`** ** + (Required) Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. --- -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the ACS user to whom the new credential belongs. @@ -24,54 +26,63 @@ ID of the ACS user to whom the new credential belongs. **`allowed_acs_entrance_ids`** ** *of UUIDs* + Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. --- **`assa_abloy_vostio_metadata`** ** + Vostio-specific metadata for the new credential. --- **`code`** ** + Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). --- **`credential_manager_acs_system_id`** ** + ACS system ID of the credential manager for the new credential. --- **`ends_at`** ** + Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- **`is_multi_phone_sync_credential`** ** + Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- **`salto_space_metadata`** ** + Salto Space-specific metadata for the new credential. --- **`starts_at`** ** + Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- **`visionline_metadata`** ** + Visionline-specific metadata for the new credential. --- diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 081f01778..3ff42d699 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -10,7 +10,8 @@ POST /acs/credentials/delete ⇒ void ## Parameters -**`acs_credential_id`** ** (Required) +**`acs_credential_id`** ** + (Required) ID of the desired credential. diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index ee8d95825..1b368171a 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -10,7 +10,8 @@ POST /acs/credentials/get ⇒ { acs_credential } ## Parameters -**`acs_credential_id`** ** (Required) +**`acs_credential_id`** ** + (Required) ID of the desired credential. diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 0308b3b95..217295edb 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -12,36 +12,42 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } **`acs_system_id`** ** + ID of the access control system for which you want to retrieve all credentials. --- **`acs_user_id`** ** + ID of the ACS user for which you want to retrieve all credentials. --- **`created_before`** ** + Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. --- **`is_multi_phone_sync_credential`** ** + Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. --- **`limit`** ** + Number of credentials to return. --- **`user_identity_id`** ** + ID of the user identity for which you want to retrieve all credentials. --- diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 38e698381..193f6f5b9 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -10,7 +10,8 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran ## Parameters -**`acs_credential_id`** ** (Required) +**`acs_credential_id`** ** + (Required) ID of the credential for which you want to retrieve all entrances to which this credential grants access. diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 845183673..123bd2168 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -10,13 +10,15 @@ PATCH /acs/credentials/unassign ⇒ void ## Parameters -**`acs_credential_id`** ** (Required) +**`acs_credential_id`** ** + (Required) ID of the desired credential. --- -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired user. diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 549604a62..3b0e8bd64 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -10,7 +10,8 @@ PATCH /acs/credentials/update ⇒ void ## Parameters -**`acs_credential_id`** ** (Required) +**`acs_credential_id`** ** + (Required) ID of the desired credential. @@ -18,12 +19,14 @@ ID of the desired credential. **`code`** ** + Replacement access (PIN) code for the credential. --- **`ends_at`** ** + Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. --- diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 417675b33..0ca52fe0a 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -10,13 +10,15 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt } ## Parameters -**`acs_credential_id`** ** (Required) +**`acs_credential_id`** ** + (Required) ID of the `acs_credential` to encode onto a card. --- -**`acs_encoder_id`** ** (Required) +**`acs_encoder_id`** ** + (Required) ID of the `acs_encoder` to use to encode the `acs_credential`. diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index ed5691217..8bd349269 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -12,24 +12,28 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } **`acs_encoder_ids`** ** *of UUIDs* + IDs of the `acs_encoder`s that you want to retrieve. --- **`acs_system_id`** ** + ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. --- **`acs_system_ids`** ** *of UUIDs* + IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. --- **`limit`** ** + Number of `acs_encoders` to return. --- diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index c91b86cde..11f91aee7 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -10,7 +10,8 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt } ## Parameters -**`acs_encoder_id`** ** (Required) +**`acs_encoder_id`** ** + (Required) ID of the `acs_encoder` to use for the scan. diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 81efba200..981f95cf9 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -10,7 +10,8 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ## Parameters -**`acs_encoder_id`** ** (Required) +**`acs_encoder_id`** ** + (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. @@ -18,12 +19,14 @@ ID of the `acs_encoder` that will be used in the next request to encode the `acs **`acs_credential_id`** ** + ID of the `acs_credential` that will fail to be encoded onto a card in the next request. --- **`error_code`** ** + Code of the error to simulate. --- diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 0c6eb1b87..df5d69310 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -10,7 +10,8 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ## Parameters -**`acs_encoder_id`** ** (Required) +**`acs_encoder_id`** ** + (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. @@ -18,6 +19,7 @@ ID of the `acs_encoder` that will be used in the next request to encode the `acs **`scenario`** ** + Scenario to simulate. --- diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 8466f6ee2..98555a9cc 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -10,7 +10,8 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ## Parameters -**`acs_encoder_id`** ** (Required) +**`acs_encoder_id`** ** + (Required) ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. @@ -18,10 +19,12 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next **`acs_credential_id_on_seam`** ** + --- **`error_code`** ** + --- diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 6830887c0..bf027a07b 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -10,7 +10,8 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ## Parameters -**`acs_encoder_id`** ** (Required) +**`acs_encoder_id`** ** + (Required) ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. @@ -18,12 +19,14 @@ ID of the `acs_encoder` that will be used in the next request to scan the `acs_c **`acs_credential_id_on_seam`** ** + ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. --- **`scenario`** ** + Scenario to simulate. --- diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 874a7fea5..0576adb6d 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -10,7 +10,8 @@ POST /acs/entrances/get ⇒ { acs_entrance } ## Parameters -**`acs_entrance_id`** ** (Required) +**`acs_entrance_id`** ** + (Required) --- diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 66d4b612c..db43b46f6 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -10,11 +10,13 @@ POST /acs/entrances/grant_access ⇒ void ## Parameters -**`acs_entrance_id`** ** (Required) +**`acs_entrance_id`** ** + (Required) --- -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index d75b32935..b6bafbb00 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -12,10 +12,12 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } **`acs_credential_id`** ** + --- **`acs_system_id`** ** + --- diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index a7095e978..be0fd364f 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -10,11 +10,13 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre ## Parameters -**`acs_entrance_id`** ** (Required) +**`acs_entrance_id`** ** + (Required) --- **`include_if`** ** *of Enums* +
Enum values diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 9d18acb32..6775f332b 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -12,7 +12,8 @@ POST /acs/systems/get ⇒ { acs_system } ## Parameters -**`acs_system_id`** ** (Required) +**`acs_system_id`** ** + (Required) ID of the desired access control system. diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index cc316dea3..482496758 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -14,6 +14,7 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } **`connected_account_id`** ** + ID of the connected account by which to filter the list of returned access control systems. --- diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 6f4789262..212e62106 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -14,7 +14,8 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste ## Parameters -**`acs_system_id`** ** (Required) +**`acs_system_id`** ** + (Required) ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index e087adaea..4e1820d4b 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -10,13 +10,15 @@ PUT /acs/users/add_to_access_group ⇒ void ## Parameters -**`acs_access_group_id`** ** (Required) +**`acs_access_group_id`** ** + (Required) ID of the desired access group. --- -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index b3febd2ea..1213257a6 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -10,13 +10,15 @@ POST /acs/users/create ⇒ { acs_user } ## Parameters -**`acs_system_id`** ** (Required) +**`acs_system_id`** ** + (Required) ID of the `acs_system` to which to add the new `acs_user`. --- -**`full_name`** ** (Required) +**`full_name`** ** + (Required) Full name of the new `acs_user`. @@ -24,34 +26,40 @@ Full name of the new `acs_user`. **`access_schedule`** ** + `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. --- **`acs_access_group_ids`** ** *of UUIDs* + Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. --- **`email`** ** + --- **`email_address`** ** + Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- **`phone_number`** ** + Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- **`user_identity_id`** ** + ID of the user identity with which to associate the new `acs_user`. --- diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 0c92f6710..1b44f6484 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -10,7 +10,8 @@ POST /acs/users/delete ⇒ void ## Parameters -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index b5c5433f7..b8d2cd4c6 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -10,7 +10,8 @@ POST /acs/users/get ⇒ { acs_user } ## Parameters -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 78e0edc8f..23b2b2786 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -12,46 +12,54 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } **`acs_system_id`** ** + ID of the `acs_system` for which you want to retrieve all `acs_user`s. --- **`created_before`** ** + --- **`limit`** ** + Maximum number of records to return per page. --- **`page_cursor`** ** + Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. --- **`search`** ** + String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, or `email_address`. --- **`user_identity_email_address`** ** + Email address of the user identity for which you want to retrieve all `acs_user`s. --- **`user_identity_id`** ** + ID of the user identity for which you want to retrieve all `acs_user`s. --- **`user_identity_phone_number`** ** + Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). --- diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 0ba1e50d8..fd1d6c16f 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -10,7 +10,8 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, ## Parameters -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 30726d7af..90983ea3f 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -10,13 +10,15 @@ POST /acs/users/remove_from_access_group ⇒ void ## Parameters -**`acs_access_group_id`** ** (Required) +**`acs_access_group_id`** ** + (Required) ID of the desired access group. --- -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 1370e8aff..01e271607 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -10,7 +10,8 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void ## Parameters -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 5a7e28bd3..69a35f488 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -10,7 +10,8 @@ POST /acs/users/suspend ⇒ void ## Parameters -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 0c5209bd7..0ef0a4546 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -10,7 +10,8 @@ POST /acs/users/unsuspend ⇒ void ## Parameters -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 63001c68f..2a943131a 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -10,7 +10,8 @@ PATCH /acs/users/update ⇒ void ## Parameters -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). @@ -18,32 +19,38 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system **`access_schedule`** ** + `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. --- **`email`** ** + --- **`email_address`** ** + Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- **`full_name`** ** + Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- **`hid_acs_system_id`** ** + --- **`phone_number`** ** + Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 30c7fb177..88d6035b5 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -10,7 +10,8 @@ POST /phones/deactivate ⇒ void ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) Device ID of the desired phone. diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 5be3d535c..1ec16f595 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -10,7 +10,8 @@ POST /phones/get ⇒ { phone } ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) Device ID of the desired phone. diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 4cd04424c..d538e509c 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -12,12 +12,14 @@ POST /phones/list ⇒ { phones: [phone, …] } **`acs_credential_id`** ** + ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. --- **`owner_user_identity_id`** ** + ID of the user identity that represents the owner by which to filter the list of returned phones. --- diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 39bee1aef..297c55362 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -10,7 +10,8 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone } ## Parameters -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the user identity to associate with the simulated phone. @@ -18,18 +19,21 @@ ID of the user identity to associate with the simulated phone. **`assa_abloy_metadata`** ** + ASSA ABLOY metadata to associate with the simulated phone. --- **`custom_sdk_installation_id`** ** + ID of the custom SDK installation to use for the simulated phone. --- **`phone_metadata`** ** + Metadata to associate with the simulated phone. --- diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index d55ad47ff..3a382e757 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -10,13 +10,15 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } ## Parameters -**`climate_preset_key`** ** (Required) +**`climate_preset_key`** ** + (Required) Climate preset key of the desired climate preset. --- -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 831faa866..3f1b6b2d1 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -10,7 +10,8 @@ POST /thermostats/cool ⇒ { action_attempt } ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. @@ -18,12 +19,14 @@ ID of the desired thermostat device. **`cooling_set_point_celsius`** ** + Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- **`cooling_set_point_fahrenheit`** ** + Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 47d49bb53..81d315334 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -10,13 +10,15 @@ POST /thermostats/create_climate_preset ⇒ void ## Parameters -**`climate_preset_key`** ** (Required) +**`climate_preset_key`** ** + (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. @@ -24,48 +26,56 @@ ID of the desired thermostat device. **`cooling_set_point_celsius`** ** + 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`** ** + Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- **`fan_mode_setting`** ** + 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`. --- **`heating_set_point_celsius`** ** + 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`** ** + 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`** ** + Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- **`manual_override_allowed`** ** + Indicates whether a person at the thermostat or using the API can change the thermostat's settings. --- **`name`** ** + User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index cdb262595..0e26f9118 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -10,13 +10,15 @@ POST /thermostats/delete_climate_preset ⇒ void ## Parameters -**`climate_preset_key`** ** (Required) +**`climate_preset_key`** ** + (Required) Climate preset key of the desired climate preset. --- -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 39291d8c1..190a04d13 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -10,7 +10,8 @@ POST /thermostats/heat ⇒ { action_attempt } ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. @@ -18,12 +19,14 @@ ID of the desired thermostat device. **`heating_set_point_celsius`** ** + Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- **`heating_set_point_fahrenheit`** ** + Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. --- diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 23c73c3e0..5231230de 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -10,7 +10,8 @@ POST /thermostats/heat_cool ⇒ { action_attempt } ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. @@ -18,24 +19,28 @@ ID of the desired thermostat device. **`cooling_set_point_celsius`** ** + Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- **`cooling_set_point_fahrenheit`** ** + Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- **`heating_set_point_celsius`** ** + Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- **`heating_set_point_fahrenheit`** ** + Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. --- diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 129816a2c..e61501151 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -12,48 +12,56 @@ POST /thermostats/list ⇒ { devices: [device, …] } **`connect_webview_id`** ** + ID of the Connect Webview by which to filter devices. --- **`connected_account_id`** ** + ID of the connected account by which to filter. --- **`connected_account_ids`** ** *of UUIDs* + Array of IDs of the connected accounts by which to filter devices. --- **`created_before`** ** + Date threshold for devices to return. If specified, returns only devices created before the specified date. --- **`custom_metadata_has`** ** + Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. --- **`device_ids`** ** *of UUIDs* + Array of device IDs by which to filter devices. --- **`device_type`** ** + Device type by which to filter devices. --- **`device_types`** ** *of Enums* + Array of device types by which to filter devices.
@@ -101,18 +109,21 @@ Possible enum values: **`limit`** ** + Numerical limit on the number of devices to return. --- **`manufacturer`** ** + Manufacturer by which to filter devices. --- **`user_identifier_key`** ** + Your own internal user ID for the user by which to filter devices. --- diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 80f08eb4a..2be13068b 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -10,7 +10,8 @@ POST /thermostats/off ⇒ { action_attempt } ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 7aa131a58..8b09b15e6 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -10,25 +10,29 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } ## Parameters -**`climate_preset_key`** ** (Required) +**`climate_preset_key`** ** + (Required) Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. --- -**`ends_at`** ** (Required) +**`ends_at`** ** + (Required) Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`starts_at`** ** (Required) +**`starts_at`** ** + (Required) Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. @@ -36,18 +40,21 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www **`is_override_allowed`** ** + Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- **`max_override_period_minutes`** ** + Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- **`name`** ** + User-friendly name to identify the thermostat schedule. --- diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 8ad81ba25..68c7834c9 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -10,7 +10,8 @@ POST /thermostats/schedules/delete ⇒ void ## Parameters -**`thermostat_schedule_id`** ** (Required) +**`thermostat_schedule_id`** ** + (Required) ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 4fadafc71..20233477e 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -10,7 +10,8 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } ## Parameters -**`thermostat_schedule_id`** ** (Required) +**`thermostat_schedule_id`** ** + (Required) ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 0150993e3..2c5213c6e 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -10,7 +10,8 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. @@ -18,6 +19,7 @@ ID of the desired thermostat device. **`user_identifier_key`** ** + User identifier key by which to filter the list of returned thermostat schedules. --- diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 60c6a4a26..225ac5a5e 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -10,7 +10,8 @@ PATCH /thermostats/schedules/update ⇒ void ## Parameters -**`thermostat_schedule_id`** ** (Required) +**`thermostat_schedule_id`** ** + (Required) ID of the desired thermostat schedule. @@ -18,36 +19,42 @@ ID of the desired thermostat schedule. **`climate_preset_key`** ** + Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- **`ends_at`** ** + Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- **`is_override_allowed`** ** + Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- **`max_override_period_minutes`** ** + Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- **`name`** ** + User-friendly name to identify the thermostat schedule. --- **`starts_at`** ** + Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 7ac9b2f30..141d1628d 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -10,13 +10,15 @@ POST /thermostats/set_fallback_climate_preset ⇒ void ## Parameters -**`climate_preset_key`** ** (Required) +**`climate_preset_key`** ** + (Required) Climate preset key of the desired climate preset. --- -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index e01edc2f0..65d7f2975 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -10,16 +10,19 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) --- **`fan_mode`** ** + --- **`fan_mode_setting`** ** + Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. --- diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index c3b541f79..ac223f9c9 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -10,36 +10,42 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. --- -**`hvac_mode_setting`** ** (Required) +**`hvac_mode_setting`** ** + (Required) --- **`cooling_set_point_celsius`** ** + Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- **`cooling_set_point_fahrenheit`** ** + Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- **`heating_set_point_celsius`** ** + Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- **`heating_set_point_fahrenheit`** ** + Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. --- diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index f3044ed79..ffd5c5d3d 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -10,7 +10,8 @@ PATCH /thermostats/set_temperature_threshold ⇒ void ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. @@ -18,24 +19,28 @@ ID of the desired thermostat device. **`lower_limit_celsius`** ** + Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- **`lower_limit_fahrenheit`** ** + Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- **`upper_limit_celsius`** ** + Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. --- **`upper_limit_fahrenheit`** ** + Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. --- diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 39498e508..4ed8a8cb6 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -10,13 +10,15 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. --- -**`hvac_mode`** ** (Required) +**`hvac_mode`** ** + (Required) Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate. @@ -24,24 +26,28 @@ Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermos **`cooling_set_point_celsius`** ** + Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. --- **`cooling_set_point_fahrenheit`** ** + Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. --- **`heating_set_point_celsius`** ** + Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. --- **`heating_set_point_fahrenheit`** ** + Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. --- diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 07f4d9bbd..b818e2800 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -10,7 +10,8 @@ POST /thermostats/simulate/temperature_reached ⇒ void ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. @@ -18,12 +19,14 @@ ID of the desired thermostat device. **`temperature_celsius`** ** + Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. --- **`temperature_fahrenheit`** ** + Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. --- diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 2eedc0a84..b18208f97 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -10,19 +10,22 @@ PATCH /thermostats/update_climate_preset ⇒ void ## Parameters -**`climate_preset_key`** ** (Required) +**`climate_preset_key`** ** + (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired thermostat device. --- -**`manual_override_allowed`** ** (Required) +**`manual_override_allowed`** ** + (Required) Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). @@ -30,42 +33,49 @@ Indicates whether a person at the thermostat can change the thermostat's setting **`cooling_set_point_celsius`** ** + 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`** ** + Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). --- **`fan_mode_setting`** ** + 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`. --- **`heating_set_point_celsius`** ** + 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`** ** + 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`** ** + Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- **`name`** ** + User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index f908b79ba..fcfa57552 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -10,13 +10,15 @@ PUT /user_identities/add_acs_user ⇒ void ## Parameters -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the desired ACS user. --- -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 242fbd200..ec9a4cf47 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -12,24 +12,28 @@ POST /user_identities/create ⇒ { user_identity } **`email_address`** ** + Unique email address for the user identity. --- **`full_name`** ** + Full name of the user associated with the user identity. --- **`phone_number`** ** + Unique phone number for the user identity in E.164 format (for example, +15555550100). --- **`user_identity_key`** ** + Unique key for the user identity. --- diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index f29a663c8..16a32645f 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -10,7 +10,8 @@ POST /user_identities/delete ⇒ void ## Parameters -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index c3ba9ecfe..6194e4d60 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -10,7 +10,8 @@ POST /user_identities/enrollment_automations/delete ⇒ void ## Parameters -**`enrollment_automation_id`** ** (Required) +**`enrollment_automation_id`** ** + (Required) ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 0f9f8cb52..bf0f7a411 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -10,7 +10,8 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ## Parameters -**`enrollment_automation_id`** ** (Required) +**`enrollment_automation_id`** ** + (Required) ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 706b03134..b42e89a1e 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -10,13 +10,15 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation ## Parameters -**`credential_manager_acs_system_id`** ** (Required) +**`credential_manager_acs_system_id`** ** + (Required) ID of the desired ACS system that serves as the credential manager. --- -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the desired user identity. @@ -24,18 +26,21 @@ ID of the desired user identity. **`acs_credential_pool_id`** ** + ID of the ACS credential pool from which to obtain credentials for the user identity. --- **`create_credential_manager_user`** ** + Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. --- **`credential_manager_acs_user_id`** ** + ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. --- diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 3c28436d3..4f05f610b 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -10,7 +10,8 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: ## Parameters -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the user identity for which you want to retrieve all enrollment automations. diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 2a29c70ab..8d9457a59 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -12,12 +12,14 @@ POST /user_identities/get ⇒ { user_identity } **`user_identity_id`** ** + ID of the desired user identity. --- **`user_identity_key`** ** + --- diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 78170f3b8..690c2430f 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -10,13 +10,15 @@ PUT /user_identities/grant_access_to_device ⇒ void ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired managed device. --- -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index ff5f11048..3df3cc1a9 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -12,6 +12,7 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } **`credential_manager_acs_system_id`** ** + --- diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 1a9da430a..b1437509d 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -10,7 +10,8 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ## Parameters -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the user identity for which you want to retrieve all accessible devices. diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index dba4264e8..0be4e1c51 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -10,7 +10,8 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ## Parameters -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the user identity for which you want to retrieve all access control systems. diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index a7b6ef1c4..a7f0e3516 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -10,7 +10,8 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ## Parameters -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the user identity for which you want to retrieve all ACS users. diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 302634159..fd3f70c6c 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -10,13 +10,15 @@ POST /user_identities/remove_acs_user ⇒ void ## Parameters -**`acs_user_id`** ** (Required) +**`acs_user_id`** ** + (Required) ID of the ACS user. --- -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 89c98a54f..1097fdd06 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -10,13 +10,15 @@ POST /user_identities/revoke_access_to_device ⇒ void ## Parameters -**`device_id`** ** (Required) +**`device_id`** ** + (Required) ID of the desired managed device. --- -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index e6488b303..49433b7b7 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -10,7 +10,8 @@ PATCH /user_identities/update ⇒ void ## Parameters -**`user_identity_id`** ** (Required) +**`user_identity_id`** ** + (Required) ID of the user identity. @@ -18,22 +19,26 @@ ID of the user identity. **`email_address`** ** + Unique email address for the user identity. --- **`full_name`** ** + --- **`phone_number`** ** + Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- **`user_identity_key`** ** + Unique key for the user identity. --- From bd4f239b7aae34c279e89c6682cf72652c91a858 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 19:03:25 -0400 Subject: [PATCH 160/233] Update api-endpoint.ts --- src/lib/layout/api-endpoint.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts index 523a82c5c..4f9d41e1e 100644 --- a/src/lib/layout/api-endpoint.ts +++ b/src/lib/layout/api-endpoint.ts @@ -108,7 +108,7 @@ export function setEndpointLayoutContext( name: param.name, required: param.isRequired, description: param.description, - jsonType: param.jsonType, + jsonType: normalizePropertyFormatForDocs(param.jsonType), ...(param.jsonType === 'array' && { itemFormat: normalizePropertyFormatForDocs(param.itemFormat), ...(param.itemFormat === 'enum' && { From 50ce1a1a2a3f64d652a56cf90e162d2f7bac01d5 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 19:03:51 -0400 Subject: [PATCH 161/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index ab3fa4b01..a51907c70 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -12,8 +12,7 @@ {{#if request.parameters.length}} {{#each request.parameters}} -**`{{this.name}}`** *{{this.format}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}} -{{#if this.required}} (Required){{/if}} +**`{{this.name}}`** *{{this.jsonType}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}}{{#if this.required}} (Required){{/if}} {{#if this.description}} {{this.description}} From 122caa90e9b3f683b06e7a3657e49ced1d7eec91 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 23:04:51 +0000 Subject: [PATCH 162/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 6 ++-- docs/api/acs/access_groups/get.md | 3 +- docs/api/acs/access_groups/list.md | 6 ++-- .../list_accessible_entrances.md | 3 +- docs/api/acs/access_groups/list_users.md | 3 +- docs/api/acs/access_groups/remove_user.md | 6 ++-- docs/api/acs/credentials/assign.md | 6 ++-- docs/api/acs/credentials/create.md | 33 +++++++------------ docs/api/acs/credentials/delete.md | 3 +- docs/api/acs/credentials/get.md | 3 +- docs/api/acs/credentials/list.md | 18 ++++------ .../credentials/list_accessible_entrances.md | 3 +- docs/api/acs/credentials/unassign.md | 6 ++-- docs/api/acs/credentials/update.md | 9 ++--- docs/api/acs/encoders/encode_credential.md | 6 ++-- docs/api/acs/encoders/list.md | 12 +++---- docs/api/acs/encoders/scan_credential.md | 3 +- .../next_credential_encode_will_fail.md | 9 ++--- .../next_credential_encode_will_succeed.md | 6 ++-- .../next_credential_scan_will_fail.md | 9 ++--- .../next_credential_scan_will_succeed.md | 9 ++--- docs/api/acs/entrances/get.md | 3 +- docs/api/acs/entrances/grant_access.md | 6 ++-- docs/api/acs/entrances/list.md | 6 ++-- .../entrances/list_credentials_with_access.md | 6 ++-- docs/api/acs/systems/get.md | 3 +- docs/api/acs/systems/list.md | 3 +- ...mpatible_credential_manager_acs_systems.md | 3 +- docs/api/acs/users/add_to_access_group.md | 6 ++-- docs/api/acs/users/create.md | 24 +++++--------- docs/api/acs/users/delete.md | 3 +- docs/api/acs/users/get.md | 3 +- docs/api/acs/users/list.md | 24 +++++--------- .../acs/users/list_accessible_entrances.md | 3 +- .../api/acs/users/remove_from_access_group.md | 6 ++-- .../users/revoke_access_to_all_entrances.md | 3 +- docs/api/acs/users/suspend.md | 3 +- docs/api/acs/users/unsuspend.md | 3 +- docs/api/acs/users/update.md | 21 ++++-------- docs/api/phones/deactivate.md | 3 +- docs/api/phones/get.md | 3 +- docs/api/phones/list.md | 6 ++-- .../phones/simulate/create_sandbox_phone.md | 12 +++---- .../thermostats/activate_climate_preset.md | 6 ++-- docs/api/thermostats/cool.md | 9 ++--- docs/api/thermostats/create_climate_preset.md | 30 ++++++----------- docs/api/thermostats/delete_climate_preset.md | 6 ++-- docs/api/thermostats/heat.md | 9 ++--- docs/api/thermostats/heat_cool.md | 15 +++------ docs/api/thermostats/list.md | 33 +++++++------------ docs/api/thermostats/off.md | 3 +- docs/api/thermostats/schedules/create.md | 21 ++++-------- docs/api/thermostats/schedules/delete.md | 3 +- docs/api/thermostats/schedules/get.md | 3 +- docs/api/thermostats/schedules/list.md | 6 ++-- docs/api/thermostats/schedules/update.md | 21 ++++-------- .../set_fallback_climate_preset.md | 6 ++-- docs/api/thermostats/set_fan_mode.md | 9 ++--- docs/api/thermostats/set_hvac_mode.md | 18 ++++------ .../thermostats/set_temperature_threshold.md | 15 +++------ .../simulate/hvac_mode_adjusted.md | 18 ++++------ .../simulate/temperature_reached.md | 9 ++--- docs/api/thermostats/update_climate_preset.md | 30 ++++++----------- docs/api/user_identities/add_acs_user.md | 6 ++-- docs/api/user_identities/create.md | 12 +++---- docs/api/user_identities/delete.md | 3 +- .../enrollment_automations/delete.md | 3 +- .../enrollment_automations/get.md | 3 +- .../enrollment_automations/launch.md | 15 +++------ .../enrollment_automations/list.md | 3 +- docs/api/user_identities/get.md | 6 ++-- .../user_identities/grant_access_to_device.md | 6 ++-- docs/api/user_identities/list.md | 3 +- .../list_accessible_devices.md | 3 +- docs/api/user_identities/list_acs_systems.md | 3 +- docs/api/user_identities/list_acs_users.md | 3 +- docs/api/user_identities/remove_acs_user.md | 6 ++-- .../revoke_access_to_device.md | 6 ++-- docs/api/user_identities/update.md | 15 +++------ 79 files changed, 227 insertions(+), 454 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 615cb10a4..5b93554eb 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -10,15 +10,13 @@ PUT /acs/access_groups/add_user ⇒ void ## Parameters -**`acs_access_group_id`** ** - (Required) +**`acs_access_group_id`** *String* (Required) ID of the desired access group. --- -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired user. diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 67e5c6a88..a551e0b0b 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -10,8 +10,7 @@ POST /acs/access_groups/get ⇒ { acs_access_group } ## Parameters -**`acs_access_group_id`** ** - (Required) +**`acs_access_group_id`** *String* (Required) ID of the desired access group. diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 8e6859ade..d9c7fcfe6 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -10,15 +10,13 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ## Parameters -**`acs_system_id`** ** - +**`acs_system_id`** *String* ID of the access control system for which you want to retrieve all access groups. --- -**`acs_user_id`** ** - +**`acs_user_id`** *String* ID of the user for which you want to retrieve all access groups. diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 165c7241a..cb025e0b3 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -10,8 +10,7 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr ## Parameters -**`acs_access_group_id`** ** - (Required) +**`acs_access_group_id`** *String* (Required) ID of the access group for which you want to retrieve all accessible entrances. diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index c3dd64f54..219557484 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -10,8 +10,7 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ## Parameters -**`acs_access_group_id`** ** - (Required) +**`acs_access_group_id`** *String* (Required) ID of the access group for which you want to retrieve all users. diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index bc77ff061..394ddd77a 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -10,15 +10,13 @@ POST /acs/access_groups/remove_user ⇒ void ## Parameters -**`acs_access_group_id`** ** - (Required) +**`acs_access_group_id`** *String* (Required) ID of the desired access group. --- -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired user. diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 6aded158e..3e1f33e99 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -10,15 +10,13 @@ PATCH /acs/credentials/assign ⇒ void ## Parameters -**`acs_credential_id`** ** - (Required) +**`acs_credential_id`** *String* (Required) ID of the desired credential. --- -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired user. diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index bff84e4f5..ce5686a5d 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -10,78 +10,67 @@ POST /acs/credentials/create ⇒ { acs_credential } ## Parameters -**`access_method`** ** - (Required) +**`access_method`** *String* (Required) Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. --- -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the ACS user to whom the new credential belongs. --- -**`allowed_acs_entrance_ids`** ** *of UUIDs* - +**`allowed_acs_entrance_ids`** *Array* *of UUIDs* Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. --- -**`assa_abloy_vostio_metadata`** ** - +**`assa_abloy_vostio_metadata`** *Object* Vostio-specific metadata for the new credential. --- -**`code`** ** - +**`code`** *String* Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). --- -**`credential_manager_acs_system_id`** ** - +**`credential_manager_acs_system_id`** *String* ACS system ID of the credential manager for the new credential. --- -**`ends_at`** ** - +**`ends_at`** *String* Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- -**`is_multi_phone_sync_credential`** ** - +**`is_multi_phone_sync_credential`** *Boolean* Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- -**`salto_space_metadata`** ** - +**`salto_space_metadata`** *Object* Salto Space-specific metadata for the new credential. --- -**`starts_at`** ** - +**`starts_at`** *String* Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`visionline_metadata`** ** - +**`visionline_metadata`** *Object* Visionline-specific metadata for the new credential. diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 3ff42d699..2976e3a9d 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -10,8 +10,7 @@ POST /acs/credentials/delete ⇒ void ## Parameters -**`acs_credential_id`** ** - (Required) +**`acs_credential_id`** *String* (Required) ID of the desired credential. diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 1b368171a..fc84f9042 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -10,8 +10,7 @@ POST /acs/credentials/get ⇒ { acs_credential } ## Parameters -**`acs_credential_id`** ** - (Required) +**`acs_credential_id`** *String* (Required) ID of the desired credential. diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 217295edb..30e3abe40 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -10,43 +10,37 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ## Parameters -**`acs_system_id`** ** - +**`acs_system_id`** *String* ID of the access control system for which you want to retrieve all credentials. --- -**`acs_user_id`** ** - +**`acs_user_id`** *String* ID of the ACS user for which you want to retrieve all credentials. --- -**`created_before`** ** - +**`created_before`** *String* Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. --- -**`is_multi_phone_sync_credential`** ** - +**`is_multi_phone_sync_credential`** *Boolean* Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. --- -**`limit`** ** - +**`limit`** *Number* Number of credentials to return. --- -**`user_identity_id`** ** - +**`user_identity_id`** *String* ID of the user identity for which you want to retrieve all credentials. diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 193f6f5b9..1b8d677bd 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -10,8 +10,7 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran ## Parameters -**`acs_credential_id`** ** - (Required) +**`acs_credential_id`** *String* (Required) ID of the credential for which you want to retrieve all entrances to which this credential grants access. diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 123bd2168..4810b554d 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -10,15 +10,13 @@ PATCH /acs/credentials/unassign ⇒ void ## Parameters -**`acs_credential_id`** ** - (Required) +**`acs_credential_id`** *String* (Required) ID of the desired credential. --- -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired user. diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 3b0e8bd64..116065f61 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -10,22 +10,19 @@ PATCH /acs/credentials/update ⇒ void ## Parameters -**`acs_credential_id`** ** - (Required) +**`acs_credential_id`** *String* (Required) ID of the desired credential. --- -**`code`** ** - +**`code`** *String* Replacement access (PIN) code for the credential. --- -**`ends_at`** ** - +**`ends_at`** *String* Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 0ca52fe0a..fec7a86bb 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -10,15 +10,13 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt } ## Parameters -**`acs_credential_id`** ** - (Required) +**`acs_credential_id`** *String* (Required) ID of the `acs_credential` to encode onto a card. --- -**`acs_encoder_id`** ** - (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` to use to encode the `acs_credential`. diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 8bd349269..9f9a19838 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -10,29 +10,25 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ## Parameters -**`acs_encoder_ids`** ** *of UUIDs* - +**`acs_encoder_ids`** *Array* *of UUIDs* IDs of the `acs_encoder`s that you want to retrieve. --- -**`acs_system_id`** ** - +**`acs_system_id`** *String* ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. --- -**`acs_system_ids`** ** *of UUIDs* - +**`acs_system_ids`** *Array* *of UUIDs* IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. --- -**`limit`** ** - +**`limit`** *Number* Number of `acs_encoders` to return. diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 11f91aee7..dfb6fdc44 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -10,8 +10,7 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt } ## Parameters -**`acs_encoder_id`** ** - (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` to use for the scan. diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 981f95cf9..f0701ea07 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -10,22 +10,19 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ## Parameters -**`acs_encoder_id`** ** - (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- -**`acs_credential_id`** ** - +**`acs_credential_id`** *String* ID of the `acs_credential` that will fail to be encoded onto a card in the next request. --- -**`error_code`** ** - +**`error_code`** *String* Code of the error to simulate. diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index df5d69310..098b9c44f 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -10,15 +10,13 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ## Parameters -**`acs_encoder_id`** ** - (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- -**`scenario`** ** - +**`scenario`** *String* Scenario to simulate. diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 98555a9cc..559e95684 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -10,20 +10,17 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ## Parameters -**`acs_encoder_id`** ** - (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. --- -**`acs_credential_id_on_seam`** ** - +**`acs_credential_id_on_seam`** *String* --- -**`error_code`** ** - +**`error_code`** *String* --- diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index bf027a07b..66d5659f7 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -10,22 +10,19 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ## Parameters -**`acs_encoder_id`** ** - (Required) +**`acs_encoder_id`** *String* (Required) ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. --- -**`acs_credential_id_on_seam`** ** - +**`acs_credential_id_on_seam`** *String* ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. --- -**`scenario`** ** - +**`scenario`** *String* Scenario to simulate. diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 0576adb6d..41d1d8f04 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -10,8 +10,7 @@ POST /acs/entrances/get ⇒ { acs_entrance } ## Parameters -**`acs_entrance_id`** ** - (Required) +**`acs_entrance_id`** *String* (Required) --- diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index db43b46f6..c43328dec 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -10,13 +10,11 @@ POST /acs/entrances/grant_access ⇒ void ## Parameters -**`acs_entrance_id`** ** - (Required) +**`acs_entrance_id`** *String* (Required) --- -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index b6bafbb00..2e84dd5ba 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -10,13 +10,11 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ## Parameters -**`acs_credential_id`** ** - +**`acs_credential_id`** *String* --- -**`acs_system_id`** ** - +**`acs_system_id`** *String* --- diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index be0fd364f..a759fc5c9 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -10,13 +10,11 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre ## Parameters -**`acs_entrance_id`** ** - (Required) +**`acs_entrance_id`** *String* (Required) --- -**`include_if`** ** *of Enums* - +**`include_if`** *Array* *of Enums*
Enum values diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 6775f332b..bb5428e23 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -12,8 +12,7 @@ POST /acs/systems/get ⇒ { acs_system } ## Parameters -**`acs_system_id`** ** - (Required) +**`acs_system_id`** *String* (Required) ID of the desired access control system. diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 482496758..9f3be5b8e 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -12,8 +12,7 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ## Parameters -**`connected_account_id`** ** - +**`connected_account_id`** *String* ID of the connected account by which to filter the list of returned access control systems. diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 212e62106..e1cff430c 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -14,8 +14,7 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste ## Parameters -**`acs_system_id`** ** - (Required) +**`acs_system_id`** *String* (Required) ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 4e1820d4b..afbbda6e6 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -10,15 +10,13 @@ PUT /acs/users/add_to_access_group ⇒ void ## Parameters -**`acs_access_group_id`** ** - (Required) +**`acs_access_group_id`** *String* (Required) ID of the desired access group. --- -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 1213257a6..e16c75af7 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -10,55 +10,47 @@ POST /acs/users/create ⇒ { acs_user } ## Parameters -**`acs_system_id`** ** - (Required) +**`acs_system_id`** *String* (Required) ID of the `acs_system` to which to add the new `acs_user`. --- -**`full_name`** ** - (Required) +**`full_name`** *String* (Required) Full name of the new `acs_user`. --- -**`access_schedule`** ** - +**`access_schedule`** *Object* `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. --- -**`acs_access_group_ids`** ** *of UUIDs* - +**`acs_access_group_ids`** *Array* *of UUIDs* Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. --- -**`email`** ** - +**`email`** *String* --- -**`email_address`** ** - +**`email_address`** *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`phone_number`** ** - +**`phone_number`** *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -**`user_identity_id`** ** - +**`user_identity_id`** *String* ID of the user identity with which to associate the new `acs_user`. diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 1b44f6484..a1fdd8ba7 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -10,8 +10,7 @@ POST /acs/users/delete ⇒ void ## Parameters -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index b8d2cd4c6..6b5073dd8 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -10,8 +10,7 @@ POST /acs/users/get ⇒ { acs_user } ## Parameters -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 23b2b2786..a26c1ec7d 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -10,55 +10,47 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ## Parameters -**`acs_system_id`** ** - +**`acs_system_id`** *String* ID of the `acs_system` for which you want to retrieve all `acs_user`s. --- -**`created_before`** ** - +**`created_before`** *String* --- -**`limit`** ** - +**`limit`** *Number* Maximum number of records to return per page. --- -**`page_cursor`** ** - +**`page_cursor`** *String* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. --- -**`search`** ** - +**`search`** *String* String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, or `email_address`. --- -**`user_identity_email_address`** ** - +**`user_identity_email_address`** *String* Email address of the user identity for which you want to retrieve all `acs_user`s. --- -**`user_identity_id`** ** - +**`user_identity_id`** *String* ID of the user identity for which you want to retrieve all `acs_user`s. --- -**`user_identity_phone_number`** ** - +**`user_identity_phone_number`** *String* Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index fd1d6c16f..9fcbb4fdb 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -10,8 +10,7 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, ## Parameters -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 90983ea3f..42dcf2268 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -10,15 +10,13 @@ POST /acs/users/remove_from_access_group ⇒ void ## Parameters -**`acs_access_group_id`** ** - (Required) +**`acs_access_group_id`** *String* (Required) ID of the desired access group. --- -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 01e271607..93553e08e 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -10,8 +10,7 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void ## Parameters -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 69a35f488..57abc2241 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -10,8 +10,7 @@ POST /acs/users/suspend ⇒ void ## Parameters -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 0ef0a4546..18a95cf00 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -10,8 +10,7 @@ POST /acs/users/unsuspend ⇒ void ## Parameters -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired `acs_user`. diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 2a943131a..9bebf492a 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -10,46 +10,39 @@ PATCH /acs/users/update ⇒ void ## Parameters -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`access_schedule`** ** - +**`access_schedule`** *Object* `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. --- -**`email`** ** - +**`email`** *String* --- -**`email_address`** ** - +**`email_address`** *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`full_name`** ** - +**`full_name`** *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`hid_acs_system_id`** ** - +**`hid_acs_system_id`** *String* --- -**`phone_number`** ** - +**`phone_number`** *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 88d6035b5..8900fe167 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -10,8 +10,7 @@ POST /phones/deactivate ⇒ void ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) Device ID of the desired phone. diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 1ec16f595..e5babbb82 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -10,8 +10,7 @@ POST /phones/get ⇒ { phone } ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) Device ID of the desired phone. diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index d538e509c..d3d57537a 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -10,15 +10,13 @@ POST /phones/list ⇒ { phones: [phone, …] } ## Parameters -**`acs_credential_id`** ** - +**`acs_credential_id`** *String* ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. --- -**`owner_user_identity_id`** ** - +**`owner_user_identity_id`** *String* ID of the user identity that represents the owner by which to filter the list of returned phones. diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 297c55362..edd3ed1f6 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -10,29 +10,25 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone } ## Parameters -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the user identity to associate with the simulated phone. --- -**`assa_abloy_metadata`** ** - +**`assa_abloy_metadata`** *Object* ASSA ABLOY metadata to associate with the simulated phone. --- -**`custom_sdk_installation_id`** ** - +**`custom_sdk_installation_id`** *String* ID of the custom SDK installation to use for the simulated phone. --- -**`phone_metadata`** ** - +**`phone_metadata`** *Object* Metadata to associate with the simulated phone. diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 3a382e757..87d3f0e79 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -10,15 +10,13 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } ## Parameters -**`climate_preset_key`** ** - (Required) +**`climate_preset_key`** *String* (Required) Climate preset key of the desired climate preset. --- -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 3f1b6b2d1..ee50cd1f8 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -10,22 +10,19 @@ POST /thermostats/cool ⇒ { action_attempt } ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`cooling_set_point_celsius`** ** - +**`cooling_set_point_celsius`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -**`cooling_set_point_fahrenheit`** ** - +**`cooling_set_point_fahrenheit`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 81d315334..21d37996b 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -10,71 +10,61 @@ POST /thermostats/create_climate_preset ⇒ void ## Parameters -**`climate_preset_key`** ** - (Required) +**`climate_preset_key`** *String* (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`cooling_set_point_celsius`** ** - +**`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`** ** - +**`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). --- -**`fan_mode_setting`** ** - +**`fan_mode_setting`** *String* 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`. --- -**`heating_set_point_celsius`** ** - +**`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`** ** - +**`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`** ** - +**`hvac_mode_setting`** *String* Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- -**`manual_override_allowed`** ** - +**`manual_override_allowed`** *Boolean* Indicates whether a person at the thermostat or using the API can change the thermostat's settings. --- -**`name`** ** - +**`name`** *String* User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 0e26f9118..80d00d443 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -10,15 +10,13 @@ POST /thermostats/delete_climate_preset ⇒ void ## Parameters -**`climate_preset_key`** ** - (Required) +**`climate_preset_key`** *String* (Required) Climate preset key of the desired climate preset. --- -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 190a04d13..26b7e6ea8 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -10,22 +10,19 @@ POST /thermostats/heat ⇒ { action_attempt } ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`heating_set_point_celsius`** ** - +**`heating_set_point_celsius`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -**`heating_set_point_fahrenheit`** ** - +**`heating_set_point_fahrenheit`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 5231230de..da72f0acd 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -10,36 +10,31 @@ POST /thermostats/heat_cool ⇒ { action_attempt } ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`cooling_set_point_celsius`** ** - +**`cooling_set_point_celsius`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -**`cooling_set_point_fahrenheit`** ** - +**`cooling_set_point_fahrenheit`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- -**`heating_set_point_celsius`** ** - +**`heating_set_point_celsius`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -**`heating_set_point_fahrenheit`** ** - +**`heating_set_point_fahrenheit`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index e61501151..2ec9aa990 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -10,57 +10,49 @@ POST /thermostats/list ⇒ { devices: [device, …] } ## Parameters -**`connect_webview_id`** ** - +**`connect_webview_id`** *String* ID of the Connect Webview by which to filter devices. --- -**`connected_account_id`** ** - +**`connected_account_id`** *String* ID of the connected account by which to filter. --- -**`connected_account_ids`** ** *of UUIDs* - +**`connected_account_ids`** *Array* *of UUIDs* Array of IDs of the connected accounts by which to filter devices. --- -**`created_before`** ** - +**`created_before`** *String* Date threshold for devices to return. If specified, returns only devices created before the specified date. --- -**`custom_metadata_has`** ** - +**`custom_metadata_has`** *Object* Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. --- -**`device_ids`** ** *of UUIDs* - +**`device_ids`** *Array* *of UUIDs* Array of device IDs by which to filter devices. --- -**`device_type`** ** - +**`device_type`** *String* Device type by which to filter devices. --- -**`device_types`** ** *of Enums* - +**`device_types`** *Array* *of Enums* Array of device types by which to filter devices.
@@ -107,22 +99,19 @@ Possible enum values: --- -**`limit`** ** - +**`limit`** *Number* Numerical limit on the number of devices to return. --- -**`manufacturer`** ** - +**`manufacturer`** *String* Manufacturer by which to filter devices. --- -**`user_identifier_key`** ** - +**`user_identifier_key`** *String* Your own internal user ID for the user by which to filter devices. diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 2be13068b..06a4a8029 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -10,8 +10,7 @@ POST /thermostats/off ⇒ { action_attempt } ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 8b09b15e6..f26018b76 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -10,50 +10,43 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } ## Parameters -**`climate_preset_key`** ** - (Required) +**`climate_preset_key`** *String* (Required) Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`ends_at`** ** - (Required) +**`ends_at`** *String* (Required) Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`starts_at`** ** - (Required) +**`starts_at`** *String* (Required) Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`is_override_allowed`** ** - +**`is_override_allowed`** *Boolean* Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`max_override_period_minutes`** ** - +**`max_override_period_minutes`** *Number* Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`name`** ** - +**`name`** *String* User-friendly name to identify the thermostat schedule. diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 68c7834c9..d80b1ad38 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -10,8 +10,7 @@ POST /thermostats/schedules/delete ⇒ void ## Parameters -**`thermostat_schedule_id`** ** - (Required) +**`thermostat_schedule_id`** *String* (Required) ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 20233477e..1dec74ba7 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -10,8 +10,7 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } ## Parameters -**`thermostat_schedule_id`** ** - (Required) +**`thermostat_schedule_id`** *String* (Required) ID of the desired thermostat schedule. diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 2c5213c6e..18d863769 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -10,15 +10,13 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`user_identifier_key`** ** - +**`user_identifier_key`** *String* User identifier key by which to filter the list of returned thermostat schedules. diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 225ac5a5e..30d6799ce 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -10,50 +10,43 @@ PATCH /thermostats/schedules/update ⇒ void ## Parameters -**`thermostat_schedule_id`** ** - (Required) +**`thermostat_schedule_id`** *String* (Required) ID of the desired thermostat schedule. --- -**`climate_preset_key`** ** - +**`climate_preset_key`** *String* Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- -**`ends_at`** ** - +**`ends_at`** *String* Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`is_override_allowed`** ** - +**`is_override_allowed`** *Boolean* Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`max_override_period_minutes`** ** - +**`max_override_period_minutes`** *Number* Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`name`** ** - +**`name`** *String* User-friendly name to identify the thermostat schedule. --- -**`starts_at`** ** - +**`starts_at`** *String* Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 141d1628d..78dc28962 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -10,15 +10,13 @@ POST /thermostats/set_fallback_climate_preset ⇒ void ## Parameters -**`climate_preset_key`** ** - (Required) +**`climate_preset_key`** *String* (Required) Climate preset key of the desired climate preset. --- -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 65d7f2975..2db43a0f7 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -10,18 +10,15 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) --- -**`fan_mode`** ** - +**`fan_mode`** *String* --- -**`fan_mode_setting`** ** - +**`fan_mode_setting`** *String* Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index ac223f9c9..c6d4f4b40 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -10,41 +10,35 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`hvac_mode_setting`** ** - (Required) +**`hvac_mode_setting`** *String* (Required) --- -**`cooling_set_point_celsius`** ** - +**`cooling_set_point_celsius`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- -**`cooling_set_point_fahrenheit`** ** - +**`cooling_set_point_fahrenheit`** *Number* Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- -**`heating_set_point_celsius`** ** - +**`heating_set_point_celsius`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- -**`heating_set_point_fahrenheit`** ** - +**`heating_set_point_fahrenheit`** *Number* Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index ffd5c5d3d..2a7ee204e 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -10,36 +10,31 @@ PATCH /thermostats/set_temperature_threshold ⇒ void ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`lower_limit_celsius`** ** - +**`lower_limit_celsius`** *Number* Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- -**`lower_limit_fahrenheit`** ** - +**`lower_limit_fahrenheit`** *Number* Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- -**`upper_limit_celsius`** ** - +**`upper_limit_celsius`** *Number* Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. --- -**`upper_limit_fahrenheit`** ** - +**`upper_limit_fahrenheit`** *Number* Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 4ed8a8cb6..4b56dced6 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -10,43 +10,37 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`hvac_mode`** ** - (Required) +**`hvac_mode`** *String* (Required) Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate. --- -**`cooling_set_point_celsius`** ** - +**`cooling_set_point_celsius`** *Number* Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. --- -**`cooling_set_point_fahrenheit`** ** - +**`cooling_set_point_fahrenheit`** *Number* Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. --- -**`heating_set_point_celsius`** ** - +**`heating_set_point_celsius`** *Number* Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. --- -**`heating_set_point_fahrenheit`** ** - +**`heating_set_point_fahrenheit`** *Number* Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index b818e2800..4c72ebc37 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -10,22 +10,19 @@ POST /thermostats/simulate/temperature_reached ⇒ void ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`temperature_celsius`** ** - +**`temperature_celsius`** *Number* Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. --- -**`temperature_fahrenheit`** ** - +**`temperature_fahrenheit`** *Number* Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index b18208f97..104a964d3 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -10,71 +10,61 @@ PATCH /thermostats/update_climate_preset ⇒ void ## Parameters -**`climate_preset_key`** ** - (Required) +**`climate_preset_key`** *String* (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired thermostat device. --- -**`manual_override_allowed`** ** - (Required) +**`manual_override_allowed`** *Boolean* (Required) Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`cooling_set_point_celsius`** ** - +**`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`** ** - +**`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). --- -**`fan_mode_setting`** ** - +**`fan_mode_setting`** *String* 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`. --- -**`heating_set_point_celsius`** ** - +**`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`** ** - +**`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`** ** - +**`hvac_mode_setting`** *String* Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- -**`name`** ** - +**`name`** *String* User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index fcfa57552..80636702e 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -10,15 +10,13 @@ PUT /user_identities/add_acs_user ⇒ void ## Parameters -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the desired ACS user. --- -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index ec9a4cf47..1b68a0593 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -10,29 +10,25 @@ POST /user_identities/create ⇒ { user_identity } ## Parameters -**`email_address`** ** - +**`email_address`** *String* Unique email address for the user identity. --- -**`full_name`** ** - +**`full_name`** *String* Full name of the user associated with the user identity. --- -**`phone_number`** ** - +**`phone_number`** *String* Unique phone number for the user identity in E.164 format (for example, +15555550100). --- -**`user_identity_key`** ** - +**`user_identity_key`** *String* Unique key for the user identity. diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 16a32645f..fd56ee87a 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -10,8 +10,7 @@ POST /user_identities/delete ⇒ void ## Parameters -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 6194e4d60..0c4fa1930 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -10,8 +10,7 @@ POST /user_identities/enrollment_automations/delete ⇒ void ## Parameters -**`enrollment_automation_id`** ** - (Required) +**`enrollment_automation_id`** *String* (Required) ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index bf0f7a411..929a65355 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -10,8 +10,7 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ## Parameters -**`enrollment_automation_id`** ** - (Required) +**`enrollment_automation_id`** *String* (Required) ID of the desired enrollment automation. diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index b42e89a1e..3f60cd5aa 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -10,36 +10,31 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation ## Parameters -**`credential_manager_acs_system_id`** ** - (Required) +**`credential_manager_acs_system_id`** *String* (Required) ID of the desired ACS system that serves as the credential manager. --- -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. --- -**`acs_credential_pool_id`** ** - +**`acs_credential_pool_id`** *String* ID of the ACS credential pool from which to obtain credentials for the user identity. --- -**`create_credential_manager_user`** ** - +**`create_credential_manager_user`** *Boolean* Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. --- -**`credential_manager_acs_user_id`** ** - +**`credential_manager_acs_user_id`** *String* ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 4f05f610b..79c379f2d 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -10,8 +10,7 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: ## Parameters -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the user identity for which you want to retrieve all enrollment automations. diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 8d9457a59..5a51bbf76 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -10,15 +10,13 @@ POST /user_identities/get ⇒ { user_identity } ## Parameters -**`user_identity_id`** ** - +**`user_identity_id`** *String* ID of the desired user identity. --- -**`user_identity_key`** ** - +**`user_identity_key`** *String* --- diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 690c2430f..4a99431c7 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -10,15 +10,13 @@ PUT /user_identities/grant_access_to_device ⇒ void ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired managed device. --- -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 3df3cc1a9..5614765eb 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -10,8 +10,7 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ## Parameters -**`credential_manager_acs_system_id`** ** - +**`credential_manager_acs_system_id`** *String* --- diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index b1437509d..6b5135d43 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -10,8 +10,7 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ## Parameters -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the user identity for which you want to retrieve all accessible devices. diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 0be4e1c51..04615530d 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -10,8 +10,7 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ## Parameters -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the user identity for which you want to retrieve all access control systems. diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index a7f0e3516..46b6d3b1b 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -10,8 +10,7 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ## Parameters -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the user identity for which you want to retrieve all ACS users. diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index fd3f70c6c..bea5891d4 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -10,15 +10,13 @@ POST /user_identities/remove_acs_user ⇒ void ## Parameters -**`acs_user_id`** ** - (Required) +**`acs_user_id`** *String* (Required) ID of the ACS user. --- -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 1097fdd06..053518d98 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -10,15 +10,13 @@ POST /user_identities/revoke_access_to_device ⇒ void ## Parameters -**`device_id`** ** - (Required) +**`device_id`** *String* (Required) ID of the desired managed device. --- -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the desired user identity. diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 49433b7b7..3e022cc34 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -10,34 +10,29 @@ PATCH /user_identities/update ⇒ void ## Parameters -**`user_identity_id`** ** - (Required) +**`user_identity_id`** *String* (Required) ID of the user identity. --- -**`email_address`** ** - +**`email_address`** *String* Unique email address for the user identity. --- -**`full_name`** ** - +**`full_name`** *String* --- -**`phone_number`** ** - +**`phone_number`** *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- -**`user_identity_key`** ** - +**`user_identity_key`** *String* Unique key for the user identity. From 24ece765ddec029d87418afbcaa7446c0b090a99 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 19:10:39 -0400 Subject: [PATCH 163/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index a51907c70..3a3f28ede 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -47,6 +47,7 @@ None {{/each}}
{{/if}} + ## Return Type {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} From 98807e0732ce12f0924c548c1241d9edfbb5c5cf Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 23:11:45 +0000 Subject: [PATCH 164/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 1 + docs/api/acs/access_groups/get.md | 1 + docs/api/acs/access_groups/list.md | 1 + docs/api/acs/access_groups/list_accessible_entrances.md | 1 + docs/api/acs/access_groups/list_users.md | 1 + docs/api/acs/access_groups/remove_user.md | 1 + docs/api/acs/credentials/assign.md | 1 + docs/api/acs/credentials/create.md | 1 + docs/api/acs/credentials/delete.md | 1 + docs/api/acs/credentials/get.md | 1 + docs/api/acs/credentials/list.md | 1 + docs/api/acs/credentials/list_accessible_entrances.md | 1 + docs/api/acs/credentials/unassign.md | 1 + docs/api/acs/credentials/update.md | 1 + docs/api/acs/encoders/encode_credential.md | 1 + docs/api/acs/encoders/list.md | 1 + docs/api/acs/encoders/scan_credential.md | 1 + .../acs/encoders/simulate/next_credential_encode_will_fail.md | 1 + .../acs/encoders/simulate/next_credential_encode_will_succeed.md | 1 + docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md | 1 + .../acs/encoders/simulate/next_credential_scan_will_succeed.md | 1 + docs/api/acs/entrances/get.md | 1 + docs/api/acs/entrances/grant_access.md | 1 + docs/api/acs/entrances/list.md | 1 + docs/api/acs/entrances/list_credentials_with_access.md | 1 + docs/api/acs/systems/get.md | 1 + docs/api/acs/systems/list.md | 1 + .../systems/list_compatible_credential_manager_acs_systems.md | 1 + docs/api/acs/users/add_to_access_group.md | 1 + docs/api/acs/users/create.md | 1 + docs/api/acs/users/delete.md | 1 + docs/api/acs/users/get.md | 1 + docs/api/acs/users/list.md | 1 + docs/api/acs/users/list_accessible_entrances.md | 1 + docs/api/acs/users/remove_from_access_group.md | 1 + docs/api/acs/users/revoke_access_to_all_entrances.md | 1 + docs/api/acs/users/suspend.md | 1 + docs/api/acs/users/unsuspend.md | 1 + docs/api/acs/users/update.md | 1 + docs/api/phones/deactivate.md | 1 + docs/api/phones/get.md | 1 + docs/api/phones/list.md | 1 + docs/api/phones/simulate/create_sandbox_phone.md | 1 + docs/api/thermostats/activate_climate_preset.md | 1 + docs/api/thermostats/cool.md | 1 + docs/api/thermostats/create_climate_preset.md | 1 + docs/api/thermostats/delete_climate_preset.md | 1 + docs/api/thermostats/heat.md | 1 + docs/api/thermostats/heat_cool.md | 1 + docs/api/thermostats/list.md | 1 + docs/api/thermostats/off.md | 1 + docs/api/thermostats/schedules/create.md | 1 + docs/api/thermostats/schedules/delete.md | 1 + docs/api/thermostats/schedules/get.md | 1 + docs/api/thermostats/schedules/list.md | 1 + docs/api/thermostats/schedules/update.md | 1 + docs/api/thermostats/set_fallback_climate_preset.md | 1 + docs/api/thermostats/set_fan_mode.md | 1 + docs/api/thermostats/set_hvac_mode.md | 1 + docs/api/thermostats/set_temperature_threshold.md | 1 + docs/api/thermostats/simulate/hvac_mode_adjusted.md | 1 + docs/api/thermostats/simulate/temperature_reached.md | 1 + docs/api/thermostats/update_climate_preset.md | 1 + docs/api/user_identities/add_acs_user.md | 1 + docs/api/user_identities/create.md | 1 + docs/api/user_identities/delete.md | 1 + docs/api/user_identities/enrollment_automations/delete.md | 1 + docs/api/user_identities/enrollment_automations/get.md | 1 + docs/api/user_identities/enrollment_automations/launch.md | 1 + docs/api/user_identities/enrollment_automations/list.md | 1 + docs/api/user_identities/get.md | 1 + docs/api/user_identities/grant_access_to_device.md | 1 + docs/api/user_identities/list.md | 1 + docs/api/user_identities/list_accessible_devices.md | 1 + docs/api/user_identities/list_acs_systems.md | 1 + docs/api/user_identities/list_acs_users.md | 1 + docs/api/user_identities/remove_acs_user.md | 1 + docs/api/user_identities/revoke_access_to_device.md | 1 + docs/api/user_identities/update.md | 1 + 79 files changed, 79 insertions(+) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 5b93554eb..577a1e883 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -31,6 +31,7 @@ ID of the desired user. - Personal access token
Must also include the `seam-workspace` header in the request.
+ ## Return Type void diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index a551e0b0b..78b017b2e 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -25,6 +25,7 @@ ID of the desired access group. - Personal access token
Must also include the `seam-workspace` header in the request.
+ ## Return Type [acs\_access\_group](./) diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index d9c7fcfe6..db94a0378 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -31,6 +31,7 @@ ID of the user for which you want to retrieve all access groups. - Personal access token
Must also include the `seam-workspace` header in the request.
+ ## Return Type Array<[acs\_access\_group](./)> diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index cb025e0b3..68e7fceef 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -25,6 +25,7 @@ ID of the access group for which you want to retrieve all accessible entrances. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 219557484..9b2816cbc 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -25,6 +25,7 @@ ID of the access group for which you want to retrieve all users. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 394ddd77a..3a22eed46 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -31,6 +31,7 @@ ID of the desired user. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 3e1f33e99..1a0eab421 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -31,6 +31,7 @@ ID of the desired user. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index ce5686a5d..7446b1de8 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -85,6 +85,7 @@ Visionline-specific metadata for the new credential. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 2976e3a9d..2baf7fb93 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -25,6 +25,7 @@ ID of the desired credential. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index fc84f9042..2437b0e52 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -25,6 +25,7 @@ ID of the desired credential. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 30e3abe40..d4546fe88 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -56,6 +56,7 @@ ID of the user identity for which you want to retrieve all credentials. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 1b8d677bd..662f6d280 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -25,6 +25,7 @@ ID of the credential for which you want to retrieve all entrances to which this - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 4810b554d..ff8b05685 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -31,6 +31,7 @@ ID of the desired user. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 116065f61..2a73638ba 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -37,6 +37,7 @@ Replacement date and time at which the validity of the credential ends, in [ISO - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index fec7a86bb..c775c1336 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -31,6 +31,7 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 9f9a19838..028422694 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -43,6 +43,7 @@ Number of `acs_encoders` to return. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_encoder](./)> diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index dfb6fdc44..63b4a54bf 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -25,6 +25,7 @@ ID of the `acs_encoder` to use for the scan. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index f0701ea07..f8a289dbf 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -37,6 +37,7 @@ Code of the error to simulate. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 098b9c44f..fb95d2dcb 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -31,6 +31,7 @@ Scenario to simulate. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 559e95684..51d8e1ae8 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -33,6 +33,7 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 66d5659f7..e7f9364a4 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -37,6 +37,7 @@ Scenario to simulate. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 41d1d8f04..99e1c3f83 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -22,6 +22,7 @@ POST /acs/entrances/get ⇒ { acs_entrance } - API key - Client session token + ## Return Type [acs\_entrance](./) diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index c43328dec..44c353642 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -27,6 +27,7 @@ POST /acs/entrances/grant_access ⇒ void - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 2e84dd5ba..fae12a736 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -28,6 +28,7 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index a759fc5c9..b851d465a 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -35,6 +35,7 @@ Possible enum values: - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index bb5428e23..7f2136ffb 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -27,6 +27,7 @@ ID of the desired access control system. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [acs\_system](./) diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 9f3be5b8e..01f82c33f 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -28,6 +28,7 @@ ID of the connected account by which to filter the list of returned access contr - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index e1cff430c..ac97d3835 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -29,6 +29,7 @@ ID of the ACS system for which you want to retrieve all compatible credential ma - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index afbbda6e6..eb6ba68ab 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -31,6 +31,7 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index e16c75af7..531c48280 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -65,6 +65,7 @@ ID of the user identity with which to associate the new `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index a1fdd8ba7..43ad59065 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -25,6 +25,7 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 6b5073dd8..2151374bc 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -25,6 +25,7 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index a26c1ec7d..e9ec1f9ef 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -66,6 +66,7 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 9fcbb4fdb..73a6256cf 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -26,6 +26,7 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 42dcf2268..0250f17ef 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -31,6 +31,7 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 93553e08e..02bf0d5e2 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -25,6 +25,7 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 57abc2241..6ed01580d 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -25,6 +25,7 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 18a95cf00..d1ca42b48 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -25,6 +25,7 @@ ID of the desired `acs_user`. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 9bebf492a..12ad94317 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -57,6 +57,7 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 8900fe167..81c812668 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -26,6 +26,7 @@ Device ID of the desired phone. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index e5babbb82..9b9fabed8 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -25,6 +25,7 @@ Device ID of the desired phone. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [phone](./) diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index d3d57537a..927d6d2e4 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -31,6 +31,7 @@ ID of the user identity that represents the owner by which to filter the list of - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[phone](./)> diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index edd3ed1f6..6f64a0c3e 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -43,6 +43,7 @@ Metadata to associate with the simulated phone. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [phone](./) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 87d3f0e79..157c580a4 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -31,6 +31,7 @@ ID of the desired thermostat device. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index ee50cd1f8..222cae76b 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -38,6 +38,7 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 21d37996b..8fef8345d 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -80,6 +80,7 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 80d00d443..e336f1f3c 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -32,6 +32,7 @@ ID of the desired thermostat device. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 26b7e6ea8..3e75e6fde 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -38,6 +38,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index da72f0acd..ddf7ca4d1 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -50,6 +50,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 2ec9aa990..b36c0b696 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -127,6 +127,7 @@ Your own internal user ID for the user by which to filter devices. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[device](./)> diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 06a4a8029..0a576b6e9 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -26,6 +26,7 @@ ID of the desired thermostat device. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index f26018b76..4d78c3bb2 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -62,6 +62,7 @@ User-friendly name to identify the thermostat schedule. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index d80b1ad38..217e5ffb1 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -26,6 +26,7 @@ ID of the desired thermostat schedule. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 1dec74ba7..253d48c99 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -26,6 +26,7 @@ ID of the desired thermostat schedule. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 18d863769..d9f789d98 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -32,6 +32,7 @@ User identifier key by which to filter the list of returned thermostat schedules - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[thermostat\_schedule](./)> diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 30d6799ce..4bcc7c2dc 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -62,6 +62,7 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 78dc28962..86435efba 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -31,6 +31,7 @@ ID of the desired thermostat device. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 2db43a0f7..ff1fc255a 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -34,6 +34,7 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index c6d4f4b40..96e60695c 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -54,6 +54,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 2a7ee204e..496f16b87 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -49,6 +49,7 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 4b56dced6..4cc3dfea9 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -55,6 +55,7 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 4c72ebc37..6646fca91 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -37,6 +37,7 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 104a964d3..77932b210 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -80,6 +80,7 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 80636702e..06bc18b3c 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -31,6 +31,7 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 1b68a0593..9b607e332 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -43,6 +43,7 @@ Unique key for the user identity. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index fd56ee87a..a6c82e063 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -25,6 +25,7 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 0c4fa1930..3e3c0c085 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -25,6 +25,7 @@ ID of the desired enrollment automation. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 929a65355..dbc54638b 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -26,6 +26,7 @@ ID of the desired enrollment automation. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [enrollment\_automation](./) diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 3f60cd5aa..af04584d2 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -49,6 +49,7 @@ ID of the associated ACS user within the credential manager. If you specify a `c - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [unknown](./) diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 79c379f2d..26a1092a2 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -26,6 +26,7 @@ ID of the user identity for which you want to retrieve all enrollment automation - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[enrollment\_automation](./)> diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 5a51bbf76..5725ddb36 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -29,6 +29,7 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 4a99431c7..bf4dbe8d3 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -31,6 +31,7 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 5614765eb..2da9b4077 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -24,6 +24,7 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[user\_identity](./)> diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 6b5135d43..b55eb7cbc 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -25,6 +25,7 @@ ID of the user identity for which you want to retrieve all accessible devices. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[device](./)> diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 04615530d..0246f4ce0 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -26,6 +26,7 @@ ID of the user identity for which you want to retrieve all access control system - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 46b6d3b1b..b018ca4c4 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -25,6 +25,7 @@ ID of the user identity for which you want to retrieve all ACS users. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index bea5891d4..829d457f9 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -31,6 +31,7 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 053518d98..76a01f3ab 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -31,6 +31,7 @@ ID of the desired user identity. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 3e022cc34..44824558f 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -47,6 +47,7 @@ Unique key for the user identity. - Personal access token
Must also include the `seam-workspace` header in the request. + ## Return Type void From 456a9ea50ca17cff7b8d6c8afdf2824b860cea7b Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 19:24:59 -0400 Subject: [PATCH 165/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 3a3f28ede..32db5e777 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -8,6 +8,20 @@ ``` {% endhint %} +{{#if authMethods}} +
+ +Authentication Methods + +{{#each authMethods}} +- {{this}} +{{#if (eq this 'Personal access token')}} +
{{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} +{{/if}} +{{/each}} +
+{{/if}} + ## Parameters {{#if request.parameters.length}} @@ -34,20 +48,6 @@ None {{/if}} -{{#if authMethods}} -
- -Authentication Methods - -{{#each authMethods}} -- {{this}} -{{#if (eq this 'Personal access token')}} -
{{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} -{{/if}} -{{/each}} -
-{{/if}} - ## Return Type {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} From 1e3d7f509ae76b4f48fbe4980552d850bec0e301 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 23:26:07 +0000 Subject: [PATCH 166/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 18 ++++++++--------- docs/api/acs/access_groups/get.md | 18 ++++++++--------- docs/api/acs/access_groups/list.md | 18 ++++++++--------- .../list_accessible_entrances.md | 18 ++++++++--------- docs/api/acs/access_groups/list_users.md | 18 ++++++++--------- docs/api/acs/access_groups/remove_user.md | 18 ++++++++--------- docs/api/acs/credentials/assign.md | 18 ++++++++--------- docs/api/acs/credentials/create.md | 18 ++++++++--------- docs/api/acs/credentials/delete.md | 18 ++++++++--------- docs/api/acs/credentials/get.md | 18 ++++++++--------- docs/api/acs/credentials/list.md | 20 +++++++++---------- .../credentials/list_accessible_entrances.md | 18 ++++++++--------- docs/api/acs/credentials/unassign.md | 18 ++++++++--------- docs/api/acs/credentials/update.md | 18 ++++++++--------- docs/api/acs/encoders/encode_credential.md | 18 ++++++++--------- docs/api/acs/encoders/list.md | 18 ++++++++--------- docs/api/acs/encoders/scan_credential.md | 18 ++++++++--------- .../next_credential_encode_will_fail.md | 18 ++++++++--------- .../next_credential_encode_will_succeed.md | 18 ++++++++--------- .../next_credential_scan_will_fail.md | 18 ++++++++--------- .../next_credential_scan_will_succeed.md | 18 ++++++++--------- docs/api/acs/entrances/get.md | 14 ++++++------- docs/api/acs/entrances/grant_access.md | 18 ++++++++--------- docs/api/acs/entrances/list.md | 20 +++++++++---------- .../entrances/list_credentials_with_access.md | 20 +++++++++---------- docs/api/acs/systems/get.md | 18 ++++++++--------- docs/api/acs/systems/list.md | 18 ++++++++--------- ...mpatible_credential_manager_acs_systems.md | 18 ++++++++--------- docs/api/acs/users/add_to_access_group.md | 18 ++++++++--------- docs/api/acs/users/create.md | 18 ++++++++--------- docs/api/acs/users/delete.md | 18 ++++++++--------- docs/api/acs/users/get.md | 18 ++++++++--------- docs/api/acs/users/list.md | 20 +++++++++---------- .../acs/users/list_accessible_entrances.md | 18 ++++++++--------- .../api/acs/users/remove_from_access_group.md | 18 ++++++++--------- .../users/revoke_access_to_all_entrances.md | 18 ++++++++--------- docs/api/acs/users/suspend.md | 18 ++++++++--------- docs/api/acs/users/unsuspend.md | 18 ++++++++--------- docs/api/acs/users/update.md | 18 ++++++++--------- docs/api/phones/deactivate.md | 18 ++++++++--------- docs/api/phones/get.md | 18 ++++++++--------- docs/api/phones/list.md | 18 ++++++++--------- .../phones/simulate/create_sandbox_phone.md | 18 ++++++++--------- .../thermostats/activate_climate_preset.md | 18 ++++++++--------- docs/api/thermostats/cool.md | 20 +++++++++---------- docs/api/thermostats/create_climate_preset.md | 20 +++++++++---------- docs/api/thermostats/delete_climate_preset.md | 20 +++++++++---------- docs/api/thermostats/heat.md | 20 +++++++++---------- docs/api/thermostats/heat_cool.md | 20 +++++++++---------- docs/api/thermostats/list.md | 20 +++++++++---------- docs/api/thermostats/off.md | 18 ++++++++--------- docs/api/thermostats/schedules/create.md | 20 +++++++++---------- docs/api/thermostats/schedules/delete.md | 18 ++++++++--------- docs/api/thermostats/schedules/get.md | 18 ++++++++--------- docs/api/thermostats/schedules/list.md | 20 +++++++++---------- docs/api/thermostats/schedules/update.md | 20 +++++++++---------- .../set_fallback_climate_preset.md | 18 ++++++++--------- docs/api/thermostats/set_fan_mode.md | 20 +++++++++---------- docs/api/thermostats/set_hvac_mode.md | 20 +++++++++---------- .../thermostats/set_temperature_threshold.md | 18 ++++++++--------- .../simulate/hvac_mode_adjusted.md | 18 ++++++++--------- .../simulate/temperature_reached.md | 18 ++++++++--------- docs/api/thermostats/update_climate_preset.md | 20 +++++++++---------- docs/api/user_identities/add_acs_user.md | 18 ++++++++--------- docs/api/user_identities/create.md | 18 ++++++++--------- docs/api/user_identities/delete.md | 18 ++++++++--------- .../enrollment_automations/delete.md | 18 ++++++++--------- .../enrollment_automations/get.md | 18 ++++++++--------- .../enrollment_automations/launch.md | 18 ++++++++--------- .../enrollment_automations/list.md | 18 ++++++++--------- docs/api/user_identities/get.md | 18 ++++++++--------- .../user_identities/grant_access_to_device.md | 18 ++++++++--------- docs/api/user_identities/list.md | 14 ++++++------- .../list_accessible_devices.md | 18 ++++++++--------- docs/api/user_identities/list_acs_systems.md | 18 ++++++++--------- docs/api/user_identities/list_acs_users.md | 18 ++++++++--------- docs/api/user_identities/remove_acs_user.md | 18 ++++++++--------- .../revoke_access_to_device.md | 18 ++++++++--------- docs/api/user_identities/update.md | 18 ++++++++--------- 79 files changed, 723 insertions(+), 723 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 577a1e883..072c612cb 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -8,6 +8,15 @@ PUT /acs/access_groups/add_user ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_access_group_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired user. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 78b017b2e..0e81a1a9f 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -8,15 +8,6 @@ POST /acs/access_groups/get ⇒ { acs_access_group } ``` {% endhint %} -## Parameters - -**`acs_access_group_id`** *String* (Required) - -ID of the desired access group. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired access group.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_access_group_id`** *String* (Required) + +ID of the desired access group. + +--- + + ## Return Type [acs\_access\_group](./) diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index db94a0378..398c96eea 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -8,6 +8,15 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_system_id`** *String* @@ -23,15 +32,6 @@ ID of the user for which you want to retrieve all access groups. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type Array<[acs\_access\_group](./)> diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 68e7fceef..8d3260e38 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -8,15 +8,6 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr ``` {% endhint %} -## Parameters - -**`acs_access_group_id`** *String* (Required) - -ID of the access group for which you want to retrieve all accessible entrances. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the access group for which you want to retrieve all accessible entrances.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_access_group_id`** *String* (Required) + +ID of the access group for which you want to retrieve all accessible entrances. + +--- + + ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 9b2816cbc..d4d8721fd 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -8,15 +8,6 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ``` {% endhint %} -## Parameters - -**`acs_access_group_id`** *String* (Required) - -ID of the access group for which you want to retrieve all users. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the access group for which you want to retrieve all users.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_access_group_id`** *String* (Required) + +ID of the access group for which you want to retrieve all users. + +--- + + ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 3a22eed46..2e8c21ab6 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -8,6 +8,15 @@ POST /acs/access_groups/remove_user ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_access_group_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired user. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 1a0eab421..c85960605 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -8,6 +8,15 @@ PATCH /acs/credentials/assign ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_credential_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired user. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 7446b1de8..bb559cbc6 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -8,6 +8,15 @@ POST /acs/credentials/create ⇒ { acs_credential } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`access_method`** *String* (Required) @@ -77,15 +86,6 @@ Visionline-specific metadata for the new credential. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 2baf7fb93..3dc5e4af8 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -8,15 +8,6 @@ POST /acs/credentials/delete ⇒ void ``` {% endhint %} -## Parameters - -**`acs_credential_id`** *String* (Required) - -ID of the desired credential. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired credential.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_credential_id`** *String* (Required) + +ID of the desired credential. + +--- + + ## Return Type void diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 2437b0e52..356719d36 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -8,15 +8,6 @@ POST /acs/credentials/get ⇒ { acs_credential } ``` {% endhint %} -## Parameters - -**`acs_credential_id`** *String* (Required) - -ID of the desired credential. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired credential.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_credential_id`** *String* (Required) + +ID of the desired credential. + +--- + + ## Return Type [acs\_credential](./) diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index d4546fe88..91c7ad473 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -8,6 +8,16 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_system_id`** *String* @@ -47,16 +57,6 @@ ID of the user identity for which you want to retrieve all credentials. --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 662f6d280..b96867d7c 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -8,15 +8,6 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran ``` {% endhint %} -## Parameters - -**`acs_credential_id`** *String* (Required) - -ID of the credential for which you want to retrieve all entrances to which this credential grants access. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the credential for which you want to retrieve all entrances to which this
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_credential_id`** *String* (Required) + +ID of the credential for which you want to retrieve all entrances to which this credential grants access. + +--- + + ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index ff8b05685..0a972cbd2 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -8,6 +8,15 @@ PATCH /acs/credentials/unassign ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_credential_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired user. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 2a73638ba..777a0fbaa 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -8,6 +8,15 @@ PATCH /acs/credentials/update ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_credential_id`** *String* (Required) @@ -29,15 +38,6 @@ Replacement date and time at which the validity of the credential ends, in [ISO --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index c775c1336..e622fa6c8 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -8,6 +8,15 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_credential_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 028422694..03d2c8eca 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -8,6 +8,15 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_encoder_ids`** *Array* *of UUIDs* @@ -35,15 +44,6 @@ Number of `acs_encoders` to return. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type Array<[acs\_encoder](./)> diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 63b4a54bf..c3313243b 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -8,15 +8,6 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt } ``` {% endhint %} -## Parameters - -**`acs_encoder_id`** *String* (Required) - -ID of the `acs_encoder` to use for the scan. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the `acs_encoder` to use for the scan.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_encoder_id`** *String* (Required) + +ID of the `acs_encoder` to use for the scan. + +--- + + ## Return Type [action\_attempt](./) diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index f8a289dbf..12d161fc5 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -8,6 +8,15 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_encoder_id`** *String* (Required) @@ -29,15 +38,6 @@ Code of the error to simulate. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index fb95d2dcb..afcbc5ed7 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -8,6 +8,15 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_encoder_id`** *String* (Required) @@ -23,15 +32,6 @@ Scenario to simulate. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 51d8e1ae8..63c6e5b2d 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -8,6 +8,15 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_encoder_id`** *String* (Required) @@ -25,15 +34,6 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index e7f9364a4..6968fd893 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -8,6 +8,15 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_encoder_id`** *String* (Required) @@ -29,15 +38,6 @@ Scenario to simulate. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 99e1c3f83..574b61d47 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -8,13 +8,6 @@ POST /acs/entrances/get ⇒ { acs_entrance } ``` {% endhint %} -## Parameters - -**`acs_entrance_id`** *String* (Required) - ---- - -
Authentication Methods @@ -23,6 +16,13 @@ POST /acs/entrances/get ⇒ { acs_entrance } - Client session token
+## Parameters + +**`acs_entrance_id`** *String* (Required) + +--- + + ## Return Type [acs\_entrance](./) diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 44c353642..af7db87a9 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -8,6 +8,15 @@ POST /acs/entrances/grant_access ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_entrance_id`** *String* (Required) @@ -19,15 +28,6 @@ POST /acs/entrances/grant_access ⇒ void --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index fae12a736..6088ccecb 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -8,6 +8,16 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_credential_id`** *String* @@ -19,16 +29,6 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index b851d465a..8f349e184 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -8,6 +8,16 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_entrance_id`** *String* (Required) @@ -26,16 +36,6 @@ Possible enum values: --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type Array<[acs\_credential](./)> diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 7f2136ffb..5656f20dd 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -10,15 +10,6 @@ POST /acs/systems/get ⇒ { acs_system } ``` {% endhint %} -## Parameters - -**`acs_system_id`** *String* (Required) - -ID of the desired access control system. - ---- - -
Authentication Methods @@ -28,6 +19,15 @@ ID of the desired access control system.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_system_id`** *String* (Required) + +ID of the desired access control system. + +--- + + ## Return Type [acs\_system](./) diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 01f82c33f..40e644b08 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -10,15 +10,6 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ``` {% endhint %} -## Parameters - -**`connected_account_id`** *String* - -ID of the connected account by which to filter the list of returned access control systems. - ---- - -
Authentication Methods @@ -29,6 +20,15 @@ ID of the connected account by which to filter the list of returned access contr
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`connected_account_id`** *String* + +ID of the connected account by which to filter the list of returned access control systems. + +--- + + ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index ac97d3835..9d6629089 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -12,15 +12,6 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste ``` {% endhint %} -## Parameters - -**`acs_system_id`** *String* (Required) - -ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. - ---- - -
Authentication Methods @@ -30,6 +21,15 @@ ID of the ACS system for which you want to retrieve all compatible credential ma
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_system_id`** *String* (Required) + +ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. + +--- + + ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index eb6ba68ab..71682df26 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -8,6 +8,15 @@ PUT /acs/users/add_to_access_group ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_access_group_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired `acs_user`. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 531c48280..408731fdc 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -8,6 +8,15 @@ POST /acs/users/create ⇒ { acs_user } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_system_id`** *String* (Required) @@ -57,15 +66,6 @@ ID of the user identity with which to associate the new `acs_user`. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 43ad59065..94ea1ad55 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -8,15 +8,6 @@ POST /acs/users/delete ⇒ void ``` {% endhint %} -## Parameters - -**`acs_user_id`** *String* (Required) - -ID of the desired `acs_user`. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired `acs_user`.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_user_id`** *String* (Required) + +ID of the desired `acs_user`. + +--- + + ## Return Type void diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 2151374bc..5487db85c 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -8,15 +8,6 @@ POST /acs/users/get ⇒ { acs_user } ``` {% endhint %} -## Parameters - -**`acs_user_id`** *String* (Required) - -ID of the desired `acs_user`. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired `acs_user`.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_user_id`** *String* (Required) + +ID of the desired `acs_user`. + +--- + + ## Return Type [acs\_user](./) diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index e9ec1f9ef..f055fe061 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -8,6 +8,16 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_system_id`** *String* @@ -57,16 +67,6 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 73a6256cf..9c178ab8d 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -8,15 +8,6 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, ``` {% endhint %} -## Parameters - -**`acs_user_id`** *String* (Required) - -ID of the desired `acs_user`. - ---- - -
Authentication Methods @@ -27,6 +18,15 @@ ID of the desired `acs_user`.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_user_id`** *String* (Required) + +ID of the desired `acs_user`. + +--- + + ## Return Type Array<[acs\_entrance](./)> diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 0250f17ef..bcfaf0b5b 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -8,6 +8,15 @@ POST /acs/users/remove_from_access_group ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_access_group_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired `acs_user`. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 02bf0d5e2..987364694 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -8,15 +8,6 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void ``` {% endhint %} -## Parameters - -**`acs_user_id`** *String* (Required) - -ID of the desired `acs_user`. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired `acs_user`.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_user_id`** *String* (Required) + +ID of the desired `acs_user`. + +--- + + ## Return Type void diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 6ed01580d..1358224c5 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -8,15 +8,6 @@ POST /acs/users/suspend ⇒ void ``` {% endhint %} -## Parameters - -**`acs_user_id`** *String* (Required) - -ID of the desired `acs_user`. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired `acs_user`.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_user_id`** *String* (Required) + +ID of the desired `acs_user`. + +--- + + ## Return Type void diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index d1ca42b48..abe4218cf 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -8,15 +8,6 @@ POST /acs/users/unsuspend ⇒ void ``` {% endhint %} -## Parameters - -**`acs_user_id`** *String* (Required) - -ID of the desired `acs_user`. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired `acs_user`.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`acs_user_id`** *String* (Required) + +ID of the desired `acs_user`. + +--- + + ## Return Type void diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 12ad94317..45cfa702e 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -8,6 +8,15 @@ PATCH /acs/users/update ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_user_id`** *String* (Required) @@ -49,15 +58,6 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 81c812668..e995c05d0 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -8,15 +8,6 @@ POST /phones/deactivate ⇒ void ``` {% endhint %} -## Parameters - -**`device_id`** *String* (Required) - -Device ID of the desired phone. - ---- - -
Authentication Methods @@ -27,6 +18,15 @@ Device ID of the desired phone.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`device_id`** *String* (Required) + +Device ID of the desired phone. + +--- + + ## Return Type void diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 9b9fabed8..90dfb5042 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -8,15 +8,6 @@ POST /phones/get ⇒ { phone } ``` {% endhint %} -## Parameters - -**`device_id`** *String* (Required) - -Device ID of the desired phone. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ Device ID of the desired phone.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`device_id`** *String* (Required) + +Device ID of the desired phone. + +--- + + ## Return Type [phone](./) diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 927d6d2e4..5e5cad190 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -8,6 +8,15 @@ POST /phones/list ⇒ { phones: [phone, …] } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_credential_id`** *String* @@ -23,15 +32,6 @@ ID of the user identity that represents the owner by which to filter the list of --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type Array<[phone](./)> diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 6f64a0c3e..37ca38ef1 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -8,6 +8,15 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`user_identity_id`** *String* (Required) @@ -35,15 +44,6 @@ Metadata to associate with the simulated phone. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [phone](./) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 157c580a4..d858a3d0a 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -8,6 +8,15 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`climate_preset_key`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired thermostat device. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 222cae76b..939631b97 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -8,6 +8,16 @@ POST /thermostats/cool ⇒ { action_attempt } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -29,16 +39,6 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 8fef8345d..32ca4e7b9 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -8,6 +8,16 @@ POST /thermostats/create_climate_preset ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`climate_preset_key`** *String* (Required) @@ -71,16 +81,6 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index e336f1f3c..e54f762de 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -8,6 +8,16 @@ POST /thermostats/delete_climate_preset ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`climate_preset_key`** *String* (Required) @@ -23,16 +33,6 @@ ID of the desired thermostat device. --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 3e75e6fde..dc88b06a3 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -8,6 +8,16 @@ POST /thermostats/heat ⇒ { action_attempt } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -29,16 +39,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index ddf7ca4d1..9d17ea217 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -8,6 +8,16 @@ POST /thermostats/heat_cool ⇒ { action_attempt } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -41,16 +51,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index b36c0b696..752ae6a9a 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -8,6 +8,16 @@ POST /thermostats/list ⇒ { devices: [device, …] } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`connect_webview_id`** *String* @@ -118,16 +128,6 @@ Your own internal user ID for the user by which to filter devices. --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type Array<[device](./)> diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 0a576b6e9..1cab1bb46 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -8,15 +8,6 @@ POST /thermostats/off ⇒ { action_attempt } ``` {% endhint %} -## Parameters - -**`device_id`** *String* (Required) - -ID of the desired thermostat device. - ---- - -
Authentication Methods @@ -27,6 +18,15 @@ ID of the desired thermostat device.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`device_id`** *String* (Required) + +ID of the desired thermostat device. + +--- + + ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 4d78c3bb2..35dcf49da 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -8,6 +8,16 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`climate_preset_key`** *String* (Required) @@ -53,16 +63,6 @@ User-friendly name to identify the thermostat schedule. --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 217e5ffb1..0b8d01dc6 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -8,15 +8,6 @@ POST /thermostats/schedules/delete ⇒ void ``` {% endhint %} -## Parameters - -**`thermostat_schedule_id`** *String* (Required) - -ID of the desired thermostat schedule. - ---- - -
Authentication Methods @@ -27,6 +18,15 @@ ID of the desired thermostat schedule.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`thermostat_schedule_id`** *String* (Required) + +ID of the desired thermostat schedule. + +--- + + ## Return Type void diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 253d48c99..c1b349e7a 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -8,15 +8,6 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule } ``` {% endhint %} -## Parameters - -**`thermostat_schedule_id`** *String* (Required) - -ID of the desired thermostat schedule. - ---- - -
Authentication Methods @@ -27,6 +18,15 @@ ID of the desired thermostat schedule.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`thermostat_schedule_id`** *String* (Required) + +ID of the desired thermostat schedule. + +--- + + ## Return Type [thermostat\_schedule](./) diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index d9f789d98..55e1b259d 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -8,6 +8,16 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -23,16 +33,6 @@ User identifier key by which to filter the list of returned thermostat schedules --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type Array<[thermostat\_schedule](./)> diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 4bcc7c2dc..fa9c2dafa 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -8,6 +8,16 @@ PATCH /thermostats/schedules/update ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`thermostat_schedule_id`** *String* (Required) @@ -53,16 +63,6 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 86435efba..2d28827bc 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -8,6 +8,15 @@ POST /thermostats/set_fallback_climate_preset ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`climate_preset_key`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired thermostat device. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index ff1fc255a..06dbf1565 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -8,6 +8,16 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -25,16 +35,6 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 96e60695c..160ed06f1 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -8,6 +8,16 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -45,16 +55,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [action\_attempt](./) diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 496f16b87..7ce21e3aa 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -8,6 +8,15 @@ PATCH /thermostats/set_temperature_threshold ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -41,15 +50,6 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 4cc3dfea9..f751cffa0 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -8,6 +8,15 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -47,15 +56,6 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 6646fca91..d025e277d 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -8,6 +8,15 @@ POST /thermostats/simulate/temperature_reached ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -29,15 +38,6 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 77932b210..67cf6220d 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -8,6 +8,16 @@ PATCH /thermostats/update_climate_preset ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`climate_preset_key`** *String* (Required) @@ -71,16 +81,6 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- -
- -Authentication Methods - -- API key -- Client session token -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 06bc18b3c..d228070f4 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -8,6 +8,15 @@ PUT /user_identities/add_acs_user ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_user_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired user identity. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 9b607e332..8ab890dcd 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -8,6 +8,15 @@ POST /user_identities/create ⇒ { user_identity } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`email_address`** *String* @@ -35,15 +44,6 @@ Unique key for the user identity. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index a6c82e063..e393907da 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -8,15 +8,6 @@ POST /user_identities/delete ⇒ void ``` {% endhint %} -## Parameters - -**`user_identity_id`** *String* (Required) - -ID of the desired user identity. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired user identity.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`user_identity_id`** *String* (Required) + +ID of the desired user identity. + +--- + + ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 3e3c0c085..b8a70cbb9 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -8,15 +8,6 @@ POST /user_identities/enrollment_automations/delete ⇒ void ``` {% endhint %} -## Parameters - -**`enrollment_automation_id`** *String* (Required) - -ID of the desired enrollment automation. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the desired enrollment automation.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`enrollment_automation_id`** *String* (Required) + +ID of the desired enrollment automation. + +--- + + ## Return Type void diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index dbc54638b..e0ffb2cf6 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -8,15 +8,6 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ``` {% endhint %} -## Parameters - -**`enrollment_automation_id`** *String* (Required) - -ID of the desired enrollment automation. - ---- - -
Authentication Methods @@ -27,6 +18,15 @@ ID of the desired enrollment automation.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`enrollment_automation_id`** *String* (Required) + +ID of the desired enrollment automation. + +--- + + ## Return Type [enrollment\_automation](./) diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index af04584d2..f66b5caf6 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -8,6 +8,15 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`credential_manager_acs_system_id`** *String* (Required) @@ -41,15 +50,6 @@ ID of the associated ACS user within the credential manager. If you specify a `c --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [unknown](./) diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 26a1092a2..2d649b65e 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -8,15 +8,6 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: ``` {% endhint %} -## Parameters - -**`user_identity_id`** *String* (Required) - -ID of the user identity for which you want to retrieve all enrollment automations. - ---- - -
Authentication Methods @@ -27,6 +18,15 @@ ID of the user identity for which you want to retrieve all enrollment automation
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`user_identity_id`** *String* (Required) + +ID of the user identity for which you want to retrieve all enrollment automations. + +--- + + ## Return Type Array<[enrollment\_automation](./)> diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 5725ddb36..200d84904 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -8,6 +8,15 @@ POST /user_identities/get ⇒ { user_identity } ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`user_identity_id`** *String* @@ -21,15 +30,6 @@ ID of the desired user identity. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type [user\_identity](./) diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index bf4dbe8d3..76dda86aa 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -8,6 +8,15 @@ PUT /user_identities/grant_access_to_device ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired user identity. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 2da9b4077..ed5275ad3 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -8,13 +8,6 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ``` {% endhint %} -## Parameters - -**`credential_manager_acs_system_id`** *String* - ---- - -
Authentication Methods @@ -25,6 +18,13 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] }
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`credential_manager_acs_system_id`** *String* + +--- + + ## Return Type Array<[user\_identity](./)> diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index b55eb7cbc..14d8c520f 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -8,15 +8,6 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ``` {% endhint %} -## Parameters - -**`user_identity_id`** *String* (Required) - -ID of the user identity for which you want to retrieve all accessible devices. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the user identity for which you want to retrieve all accessible devices.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`user_identity_id`** *String* (Required) + +ID of the user identity for which you want to retrieve all accessible devices. + +--- + + ## Return Type Array<[device](./)> diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 0246f4ce0..2be3ab3bb 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -8,15 +8,6 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` {% endhint %} -## Parameters - -**`user_identity_id`** *String* (Required) - -ID of the user identity for which you want to retrieve all access control systems. - ---- - -
Authentication Methods @@ -27,6 +18,15 @@ ID of the user identity for which you want to retrieve all access control system
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`user_identity_id`** *String* (Required) + +ID of the user identity for which you want to retrieve all access control systems. + +--- + + ## Return Type Array<[acs\_system](./)> diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index b018ca4c4..ccf08a2e1 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -8,15 +8,6 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ``` {% endhint %} -## Parameters - -**`user_identity_id`** *String* (Required) - -ID of the user identity for which you want to retrieve all ACS users. - ---- - -
Authentication Methods @@ -26,6 +17,15 @@ ID of the user identity for which you want to retrieve all ACS users.
Must also include the `seam-workspace` header in the request.
+## Parameters + +**`user_identity_id`** *String* (Required) + +ID of the user identity for which you want to retrieve all ACS users. + +--- + + ## Return Type Array<[acs\_user](./)> diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 829d457f9..e01936615 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -8,6 +8,15 @@ POST /user_identities/remove_acs_user ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`acs_user_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired user identity. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 76a01f3ab..57c64fb4a 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -8,6 +8,15 @@ POST /user_identities/revoke_access_to_device ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`device_id`** *String* (Required) @@ -23,15 +32,6 @@ ID of the desired user identity. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 44824558f..d4c4ae0ee 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -8,6 +8,15 @@ PATCH /user_identities/update ⇒ void ``` {% endhint %} +
+ +Authentication Methods + +- API key +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ ## Parameters **`user_identity_id`** *String* (Required) @@ -39,15 +48,6 @@ Unique key for the user identity. --- -
- -Authentication Methods - -- API key -- Personal access token -
Must also include the `seam-workspace` header in the request. -
- ## Return Type void From 7749ab92e697a2d243c6494a26faffe5092f0647 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 19:52:31 -0400 Subject: [PATCH 167/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 32db5e777..b77aabcb3 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -50,12 +50,12 @@ None ## Return Type -{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array<[{{response.escapedResourceType}}](./)>{{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} +{{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s](./){{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} {{#with response.actionAttempt}} {{> api-resource headingOffset=true}} {{/with}} -{{#if additionalCodeSamples.length}} +{{#if primaryCodeSample}} --- From 62dee227165849a3ff1c33c8fe416adbc6acebdc Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Sun, 6 Apr 2025 23:53:44 +0000 Subject: [PATCH 168/233] ci: Generate docs --- docs/api/acs/access_groups/add_user.md | 123 ++++++ docs/api/acs/access_groups/get.md | 170 ++++++++ docs/api/acs/access_groups/list.md | 191 ++++++++- .../list_accessible_entrances.md | 166 +++++++- docs/api/acs/access_groups/list_users.md | 224 +++++++++- docs/api/acs/access_groups/remove_user.md | 123 ++++++ docs/api/acs/credentials/assign.md | 123 ++++++ docs/api/acs/credentials/create.md | 211 ++++++++++ docs/api/acs/credentials/delete.md | 114 +++++ docs/api/acs/credentials/get.md | 165 ++++++++ docs/api/acs/credentials/list.md | 196 ++++++++- .../credentials/list_accessible_entrances.md | 211 +++++++++- docs/api/acs/credentials/unassign.md | 123 ++++++ docs/api/acs/credentials/update.md | 119 ++++++ docs/api/acs/encoders/list.md | 2 +- docs/api/acs/entrances/get.md | 140 +++++++ docs/api/acs/entrances/list.md | 140 ++++++- .../entrances/list_credentials_with_access.md | 237 ++++++++++- docs/api/acs/systems/get.md | 113 +++++ docs/api/acs/systems/list.md | 117 +++++- ...mpatible_credential_manager_acs_systems.md | 121 +++++- docs/api/acs/users/add_to_access_group.md | 123 ++++++ docs/api/acs/users/delete.md | 112 +++++ docs/api/acs/users/get.md | 158 +++++++ docs/api/acs/users/list.md | 150 ++++++- .../acs/users/list_accessible_entrances.md | 2 +- .../api/acs/users/remove_from_access_group.md | 123 ++++++ docs/api/acs/users/suspend.md | 112 +++++ docs/api/acs/users/unsuspend.md | 114 +++++ docs/api/acs/users/update.md | 122 ++++++ docs/api/phones/list.md | 2 +- .../thermostats/activate_climate_preset.md | 142 +++++++ docs/api/thermostats/cool.md | 142 +++++++ docs/api/thermostats/create_climate_preset.md | 152 +++++++ docs/api/thermostats/delete_climate_preset.md | 121 ++++++ docs/api/thermostats/heat.md | 142 +++++++ docs/api/thermostats/heat_cool.md | 148 +++++++ docs/api/thermostats/list.md | 225 +++++++++- docs/api/thermostats/off.md | 132 ++++++ docs/api/thermostats/schedules/create.md | 184 +++++++++ docs/api/thermostats/schedules/delete.md | 116 ++++++ docs/api/thermostats/schedules/get.md | 157 +++++++ docs/api/thermostats/schedules/list.md | 212 +++++++++- docs/api/thermostats/schedules/update.md | 123 ++++++ .../set_fallback_climate_preset.md | 121 ++++++ docs/api/thermostats/set_fan_mode.md | 142 +++++++ docs/api/thermostats/set_hvac_mode.md | 153 +++++++ .../thermostats/set_temperature_threshold.md | 127 ++++++ docs/api/thermostats/update_climate_preset.md | 132 ++++++ docs/api/user_identities/add_acs_user.md | 122 ++++++ docs/api/user_identities/create.md | 178 ++++++++ docs/api/user_identities/delete.md | 113 +++++ .../enrollment_automations/delete.md | 118 ++++++ .../enrollment_automations/get.md | 161 ++++++++ .../enrollment_automations/launch.md | 176 ++++++++ .../enrollment_automations/list.md | 173 +++++++- docs/api/user_identities/get.md | 159 +++++++ .../user_identities/grant_access_to_device.md | 122 ++++++ docs/api/user_identities/list.md | 160 ++++++- .../list_accessible_devices.md | 391 +++++++++++++++++- docs/api/user_identities/list_acs_systems.md | 178 +++++++- docs/api/user_identities/list_acs_users.md | 188 ++++++++- docs/api/user_identities/remove_acs_user.md | 122 ++++++ .../revoke_access_to_device.md | 122 ++++++ 64 files changed, 9281 insertions(+), 20 deletions(-) diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 072c612cb..b1da231e8 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -35,3 +35,126 @@ ID of the desired user. ## Return Type void + +--- + +## Examples + +### Add an ACS user to an access group + +Specify the `acs_access_group_id` and `acs_user_id` to add an ACS user to an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.accessGroups.addUser({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.access_groups.add_user( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + acs_user_id="33333333-3333-3333-3333-333333333333", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.access_groups.add_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->access_groups->add_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.AddUser( + context.Background(), + accessgroups.AccessGroupsAddUserRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 0e81a1a9f..5088e0be0 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -29,3 +29,173 @@ ID of the desired access group. ## Return Type [acs\_access\_group](./) + +--- + +## Examples + +### Get a specific access group + +Specify the `acs_access_group_id` of the access group that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.accessGroups.get({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +}); +``` + +#### Output + +```javascript +{ + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.access_groups.get(acs_access_group_id="44444444-4444-4444-4444-444444444444") +``` + +#### Output + +```python +AcsAccessGroup( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + name="Lobby Access", + display_name="Lobby Access", + access_group_type_display_name="PTI access level", + access_group_type="pti_access_level", + external_type="pti_access_level", + external_type_display_name="PTI access level", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2023-11-30T06:27:15.437Z", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.access_groups.get(acs_access_group_id: "44444444-4444-4444-4444-444444444444") +``` + +#### Output + +```ruby +{ + "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->access_groups->get( + acs_access_group_id: "44444444-4444-4444-4444-444444444444" +); +``` + +#### Output + +```php + "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs access-groups get --acs_access_group_id "44444444-4444-4444-4444-444444444444" +``` + +#### Output + +```seam_cli +{ + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.Get( + context.Background(), + accessgroups.AccessGroupsGetRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + }, + ) +} +``` + +#### Output + +```go +api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 398c96eea..03db7347e 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -34,4 +34,193 @@ ID of the user for which you want to retrieve all access groups. ## Return Type -Array<[acs\_access\_group](./)> +Array of [acs\_access\_groups](./) + +--- + +## Examples + +### List access groups + +To filter the list of access groups, include an `acs_system_id` or `acs_user_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.accessGroups.list({ + acs_system_id: "11111111-1111-1111-1111-111111111111", + acs_user_id: "33333333-3333-3333-3333-333333333333", +}); +``` + +#### Output + +```javascript +[ + { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.access_groups.list( + acs_system_id="11111111-1111-1111-1111-111111111111", + acs_user_id="33333333-3333-3333-3333-333333333333", +) +``` + +#### Output + +```python +[ + AcsAccessGroup( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + name="Lobby Access", + display_name="Lobby Access", + access_group_type_display_name="PTI access level", + access_group_type="pti_access_level", + external_type="pti_access_level", + external_type_display_name="PTI access level", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2023-11-30T06:27:15.437Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.access_groups.list( + acs_system_id: "11111111-1111-1111-1111-111111111111", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) +``` + +#### Output + +```ruby +[ + { + "acs_access_group_id" => "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->access_groups->list( + acs_system_id: "11111111-1111-1111-1111-111111111111", + acs_user_id: "33333333-3333-3333-3333-333333333333" +); +``` + +#### Output + +```php + "44444444-4444-4444-4444-444444444444", + "name" => "Lobby Access", + "display_name" => "Lobby Access", + "access_group_type_display_name" => "PTI access level", + "access_group_type" => "pti_access_level", + "external_type" => "pti_access_level", + "external_type_display_name" => "PTI access level", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2023-11-30T06:27:15.437Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs access-groups list --acs_system_id "11111111-1111-1111-1111-111111111111" --acs_user_id "33333333-3333-3333-3333-333333333333" +``` + +#### Output + +```seam_cli +[ + { + "acs_access_group_id": "44444444-4444-4444-4444-444444444444", + "name": "Lobby Access", + "display_name": "Lobby Access", + "access_group_type_display_name": "PTI access level", + "access_group_type": "pti_access_level", + "external_type": "pti_access_level", + "external_type_display_name": "PTI access level", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2023-11-30T06:27:15.437Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.List( + context.Background(), + accessgroups.AccessGroupsListRequest{ + AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsAccessGroup{api.AcsAccessGroup{AcsAccessGroupId: "44444444-4444-4444-4444-444444444444", Name: "Lobby Access", DisplayName: "Lobby Access", AccessGroupTypeDisplayName: "PTI access level", AccessGroupType: "pti_access_level", ExternalType: "pti_access_level", ExternalTypeDisplayName: "PTI access level", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2023-11-30T06:27:15.437Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 8d3260e38..7c96a6138 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -28,4 +28,168 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Return Type -Array<[acs\_entrance](./)> +Array of [acs\_entrances](./) + +--- + +## Examples + +### List accessible entrances for an access group + +Specify the `acs_access_group_id` to retrieve all accessible entrances for an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.accessGroups.listAccessibleEntrances({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +}); +``` + +#### Output + +```javascript +[ + { + "acs_entrance_id": "66666666-6666-6666-6666-666666666666", + "name": "Main Entrance", + "display_name": "Main Entrance", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-10-15T12:00:00.000Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.access_groups.list_accessible_entrances( + acs_access_group_id="44444444-4444-4444-4444-444444444444" +) +``` + +#### Output + +```python +[ + AcsEntrance( + acs_entrance_id="66666666-6666-6666-6666-666666666666", + name="Main Entrance", + display_name="Main Entrance", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-10-15T12:00:00.000Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.access_groups.list_accessible_entrances( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +) +``` + +#### Output + +```ruby +[ + { + "acs_entrance_id" => "66666666-6666-6666-6666-666666666666", + "name" => "Main Entrance", + "display_name" => "Main Entrance", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-10-15T12:00:00.000Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->access_groups->list_accessible_entrances( + acs_access_group_id: "44444444-4444-4444-4444-444444444444" +); +``` + +#### Output + +```php + "66666666-6666-6666-6666-666666666666", + "name" => "Main Entrance", + "display_name" => "Main Entrance", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-10-15T12:00:00.000Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs access-groups list-accessible-entrances --acs_access_group_id "44444444-4444-4444-4444-444444444444" +``` + +#### Output + +```seam_cli +[ + { + "acs_entrance_id": "66666666-6666-6666-6666-666666666666", + "name": "Main Entrance", + "display_name": "Main Entrance", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-10-15T12:00:00.000Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.ListAccessibleEntrances( + context.Background(), + accessgroups.AccessGroupsListAccessibleEntrancesRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "66666666-6666-6666-6666-666666666666", Name: "Main Entrance", DisplayName: "Main Entrance", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-10-15T12:00:00.000Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index d4d8721fd..b828c3fff 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -28,4 +28,226 @@ ID of the access group for which you want to retrieve all users. ## Return Type -Array<[acs\_user](./)> +Array of [acs\_users](./) + +--- + +## Examples + +### List ACS users in an access group + +Specify the `acs_access_group_id` to retrieve all ACS users in an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.accessGroups.listUsers({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", +}); +``` + +#### Output + +```javascript +[ + { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email": "jane@example.com", + "email_address": "jane@example.com", + "phone_number": "+15555550100", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-05T07:14:28.531Z", + "is_suspended": false, + "access_schedule": { + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z" + }, + "user_identity_id": "22222222-2222-2222-2222-222222222222", + "user_identity_full_name": "Jane Doe", + "user_identity_email_address": "jane@example.com", + "user_identity_phone_number": "+15555550100" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.access_groups.list_users( + acs_access_group_id="44444444-4444-4444-4444-444444444444" +) +``` + +#### Output + +```python +[ + AcsUser( + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Jane Doe", + full_name="Jane Doe", + email="jane@example.com", + email_address="jane@example.com", + phone_number="+15555550100", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-05T07:14:28.531Z", + is_suspended=false, + access_schedule={ + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z", + }, + user_identity_id="22222222-2222-2222-2222-222222222222", + user_identity_full_name="Jane Doe", + user_identity_email_address="jane@example.com", + user_identity_phone_number="+15555550100", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444") +``` + +#### Output + +```ruby +[ + { + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email" => "jane@example.com", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-05T07:14:28.531Z", + "is_suspended" => false, + "access_schedule" => { + starts_at: "2024-03-01T10:40:00.000Z", + ends_at: "2024-03-04T10:40:00.000Z", + }, + "user_identity_id" => "22222222-2222-2222-2222-222222222222", + "user_identity_full_name" => "Jane Doe", + "user_identity_email_address" => "jane@example.com", + "user_identity_phone_number" => "+15555550100", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->access_groups->list_users( + acs_access_group_id: "44444444-4444-4444-4444-444444444444" +); +``` + +#### Output + +```php + "33333333-3333-3333-3333-333333333333", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email" => "jane@example.com", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-05T07:14:28.531Z", + "is_suspended" => false, + "access_schedule" => [ + "starts_at" => "2024-03-01T10:40:00.000Z", + "ends_at" => "2024-03-04T10:40:00.000Z", + ], + "user_identity_id" => "22222222-2222-2222-2222-222222222222", + "user_identity_full_name" => "Jane Doe", + "user_identity_email_address" => "jane@example.com", + "user_identity_phone_number" => "+15555550100", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444" +``` + +#### Output + +```seam_cli +[ + { + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email": "jane@example.com", + "email_address": "jane@example.com", + "phone_number": "+15555550100", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-05T07:14:28.531Z", + "is_suspended": false, + "access_schedule": { + "starts_at": "2024-03-01T10:40:00.000Z", + "ends_at": "2024-03-04T10:40:00.000Z" + }, + "user_identity_id": "22222222-2222-2222-2222-222222222222", + "user_identity_full_name": "Jane Doe", + "user_identity_email_address": "jane@example.com", + "user_identity_phone_number": "+15555550100" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.ListUsers( + context.Background(), + accessgroups.AccessGroupsListUsersRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "jane@example.com", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "jane@example.com", UserIdentityPhoneNumber: "+15555550100"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 2e8c21ab6..dd587ec0e 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -35,3 +35,126 @@ ID of the desired user. ## Return Type void + +--- + +## Examples + +### Remove an ACS user from an access group + +Specify the `acs_access_group_id` and `acs_user_id` to remove an ACS user from an access group. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.accessGroups.removeUser({ + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.access_groups.remove_user( + acs_access_group_id="44444444-4444-4444-4444-444444444444", + acs_user_id="33333333-3333-3333-3333-333333333333", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.access_groups.remove_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->access_groups->remove_user( + acs_access_group_id: "44444444-4444-4444-4444-444444444444", + acs_user_id: "33333333-3333-3333-3333-333333333333" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs access-groups remove-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import accessgroups "github.com/seamapi/go/accessgroups" + +func main() { + client.Acs.AccessGroups.RemoveUser( + context.Background(), + accessgroups.AccessGroupsRemoveUserRequest{ + AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"), + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index c85960605..c84be2aba 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -35,3 +35,126 @@ ID of the desired user. ## Return Type void + +--- + +## Examples + +### Assign a credential to an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to assign a credential to an ACS user. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.credentials.assign({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.credentials.assign( + acs_user_id="33333333-3333-3333-3333-333333333333", + acs_credential_id="66666666-6666-6666-6666-666666666666", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.credentials.assign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->credentials->assign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs credentials assign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Assign( + context.Background(), + credentials.CredentialsAssignRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index bb559cbc6..12390ac88 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -89,3 +89,214 @@ Visionline-specific metadata for the new credential. ## Return Type [acs\_credential](./) + +--- + +## Examples + +### Create a credential for an ACS user + +Specify the `acs_user_id` and `access_method` to create a new credential. You can also specify additional parameters, depending on the `access_method`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.credentials.create({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + access_method: "mobile_key", + allowed_acs_entrance_ids: [ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000", + ], + credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential: true, + starts_at: "2024-03-01T10:40:00Z", + ends_at: "2024-03-04T10:40:00Z", +}); +``` + +#### Output + +```javascript +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "88888888-8888-8888-8888-888888888888", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.credentials.create( + acs_user_id="33333333-3333-3333-3333-333333333333", + access_method="mobile_key", + allowed_acs_entrance_ids=[ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000", + ], + credential_manager_acs_system_id="88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential=true, + starts_at="2024-03-01T10:40:00Z", + ends_at="2024-03-04T10:40:00Z", +) +``` + +#### Output + +```python +AcsCredential( + acs_credential_id="99999999-9999-9999-9999-999999999999", + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Multi Phone Sync Credential", + code=None, + acs_system_id="88888888-8888-8888-8888-888888888888", + access_method="mobile_key", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-12T03:56:22.396Z", + is_multi_phone_sync_credential=true, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.credentials.create( + acs_user_id: "33333333-3333-3333-3333-333333333333", + access_method: "mobile_key", + allowed_acs_entrance_ids: %w[ + 55555555-5555-5555-5555-555555555555 + 55555555-5555-5555-5555-000000000000 + ], + credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential: true, + starts_at: "2024-03-01T10:40:00Z", + ends_at: "2024-03-04T10:40:00Z", +) +``` + +#### Output + +```ruby +{ + "acs_credential_id" => "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => nil, + "acs_system_id" => "88888888-8888-8888-8888-888888888888", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->credentials->create( + acs_user_id: "33333333-3333-3333-3333-333333333333", + access_method: "mobile_key", + allowed_acs_entrance_ids: [ + "55555555-5555-5555-5555-555555555555", + "55555555-5555-5555-5555-000000000000", + ], + credential_manager_acs_system_id: "88888888-8888-8888-8888-888888888888", + is_multi_phone_sync_credential: true, + starts_at: "2024-03-01T10:40:00Z", + ends_at: "2024-03-04T10:40:00Z" +); +``` + +#### Output + +```php + "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => null, + "acs_system_id" => "88888888-8888-8888-8888-888888888888", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs credentials create --acs_user_id "33333333-3333-3333-3333-333333333333" --access_method "mobile_key" --allowed_acs_entrance_ids ["55555555-5555-5555-5555-555555555555","55555555-5555-5555-5555-000000000000"] --credential_manager_acs_system_id "88888888-8888-8888-8888-888888888888" --is_multi_phone_sync_credential true --starts_at "2024-03-01T10:40:00Z" --ends_at "2024-03-04T10:40:00Z" +``` + +#### Output + +```seam_cli +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "88888888-8888-8888-8888-888888888888", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Create( + context.Background(), + credentials.CredentialsCreateRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AccessMethod: api.String("mobile_key"), + AllowedAcsEntranceIds: [2]string{api.String("55555555-5555-5555-5555-555555555555"), api.String("55555555-5555-5555-5555-000000000000")}, + CredentialManagerAcsSystemId: api.String("88888888-8888-8888-8888-888888888888"), + IsMultiPhoneSyncCredential: api.Bool(true), + StartsAt: api.String("2024-03-01T10:40:00Z"), + EndsAt: api.String("2024-03-04T10:40:00Z"), + }, + ) +} +``` + +#### Output + +```go +api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "88888888-8888-8888-8888-888888888888", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 3dc5e4af8..5d7b511d4 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -29,3 +29,117 @@ ID of the desired credential. ## Return Type void + +--- + +## Examples + +### Delete a credential + +Specify the desired `acs_credential_id` to delete the specified credential. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.credentials.delete({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.credentials.delete(acs_credential_id="66666666-6666-6666-6666-666666666666") +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.credentials.delete(acs_credential_id: "66666666-6666-6666-6666-666666666666") +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->credentials->delete( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs credentials delete --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Delete( + context.Background(), + credentials.CredentialsDeleteRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 356719d36..b06bc6db5 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -29,3 +29,168 @@ ID of the desired credential. ## Return Type [acs\_credential](./) + +--- + +## Examples + +### Get a credential + +Specify the `acs_credential_id` of the credential that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.credentials.get({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Output + +```javascript +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.credentials.get(acs_credential_id="66666666-6666-6666-6666-666666666666") +``` + +#### Output + +```python +AcsCredential( + acs_credential_id="99999999-9999-9999-9999-999999999999", + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Multi Phone Sync Credential", + code=None, + acs_system_id="11111111-1111-1111-1111-111111111111", + access_method="mobile_key", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-12T03:56:22.396Z", + is_multi_phone_sync_credential=true, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.credentials.get(acs_credential_id: "66666666-6666-6666-6666-666666666666") +``` + +#### Output + +```ruby +{ + "acs_credential_id" => "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => nil, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->credentials->get( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Output + +```php + "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => null, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs credentials get --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Output + +```seam_cli +{ + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Get( + context.Background(), + credentials.CredentialsGetRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Output + +```go +api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 91c7ad473..44c2a1b95 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -59,4 +59,198 @@ ID of the user identity for which you want to retrieve all credentials. ## Return Type -Array<[acs\_credential](./)> +Array of [acs\_credentials](./) + +--- + +## Examples + +### List credentials + +Filter the list of returned credentials by `acs_user_id`, `acs_system_id`, or `user_identity_id`. You can also include `is_multi_phone_sync_credential`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.credentials.list({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_system_id: "11111111-1111-1111-1111-111111111111", + user_identity_id: "22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential: true, +}); +``` + +#### Output + +```javascript +[ + { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.credentials.list( + acs_user_id="33333333-3333-3333-3333-333333333333", + acs_system_id="11111111-1111-1111-1111-111111111111", + user_identity_id="22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential=true, +) +``` + +#### Output + +```python +[ + AcsCredential( + acs_credential_id="99999999-9999-9999-9999-999999999999", + acs_user_id="33333333-3333-3333-3333-333333333333", + display_name="Multi Phone Sync Credential", + code=None, + acs_system_id="11111111-1111-1111-1111-111111111111", + access_method="mobile_key", + workspace_id="00000000-0000-0000-0000-000000000000", + created_at="2024-04-12T03:56:22.396Z", + is_multi_phone_sync_credential=true, + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.credentials.list( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_system_id: "11111111-1111-1111-1111-111111111111", + user_identity_id: "22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential: true, +) +``` + +#### Output + +```ruby +[ + { + "acs_credential_id" => "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => nil, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->credentials->list( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_system_id: "11111111-1111-1111-1111-111111111111", + user_identity_id: "22222222-2222-2222-2222-222222222222", + is_multi_phone_sync_credential: true +); +``` + +#### Output + +```php + "99999999-9999-9999-9999-999999999999", + "acs_user_id" => "33333333-3333-3333-3333-333333333333", + "display_name" => "Multi Phone Sync Credential", + "code" => null, + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "access_method" => "mobile_key", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "created_at" => "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential" => true, + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs credentials list --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_system_id "11111111-1111-1111-1111-111111111111" --user_identity_id "22222222-2222-2222-2222-222222222222" --is_multi_phone_sync_credential true +``` + +#### Output + +```seam_cli +[ + { + "acs_credential_id": "99999999-9999-9999-9999-999999999999", + "acs_user_id": "33333333-3333-3333-3333-333333333333", + "display_name": "Multi Phone Sync Credential", + "code": null, + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "access_method": "mobile_key", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "created_at": "2024-04-12T03:56:22.396Z", + "is_multi_phone_sync_credential": true + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.List( + context.Background(), + credentials.CredentialsListRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"), + UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"), + IsMultiPhoneSyncCredential: api.Bool(true), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "99999999-9999-9999-9999-999999999999", AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Multi Phone Sync Credential", Code: nil, AcsSystemId: "11111111-1111-1111-1111-111111111111", AccessMethod: "mobile_key", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-12T03:56:22.396Z", IsMultiPhoneSyncCredential: true}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index b96867d7c..e8da9105b 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -28,4 +28,213 @@ ID of the credential for which you want to retrieve all entrances to which this ## Return Type -Array<[acs\_entrance](./)> +Array of [acs\_entrances](./) + +--- + +## Examples + +### List accessible entrances + +Specify the `acs_credential_id` for which you want to retrieve all entrances to which the credential grants access. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.credentials.listAccessibleEntrances({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Output + +```javascript +[ + { + "acs_entrance_id": "55555555-5555-5555-5555-555555555555", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "visionline_metadata": { + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE" + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest" + }, + "latch_metadata": null, + "display_name": "Guest Lock 2", + "created_at": "2024-03-26T14:31:18.979Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.credentials.list_accessible_entrances( + acs_credential_id="66666666-6666-6666-6666-666666666666" +) +``` + +#### Output + +```python +[ + AcsEntrance( + acs_entrance_id="55555555-5555-5555-5555-555555555555", + acs_system_id="11111111-1111-1111-1111-111111111111", + workspace_id="00000000-0000-0000-0000-000000000000", + visionline_metadata={ + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE", + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest", + }, + latch_metadata=None, + display_name="Guest Lock 2", + created_at="2024-03-26T14:31:18.979Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.credentials.list_accessible_entrances( + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) +``` + +#### Output + +```ruby +[ + { + "acs_entrance_id" => "55555555-5555-5555-5555-555555555555", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "visionline_metadata" => { + profiles: [{ visionline_door_profile_id: "Guest Door", visionline_door_profile_type: "BLE" }], + door_name: "Guest Lock 2", + door_category: "guest", + }, + "latch_metadata" => nil, + "display_name" => "Guest Lock 2", + "created_at" => "2024-03-26T14:31:18.979Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->credentials->list_accessible_entrances( + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Output + +```php + "55555555-5555-5555-5555-555555555555", + "acs_system_id" => "11111111-1111-1111-1111-111111111111", + "workspace_id" => "00000000-0000-0000-0000-000000000000", + "visionline_metadata" => [ + "profiles" => [ + [ + "visionline_door_profile_id" => "Guest Door", + "visionline_door_profile_type" => "BLE", + ], + ], + "door_name" => "Guest Lock 2", + "door_category" => "guest", + ], + "latch_metadata" => null, + "display_name" => "Guest Lock 2", + "created_at" => "2024-03-26T14:31:18.979Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs credentials list-accessible-entrances --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Output + +```seam_cli +[ + { + "acs_entrance_id": "55555555-5555-5555-5555-555555555555", + "acs_system_id": "11111111-1111-1111-1111-111111111111", + "workspace_id": "00000000-0000-0000-0000-000000000000", + "visionline_metadata": { + "profiles": [ + { + "visionline_door_profile_id": "Guest Door", + "visionline_door_profile_type": "BLE" + } + ], + "door_name": "Guest Lock 2", + "door_category": "guest" + }, + "latch_metadata": null, + "display_name": "Guest Lock 2", + "created_at": "2024-03-26T14:31:18.979Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.ListAccessibleEntrances( + context.Background(), + credentials.CredentialsListAccessibleEntrancesRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsEntrance{api.AcsEntrance{AcsEntranceId: "55555555-5555-5555-5555-555555555555", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", VisionlineMetadata: api.AcsEntranceVisionlineMetadata{Profiles: []AcsEntranceVisionlineMetadataProfiles{api.AcsEntranceVisionlineMetadataProfilesProfiles{VisionlineDoorProfileId: "Guest Door", VisionlineDoorProfileType: "BLE"}}, DoorName: "Guest Lock 2", DoorCategory: "guest"}, LatchMetadata: nil, DisplayName: "Guest Lock 2", CreatedAt: "2024-03-26T14:31:18.979Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 0a972cbd2..7bf3aa3ff 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -35,3 +35,126 @@ ID of the desired user. ## Return Type void + +--- + +## Examples + +### Unassign a credential from an ACS user + +Specify the desired `acs_user_id` and `acs_credential_id` to unassign the specified credential from the specified ACS user. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.credentials.unassign({ + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.credentials.unassign( + acs_user_id="33333333-3333-3333-3333-333333333333", + acs_credential_id="66666666-6666-6666-6666-666666666666", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.credentials.unassign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->credentials->unassign( + acs_user_id: "33333333-3333-3333-3333-333333333333", + acs_credential_id: "66666666-6666-6666-6666-666666666666" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs credentials unassign --acs_user_id "33333333-3333-3333-3333-333333333333" --acs_credential_id "66666666-6666-6666-6666-666666666666" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Unassign( + context.Background(), + credentials.CredentialsUnassignRequest{ + AcsUserId: api.String("33333333-3333-3333-3333-333333333333"), + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 777a0fbaa..48e8fce25 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -41,3 +41,122 @@ Replacement date and time at which the validity of the credential ends, in [ISO ## Return Type void + +--- + +## Examples + +### Update a credential + +Specify the desired `acs_credential_id` and updated `code` to update the credential. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.credentials.update({ + acs_credential_id: "66666666-6666-6666-6666-666666666666", + code: "7890", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.credentials.update( + acs_credential_id="66666666-6666-6666-6666-666666666666", code="7890" +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.credentials.update(acs_credential_id: "66666666-6666-6666-6666-666666666666", code: "7890") +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->credentials->update( + acs_credential_id: "66666666-6666-6666-6666-666666666666", + code: "7890" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs credentials update --acs_credential_id "66666666-6666-6666-6666-666666666666" --code "7890" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import credentials "github.com/seamapi/go/credentials" + +func main() { + client.Acs.Credentials.Update( + context.Background(), + credentials.CredentialsUpdateRequest{ + AcsCredentialId: api.String("66666666-6666-6666-6666-666666666666"), + Code: api.String("7890"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 03d2c8eca..791005e9a 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -46,4 +46,4 @@ Number of `acs_encoders` to return. ## Return Type -Array<[acs\_encoder](./)> +Array of [acs\_encoders](./) diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 574b61d47..e8049fe0d 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -26,3 +26,143 @@ POST /acs/entrances/get ⇒ { acs_entrance } ## Return Type [acs\_entrance](./) + +--- + +## Examples + +### Get an entrance + +Specify the `acs_entrance_id` of the entrance that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.entrances.get({ + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Output + +```javascript +{ + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.entrances.get(acs_entrance_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Output + +```python +AcsEntrance( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="text", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.entrances.get(acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Output + +```ruby +{ + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->entrances->get( + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs entrances get --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Output + +```seam_cli +{ + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import entrances "github.com/seamapi/go/entrances" + +func main() { + client.Acs.Entrances.Get( + context.Background(), + entrances.EntrancesGetRequest{ + AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Output + +```go +api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 6088ccecb..171028c70 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -31,4 +31,142 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ## Return Type -Array<[acs\_entrance](./)> +Array of [acs\_entrances](./) + +--- + +## Examples + +### List entrances + +To filter the list of entrances, specify the desired `acs_system_id` or `acs_user_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.entrances.list(); +``` + +#### Output + +```javascript +[ + { + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.entrances.list() +``` + +#### Output + +```python +[ + AcsEntrance( + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + acs_entrance_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="text", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.entrances.list() +``` + +#### Output + +```ruby +[ + { + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->entrances->list(); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "text", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs entrances list +``` + +#### Output + +```seam_cli +[ + { + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_entrance_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "text" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +func main() { + client.Acs.Entrances.List(context.Background()) +} +``` + +#### Output + +```go +[]api.AcsEntrance{api.AcsEntrance{AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsEntranceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "text"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 8f349e184..915c84fde 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -38,4 +38,239 @@ Possible enum values: ## Return Type -Array<[acs\_credential](./)> +Array of [acs\_credentials](./) + +--- + +## Examples + +### List credentials with access to an entrance + +Specify the `acs_entrance_id` to return all credentials that grant access to the specified entrance. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.entrances.listCredentialsWithAccess({ + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Output + +```javascript +[ + { + "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "display_name": "text", + "code": "text", + "card_number": "text", + "is_issued": false, + "issued_at": "2024-10-15T12:54:04.155Z", + "access_method": "code", + "external_type": "pti_card", + "external_type_display_name": "text", + "created_at": "2024-10-15T12:54:04.155Z", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "starts_at": "text", + "ends_at": "text", + "is_multi_phone_sync_credential": false, + "is_latest_desired_state_synced_with_provider": false, + "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.entrances.list_credentials_with_access( + acs_entrance_id="123e4567-e89b-12d3-a456-426614174000" +) +``` + +#### Output + +```python +[ + AcsCredential( + acs_credential_id="123e4567-e89b-12d3-a456-426614174000", + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_credential_pool_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + parent_acs_credential_id="123e4567-e89b-12d3-a456-426614174000", + display_name="text", + code="text", + card_number="text", + is_issued=false, + issued_at="2024-10-15T12:54:04.155Z", + access_method="code", + external_type="pti_card", + external_type_display_name="text", + created_at="2024-10-15T12:54:04.155Z", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + starts_at="text", + ends_at="text", + is_multi_phone_sync_credential=false, + is_latest_desired_state_synced_with_provider=false, + latest_desired_state_synced_with_provider_at="2024-10-15T12:54:04.155Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.entrances.list_credentials_with_access( + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Output + +```ruby +[ + { + "acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", + "display_name" => "text", + "code" => "text", + "card_number" => "text", + "is_issued" => false, + "issued_at" => "2024-10-15T12:54:04.155Z", + "access_method" => "code", + "external_type" => "pti_card", + "external_type_display_name" => "text", + "created_at" => "2024-10-15T12:54:04.155Z", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "starts_at" => "text", + "ends_at" => "text", + "is_multi_phone_sync_credential" => false, + "is_latest_desired_state_synced_with_provider" => false, + "latest_desired_state_synced_with_provider_at" => "2024-10-15T12:54:04.155Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->entrances->list_credentials_with_access( + acs_entrance_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id" => "123e4567-e89b-12d3-a456-426614174000", + "display_name" => "text", + "code" => "text", + "card_number" => "text", + "is_issued" => false, + "issued_at" => "2024-10-15T12:54:04.155Z", + "access_method" => "code", + "external_type" => "pti_card", + "external_type_display_name" => "text", + "created_at" => "2024-10-15T12:54:04.155Z", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "starts_at" => "text", + "ends_at" => "text", + "is_multi_phone_sync_credential" => false, + "is_latest_desired_state_synced_with_provider" => false, + "latest_desired_state_synced_with_provider_at" => + "2024-10-15T12:54:04.155Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs entrances list-credentials-with-access --acs_entrance_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Output + +```seam_cli +[ + { + "acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_credential_pool_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "parent_acs_credential_id": "123e4567-e89b-12d3-a456-426614174000", + "display_name": "text", + "code": "text", + "card_number": "text", + "is_issued": false, + "issued_at": "2024-10-15T12:54:04.155Z", + "access_method": "code", + "external_type": "pti_card", + "external_type_display_name": "text", + "created_at": "2024-10-15T12:54:04.155Z", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "starts_at": "text", + "ends_at": "text", + "is_multi_phone_sync_credential": false, + "is_latest_desired_state_synced_with_provider": false, + "latest_desired_state_synced_with_provider_at": "2024-10-15T12:54:04.155Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import entrances "github.com/seamapi/go/entrances" + +func main() { + client.Acs.Entrances.ListCredentialsWithAccess( + context.Background(), + entrances.EntrancesListCredentialsWithAccessRequest{ + AcsEntranceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsCredential{api.AcsCredential{AcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsCredentialPoolId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", ParentAcsCredentialId: "123e4567-e89b-12d3-a456-426614174000", DisplayName: "text", Code: "text", CardNumber: "text", IsIssued: false, IssuedAt: "2024-10-15T12:54:04.155Z", AccessMethod: "code", ExternalType: "pti_card", ExternalTypeDisplayName: "text", CreatedAt: "2024-10-15T12:54:04.155Z", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", StartsAt: "text", EndsAt: "text", IsMultiPhoneSyncCredential: false, IsLatestDesiredStateSyncedWithProvider: false, LatestDesiredStateSyncedWithProviderAt: "2024-10-15T12:54:04.155Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 5656f20dd..0ec9b88fb 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -31,3 +31,116 @@ ID of the desired access control system. ## Return Type [acs\_system](./) + +--- + +## Examples + +### Get a Specific ACS system + +Specify the `acs_system_id` of the ACS system that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.systems.get({ + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Output + +```javascript +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.systems.get(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```python +[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.systems.get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```ruby +[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->systems->get(acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Output + +```php + "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs systems get --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Output + +```seam_cli +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import systems "github.com/seamapi/go/systems" + +func main() { + client.Acs.Systems.Get( + context.Background(), + systems.SystemsGetRequest{ + AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 40e644b08..63f0bac00 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -31,4 +31,119 @@ ID of the connected account by which to filter the list of returned access contr ## Return Type -Array<[acs\_system](./)> +Array of [acs\_systems](./) + +--- + +## Examples + +### List ACS systems by connected account + +To filter the list of ACS systems, include a `connected_account_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.systems.list({ + connected_account_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Output + +```javascript +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.systems.list(connected_account_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Output + +```python +[AcsSystem(acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33")] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.systems.list(connected_account_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Output + +```ruby +[{ "acs_system_id" => "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->systems->list( + connected_account_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Output + +```php + "8d7e0b3a-b889-49a7-9164-4b71a0506a33"]]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs systems list --connected_account_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Output + +```seam_cli +[{ "acs_system_id": "8d7e0b3a-b889-49a7-9164-4b71a0506a33" }] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import systems "github.com/seamapi/go/systems" + +func main() { + client.Acs.Systems.List( + context.Background(), + systems.SystemsListRequest{ + ConnectedAccountId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 9d6629089..b9e7f084c 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -32,4 +32,123 @@ ID of the ACS system for which you want to retrieve all compatible credential ma ## Return Type -Array<[acs\_system](./)> +Array of [acs\_systems](./) + +--- + +## Examples + +### List compatible credential manager ACS systems + +Specify the `acs_system_id` for which you want to retrieve all compatible credential manager ACS systems. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.systems.listCompatibleCredentialManagerAcsSystems({ + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Output + +```javascript +[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.systems.list_compatible_credential_manager_acs_systems( + acs_system_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33" +) +``` + +#### Output + +```python +[AcsSystem(acs_system_id="aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4")] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.systems.list_compatible_credential_manager_acs_systems( + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +) +``` + +#### Output + +```ruby +[{ "acs_system_id" => "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->systems->list_compatible_credential_manager_acs_systems( + acs_system_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +); +``` + +#### Output + +```php + "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"]]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs systems list-compatible-credential-manager-acs-systems --acs_system_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Output + +```seam_cli +[{ "acs_system_id": "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4" }] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import systems "github.com/seamapi/go/systems" + +func main() { + client.Acs.Systems.ListCompatibleCredentialManagerAcsSystems( + context.Background(), + systems.SystemsListCompatibleCredentialManagerAcsSystemsRequest{ + AcsSystemId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "aczp0sgx-gl9f-nygd-r11e-7pc1zufn55z4"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 71682df26..b9958f1b6 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -35,3 +35,126 @@ ID of the desired `acs_user`. ## Return Type void + +--- + +## Examples + +### Add an ACS user to an access group + +Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.addToAccessGroup({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.add_to_access_group( + acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.add_to_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->add_to_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users add-to-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.AddToAccessGroup( + context.Background(), + users.UsersAddToAccessGroupRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 94ea1ad55..1bdd595fd 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -29,3 +29,115 @@ ID of the desired `acs_user`. ## Return Type void + +--- + +## Examples + +### Delete an ACS user + +Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.delete({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.delete(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->delete(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users delete --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Delete( + context.Background(), + users.UsersDeleteRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 5487db85c..7021de14f 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -29,3 +29,161 @@ ID of the desired `acs_user`. ## Return Type [acs\_user](./) + +--- + +## Examples + +### Get a specific ACS user + +Specify the `acs_user_id` of the specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.get({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Output + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.get(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->get(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users get --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Output + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Get( + context.Background(), + users.UsersGetRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Output + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index f055fe061..542612c25 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -69,4 +69,152 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s ## Return Type -Array<[acs\_user](./)> +Array of [acs\_users](./) + +--- + +## Examples + +### List all ACS users + +Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.list(); +``` + +#### Output + +```javascript +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.list() +``` + +#### Output + +```python +AcsUser( + acs_user_id="123e4567-e89b-12d3-a456-426614174000", + acs_system_id="123e4567-e89b-12d3-a456-426614174000", + workspace_id="123e4567-e89b-12d3-a456-426614174000", + created_at="2024-04-05T07:57:05.323Z", + display_name="Jane Doe", + full_name="Jane Doe", + email_address="jane@example.com", + phone_number="+15555550100", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.list() +``` + +#### Output + +```ruby +{ + "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->list(); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + "display_name" => "Jane Doe", + "full_name" => "Jane Doe", + "email_address" => "jane@example.com", + "phone_number" => "+15555550100", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users list +``` + +#### Output + +```seam_cli +{ + "acs_user_id": "123e4567-e89b-12d3-a456-426614174000", + "acs_system_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + "display_name": "Jane Doe", + "full_name": "Jane Doe", + "email_address": "jane@example.com", + "phone_number": "+15555550100" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +func main() { + client.Acs.Users.List(context.Background()) +} +``` + +#### Output + +```go +api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 9c178ab8d..269c052e9 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -29,4 +29,4 @@ ID of the desired `acs_user`. ## Return Type -Array<[acs\_entrance](./)> +Array of [acs\_entrances](./) diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index bcfaf0b5b..e9cb574a4 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -35,3 +35,126 @@ ID of the desired `acs_user`. ## Return Type void + +--- + +## Examples + +### Remove an ACS user from an access group + +Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.removeFromAccessGroup({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.remove_from_access_group( + acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id="123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.remove_from_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->remove_from_access_group( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + acs_access_group_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users remove-from-access-group --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --acs_access_group_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.RemoveFromAccessGroup( + context.Background(), + users.UsersRemoveFromAccessGroupRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + AcsAccessGroupId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 1358224c5..961f9c9a5 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -29,3 +29,115 @@ ID of the desired `acs_user`. ## Return Type void + +--- + +## Examples + +### Suspend an ACS user + +[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.suspend({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.suspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->suspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33"); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users suspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Suspend( + context.Background(), + users.UsersSuspendRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index abe4218cf..88f7d9f71 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -29,3 +29,117 @@ ID of the desired `acs_user`. ## Return Type void + +--- + +## Examples + +### Unsuspend an ACS user + +[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.unsuspend({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.unsuspend(acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.unsuspend(acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33") +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->unsuspend( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users unsuspend --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Unsuspend( + context.Background(), + users.UsersUnsuspendRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 45cfa702e..02731bb83 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -61,3 +61,125 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc ## Return Type void + +--- + +## Examples + +### Update an ACS user + +Update the properties of a specific [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.acs.users.update({ + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: "+15555550222", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.acs.users.update( + acs_user_id="8d7e0b3a-b889-49a7-9164-4b71a0506a33", phone_number="+15555550222" +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.acs.users.update( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: "+15555550222", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +acs->users->update( + acs_user_id: "8d7e0b3a-b889-49a7-9164-4b71a0506a33", + phone_number: "+15555550222" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam acs users update --acs_user_id "8d7e0b3a-b889-49a7-9164-4b71a0506a33" --phone_number "+15555550222" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import users "github.com/seamapi/go/users" + +func main() { + client.Acs.Users.Update( + context.Background(), + users.UsersUpdateRequest{ + AcsUserId: api.String("8d7e0b3a-b889-49a7-9164-4b71a0506a33"), + PhoneNumber: api.String("+15555550222"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 5e5cad190..61becf943 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -34,4 +34,4 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type -Array<[phone](./)> +Array of [phones](./) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index d858a3d0a..79b3de12c 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -82,3 +82,145 @@ ID of the action attempt. --- + +--- + +## Examples + +### Activate a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.activateClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +}); +``` + +#### Output + +```javascript +{ + "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", + "status": "pending", + "action_type": "ACTIVATE_CLIMATE_PRESET" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.activate_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" +) +``` + +#### Output + +```python +ActionAttempt( + action_attempt_id="05de2295-d1dc-4748-aae3-9931658bde20", + status="pending", + action_type="ACTIVATE_CLIMATE_PRESET", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.activate_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +) +``` + +#### Output + +```ruby +{ + "action_attempt_id" => "05de2295-d1dc-4748-aae3-9931658bde20", + "status" => "pending", + "action_type" => "ACTIVATE_CLIMATE_PRESET", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->activate_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied" +); +``` + +#### Output + +```php + "05de2295-d1dc-4748-aae3-9931658bde20", + "status" => "pending", + "action_type" => "ACTIVATE_CLIMATE_PRESET", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats activate-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" +``` + +#### Output + +```seam_cli +{ + "action_attempt_id": "05de2295-d1dc-4748-aae3-9931658bde20", + "status": "pending", + "action_type": "ACTIVATE_CLIMATE_PRESET" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.ActivateClimatePreset( + context.Background(), + api.ThermostatsActivateClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + }, + ) +} +``` + +#### Output + +```go +api.ActionAttempt{ActionAttemptId: "05de2295-d1dc-4748-aae3-9931658bde20", Status: "pending", ActionType: "ACTIVATE_CLIMATE_PRESET"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 939631b97..20a80d7f6 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -89,3 +89,145 @@ ID of the action attempt. --- + +--- + +## Examples + +### Set to cool mode + +Specify the desired cooling set point in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.cool({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, +}); +``` + +#### Output + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_COOL" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.cool( + device_id="123e4567-e89b-12d3-a456-426614174000", cooling_set_point_celsius=25 +) +``` + +#### Output + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_COOL", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, +) +``` + +#### Output + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_COOL", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25 +); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_COOL", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 +``` + +#### Output + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_COOL" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.Cool( + context.Background(), + api.ThermostatsCoolRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + CoolingSetPointCelsius: api.Float64(25), + }, + ) +} +``` + +#### Output + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_COOL"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 32ca4e7b9..e7a5cdcf0 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -84,3 +84,155 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void + +--- + +## Examples + +### Create a climate preset + +Specify the `device_id` of the desired thermostat, along with the desired settings for the climate preset, including `manual_override_allowed`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.createClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + name: "Occupied", + fan_mode_setting: "auto", + hvac_mode_setting: "heat_cool", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, + manual_override_allowed: true, +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.create_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", + climate_preset_key="occupied", + name="Occupied", + fan_mode_setting="auto", + hvac_mode_setting="heat_cool", + cooling_set_point_celsius=25, + heating_set_point_celsius=20, + manual_override_allowed=true, +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.create_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + name: "Occupied", + fan_mode_setting: "auto", + hvac_mode_setting: "heat_cool", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, + manual_override_allowed: true, +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->create_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + name: "Occupied", + fan_mode_setting: "auto", + hvac_mode_setting: "heat_cool", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, + manual_override_allowed: true +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats create-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --name "Occupied" --fan_mode_setting "auto" --hvac_mode_setting "heat_cool" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 --manual_override_allowed true +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.CreateClimatePreset( + context.Background(), + api.ThermostatsCreateClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + Name: api.String("Occupied"), + FanModeSetting: api.String("auto"), + HvacModeSetting: api.String("heat_cool"), + CoolingSetPointCelsius: api.Float64(25), + HeatingSetPointCelsius: api.Float64(20), + ManualOverrideAllowed: api.Bool(true), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index e54f762de..03b415807 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -36,3 +36,124 @@ ID of the desired thermostat device. ## Return Type void + +--- + +## Examples + +### Delete a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.deleteClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.delete_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="occupied" +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.delete_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->delete_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats delete-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.DeleteClimatePreset( + context.Background(), + api.ThermostatsDeleteClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index dc88b06a3..423098267 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -89,3 +89,145 @@ ID of the action attempt. --- + +--- + +## Examples + +### Set to heat mode + +Specify the desired heating set point in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.heat({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 20, +}); +``` + +#### Output + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.heat( + device_id="123e4567-e89b-12d3-a456-426614174000", heating_set_point_celsius=20 +) +``` + +#### Output + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_HEAT", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.heat( + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 20, +) +``` + +#### Output + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->heat( + device_id: "123e4567-e89b-12d3-a456-426614174000", + heating_set_point_celsius: 20 +); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats heat --device_id "123e4567-e89b-12d3-a456-426614174000" --heating_set_point_celsius 20 +``` + +#### Output + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.Heat( + context.Background(), + api.ThermostatsHeatRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + HeatingSetPointCelsius: api.Float64(20), + }, + ) +} +``` + +#### Output + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 9d17ea217..95558f734 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -101,3 +101,151 @@ ID of the action attempt. --- + +--- + +## Examples + +### Set to heat-cool (auto) mode + +Specify the desired heating set point in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.heatCool({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, +}); +``` + +#### Output + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT_COOL" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.heat_cool( + device_id="123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius=25, + heating_set_point_celsius=20, +) +``` + +#### Output + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_HEAT_COOL", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.heat_cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20, +) +``` + +#### Output + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT_COOL", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->heat_cool( + device_id: "123e4567-e89b-12d3-a456-426614174000", + cooling_set_point_celsius: 25, + heating_set_point_celsius: 20 +); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_HEAT_COOL", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats heat-cool --device_id "123e4567-e89b-12d3-a456-426614174000" --cooling_set_point_celsius 25 --heating_set_point_celsius 20 +``` + +#### Output + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_HEAT_COOL" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.HeatCool( + context.Background(), + api.ThermostatsHeatCoolRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + CoolingSetPointCelsius: api.Float64(25), + HeatingSetPointCelsius: api.Float64(20), + }, + ) +} +``` + +#### Output + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_HEAT_COOL"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 752ae6a9a..3d83e5792 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -130,4 +130,227 @@ Your own internal user ID for the user by which to filter devices. ## Return Type -Array<[device](./)> +Array of [devices](./) + +--- + +## Examples + +### List thermostats + +To filter the list of returned thermostats, specify the desired parameters. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.list(); +``` + +#### Output + +```javascript +[ + { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "device_type": "ecobee_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z" + } + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.list() +``` + +#### Output + +```python +[ + Device( + device_id="123e4567-e89b-12d3-a456-426614174000", + device_type="ecobee_thermostat", + capabilities_supported=["thermostat"], + properties={ + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false, + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z", + }, + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.list() +``` + +#### Output + +```ruby +[ + { + "device_id" => "123e4567-e89b-12d3-a456-426614174000", + "device_type" => "ecobee_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => { + name: "Entryway", + online: "true,", + relative_humidity: 0.36, + temperature_farenheit: 70, + available_hvac_mode_settings: %w[cool heat heat_cool off], + current_climate_setting: { + hvac_mode_setting: "heat_cool", + cooling_set_point_farenheit: 75, + heating_set_point_farenheit: 65, + manual_override_allowed: false, + }, + location: null, + connected_account_id: "123e4567-e89b-12d3-a456-426614174000", + workspace_id: "123e4567-e89b-12d3-a456-426614174000", + created_at: "2024-04-05T07:57:05.323Z", + }, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->list(); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "device_type" => "ecobee_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => [ + "name" => "Entryway", + "online" => "true,", + "relative_humidity" => 0.36, + "temperature_farenheit" => 70, + "available_hvac_mode_settings" => [ + "cool", + "heat", + "heat_cool", + "off", + ], + "current_climate_setting" => [ + "hvac_mode_setting" => "heat_cool", + "cooling_set_point_farenheit" => 75, + "heating_set_point_farenheit" => 65, + "manual_override_allowed" => false, + ], + "location" => null, + "connected_account_id" => "123e4567-e89b-12d3-a456-426614174000", + "workspace_id" => "123e4567-e89b-12d3-a456-426614174000", + "created_at" => "2024-04-05T07:57:05.323Z", + ], + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats list +``` + +#### Output + +```seam_cli +[ + { + "device_id": "123e4567-e89b-12d3-a456-426614174000", + "device_type": "ecobee_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "name": "Entryway", + "online": "true,", + "relative_humidity": 0.36, + "temperature_farenheit": 70, + "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"], + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "cooling_set_point_farenheit": 75, + "heating_set_point_farenheit": 65, + "manual_override_allowed": false + }, + "location": null, + "connected_account_id": "123e4567-e89b-12d3-a456-426614174000", + "workspace_id": "123e4567-e89b-12d3-a456-426614174000", + "created_at": "2024-04-05T07:57:05.323Z" + } + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +func main() { + client.Thermostats.List(context.Background()) +} +``` + +#### Output + +```go +[]api.Device{api.Device{DeviceId: "123e4567-e89b-12d3-a456-426614174000", DeviceType: "ecobee_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Name: "Entryway", Online: "true,", RelativeHumidity: 0.36, TemperatureFarenheit: 70, AvailableHvacModeSettings: []string{"cool", "heat", "heat_cool", "off"}, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", CoolingSetPointFarenheit: 75, HeatingSetPointFarenheit: 65, ManualOverrideAllowed: false}, Location: nil, ConnectedAccountId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z"}}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 1cab1bb46..2b7473084 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -77,3 +77,135 @@ ID of the action attempt. --- + +--- + +## Examples + +### Set to off mode + +Specify the `device_id` of the thermostat that you want to set to off mode. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.off({ + device_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Output + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_THERMOSTAT_OFF" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.off(device_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Output + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_THERMOSTAT_OFF", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.off(device_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Output + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_THERMOSTAT_OFF", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->off(device_id: "123e4567-e89b-12d3-a456-426614174000"); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_THERMOSTAT_OFF", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats off --device_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Output + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_THERMOSTAT_OFF" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.Off( + context.Background(), + api.ThermostatsOffRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Output + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_THERMOSTAT_OFF"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 35dcf49da..8b254e6e8 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -66,3 +66,187 @@ User-friendly name to identify the thermostat schedule. ## Return Type [thermostat\_schedule](./) + +--- + +## Examples + +### Create a thermostat schedule + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, as well as the desired `starts_at` and `ends_at` times. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.schedules.create({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + name: "Reservation 1", + climate_preset_key: "occupied", + starts_at: "2024-11-01T15:00:00Z", + ends_at: "2024-11-05T12:00:00Z", + max_override_period_minutes: 90, +}); +``` + +#### Output + +```javascript +{ + "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name": "Reservation 1", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-05T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.schedules.create( + device_id="123e4567-e89b-12d3-a456-426614174000", + name="Reservation 1", + climate_preset_key="occupied", + starts_at="2024-11-01T15:00:00Z", + ends_at="2024-11-05T12:00:00Z", + max_override_period_minutes=90, +) +``` + +#### Output + +```python +ThermostatSchedule( + thermostat_schedule_id="56d29fcf-0674-4db5-8e03-b2370a77460a", + name="Reservation 1", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-01T15:00:00.000Z", + ends_at="2024-11-05T12:00:00.000Z", + max_override_period_minutes=90, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.schedules.create( + device_id: "123e4567-e89b-12d3-a456-426614174000", + name: "Reservation 1", + climate_preset_key: "occupied", + starts_at: "2024-11-01T15:00:00Z", + ends_at: "2024-11-05T12:00:00Z", + max_override_period_minutes: 90, +) +``` + +#### Output + +```ruby +{ + "thermostat_schedule_id" => "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name" => "Reservation 1", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-05T12:00:00.000Z", + "max_override_period_minutes" => 90, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->schedules->create( + device_id: "123e4567-e89b-12d3-a456-426614174000", + name: "Reservation 1", + climate_preset_key: "occupied", + starts_at: "2024-11-01T15:00:00Z", + ends_at: "2024-11-05T12:00:00Z", + max_override_period_minutes: 90 +); +``` + +#### Output + +```php + "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name" => "Reservation 1", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-01T15:00:00.000Z", + "ends_at" => "2024-11-05T12:00:00.000Z", + "max_override_period_minutes" => 90, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats schedules create --device_id "123e4567-e89b-12d3-a456-426614174000" --name "Reservation 1" --climate_preset_key "occupied" --starts_at "2024-11-01T15:00:00Z" --ends_at "2024-11-05T12:00:00Z" --max_override_period_minutes 90 +``` + +#### Output + +```seam_cli +{ + "thermostat_schedule_id": "56d29fcf-0674-4db5-8e03-b2370a77460a", + "name": "Reservation 1", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-01T15:00:00.000Z", + "ends_at": "2024-11-05T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Create( + context.Background(), + schedules.SchedulesCreateRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + Name: api.String("Reservation 1"), + ClimatePresetKey: api.String("occupied"), + StartsAt: api.String("2024-11-01T15:00:00Z"), + EndsAt: api.String("2024-11-05T12:00:00Z"), + MaxOverridePeriodMinutes: api.Float64(90), + }, + ) +} +``` + +#### Output + +```go +api.ThermostatSchedule{ThermostatScheduleId: "56d29fcf-0674-4db5-8e03-b2370a77460a", Name: "Reservation 1", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-01T15:00:00.000Z", EndsAt: "2024-11-05T12:00:00.000Z", MaxOverridePeriodMinutes: 90} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 0b8d01dc6..1e2148256 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -30,3 +30,119 @@ ID of the desired thermostat schedule. ## Return Type void + +--- + +## Examples + +### Delete a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.schedules.delete({ + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.schedules.delete( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.schedules.delete(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->schedules->delete( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats schedules delete --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Delete( + context.Background(), + schedules.SchedulesDeleteRequest{ + ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index c1b349e7a..4bfb5baf3 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -30,3 +30,160 @@ ID of the desired thermostat schedule. ## Return Type [thermostat\_schedule](./) + +--- + +## Examples + +### Get a specific thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.schedules.get({ + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", +}); +``` + +#### Output + +```javascript +{ + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.schedules.get( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4" +) +``` + +#### Output + +```python +ThermostatSchedule( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", + name="Reservation 2", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-10T15:00:00.000Z", + ends_at="2024-11-15T12:00:00.000Z", + max_override_period_minutes=90, +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4") +``` + +#### Output + +```ruby +{ + "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->schedules->get( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +); +``` + +#### Output + +```php + "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" +``` + +#### Output + +```seam_cli +{ + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Get( + context.Background(), + schedules.SchedulesGetRequest{ + ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), + }, + ) +} +``` + +#### Output + +```go +api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 55e1b259d..7b1e4c7b5 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -35,4 +35,214 @@ User identifier key by which to filter the list of returned thermostat schedules ## Return Type -Array<[thermostat\_schedule](./)> +Array of [thermostat\_schedules](./) + +--- + +## Examples + +### List thermostat schedules for a thermostat + +Specify the `device_id` of the desired thermostat. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.schedules.list({ + device_id: "123e4567-e89b-12d3-a456-426614174000", +}); +``` + +#### Output + +```javascript +[ + { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 + }, + { + "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", + "name": "Reservation 3", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-16T15:00:00.000Z", + "ends_at": "2024-11-18T12:00:00.000Z", + "max_override_period_minutes": 90 + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.schedules.list(device_id="123e4567-e89b-12d3-a456-426614174000") +``` + +#### Output + +```python +[ + ThermostatSchedule( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", + name="Reservation 2", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-10T15:00:00.000Z", + ends_at="2024-11-15T12:00:00.000Z", + max_override_period_minutes=90, + ), + ThermostatSchedule( + thermostat_schedule_id="665553d1-94f9-4e92-9739-06ac6362c959", + name="Reservation 3", + device_id="2d488679-6f07-4810-aed2-e726872c1dd5", + climate_preset_key="occupied", + starts_at="2024-11-16T15:00:00.000Z", + ends_at="2024-11-18T12:00:00.000Z", + max_override_period_minutes=90, + ), +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.schedules.list(device_id: "123e4567-e89b-12d3-a456-426614174000") +``` + +#### Output + +```ruby +[ + { + "thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, + }, + { + "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", + "name" => "Reservation 3", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-16T15:00:00.000Z", + "ends_at" => "2024-11-18T12:00:00.000Z", + "max_override_period_minutes" => 90, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->schedules->list( + device_id: "123e4567-e89b-12d3-a456-426614174000" +); +``` + +#### Output + +```php + "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name" => "Reservation 2", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-10T15:00:00.000Z", + "ends_at" => "2024-11-15T12:00:00.000Z", + "max_override_period_minutes" => 90, + ], + [ + "thermostat_schedule_id" => "665553d1-94f9-4e92-9739-06ac6362c959", + "name" => "Reservation 3", + "device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key" => "occupied", + "starts_at" => "2024-11-16T15:00:00.000Z", + "ends_at" => "2024-11-18T12:00:00.000Z", + "max_override_period_minutes" => 90, + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats schedules list --device_id "123e4567-e89b-12d3-a456-426614174000" +``` + +#### Output + +```seam_cli +[ + { + "thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + "name": "Reservation 2", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-10T15:00:00.000Z", + "ends_at": "2024-11-15T12:00:00.000Z", + "max_override_period_minutes": 90 + }, + { + "thermostat_schedule_id": "665553d1-94f9-4e92-9739-06ac6362c959", + "name": "Reservation 3", + "device_id": "2d488679-6f07-4810-aed2-e726872c1dd5", + "climate_preset_key": "occupied", + "starts_at": "2024-11-16T15:00:00.000Z", + "ends_at": "2024-11-18T12:00:00.000Z", + "max_override_period_minutes": 90 + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.List( + context.Background(), + schedules.SchedulesListRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + }, + ) +} +``` + +#### Output + +```go +[]api.ThermostatSchedule{api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}, api.ThermostatSchedule{ThermostatScheduleId: "665553d1-94f9-4e92-9739-06ac6362c959", Name: "Reservation 3", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-16T15:00:00.000Z", EndsAt: "2024-11-18T12:00:00.000Z", MaxOverridePeriodMinutes: 90}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index fa9c2dafa..ead3f2020 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -66,3 +66,126 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www ## Return Type void + +--- + +## Examples + +### Update a thermostat schedule + +Specify the `thermostat_schedule_id` of the desired thermostat schedule, along with the desired updated settings for the thermostat schedule. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.schedules.update({ + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.schedules.update( + thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at="2024-11-15T15:00:00Z", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.schedules.update( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->schedules->update( + thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", + ends_at: "2024-11-15T15:00:00Z" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats schedules update --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4" --ends_at "2024-11-15T15:00:00Z" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import schedules "github.com/seamapi/go/schedules" + +func main() { + client.Thermostats.Schedules.Update( + context.Background(), + schedules.SchedulesUpdateRequest{ + ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"), + EndsAt: api.String("2024-11-15T15:00:00Z"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 2d28827bc..7650e9f3b 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -35,3 +35,124 @@ ID of the desired thermostat device. ## Return Type void + +--- + +## Examples + +### Set the fallback climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired fallback climate preset. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.setFallbackClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.set_fallback_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", climate_preset_key="eco" +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.set_fallback_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->set_fallback_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "eco" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats set-fallback-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "eco" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetFallbackClimatePreset( + context.Background(), + api.ThermostatsSetFallbackClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("eco"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 06dbf1565..3432f47c7 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -85,3 +85,145 @@ ID of the action attempt. --- + +--- + +## Examples + +### Set fan mode setting + +Specify the desired fan mode setting. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.setFanMode({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + fan_mode_setting: "auto", +}); +``` + +#### Output + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_FAN_MODE" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.set_fan_mode( + device_id="123e4567-e89b-12d3-a456-426614174000", fan_mode_setting="auto" +) +``` + +#### Output + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="pending", + action_type="SET_FAN_MODE", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.set_fan_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + fan_mode_setting: "auto", +) +``` + +#### Output + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_FAN_MODE", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->set_fan_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + fan_mode_setting: "auto" +); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "pending", + "action_type" => "SET_FAN_MODE", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats set-fan-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --fan_mode_setting "auto" +``` + +#### Output + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "pending", + "action_type": "SET_FAN_MODE" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetFanMode( + context.Background(), + api.ThermostatsSetFanModeRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + FanModeSetting: api.String("auto"), + }, + ) +} +``` + +#### Output + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "pending", ActionType: "SET_FAN_MODE"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 160ed06f1..5a5296af9 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -105,3 +105,156 @@ ID of the action attempt. --- + +--- + +## Examples + +### Set HVAC mode + +Specify the desired heating and cooling set points in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.setHvacMode({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting: "heat_cool", + heating_set_point_celsius: 20, + cooling_set_point_celsius: 25, +}); +``` + +#### Output + +```javascript +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "success", + "action_type": "SET_HVAC_MODE" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.set_hvac_mode( + device_id="123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting="heat_cool", + heating_set_point_celsius=20, + cooling_set_point_celsius=25, +) +``` + +#### Output + +```python +ActionAttempt( + action_attempt_id="123e4567-e89b-12d3-a456-426614174000", + status="success", + action_type="SET_HVAC_MODE", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.set_hvac_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting: "heat_cool", + heating_set_point_celsius: 20, + cooling_set_point_celsius: 25, +) +``` + +#### Output + +```ruby +{ + "action_attempt_id" => "123e4567-e89b-12d3-a456-426614174000", + "status" => "success", + "action_type" => "SET_HVAC_MODE", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->set_hvac_mode( + device_id: "123e4567-e89b-12d3-a456-426614174000", + hvac_mode_setting: "heat_cool", + heating_set_point_celsius: 20, + cooling_set_point_celsius: 25 +); +``` + +#### Output + +```php + "123e4567-e89b-12d3-a456-426614174000", + "status" => "success", + "action_type" => "SET_HVAC_MODE", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats set-hvac-mode --device_id "123e4567-e89b-12d3-a456-426614174000" --hvac_mode_setting "heat_cool" --heating_set_point_celsius 20 --cooling_set_point_celsius 25 +``` + +#### Output + +```seam_cli +{ + "action_attempt_id": "123e4567-e89b-12d3-a456-426614174000", + "status": "success", + "action_type": "SET_HVAC_MODE" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetHvacMode( + context.Background(), + api.ThermostatsSetHvacModeRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + HvacModeSetting: api.String("heat_cool"), + HeatingSetPointCelsius: api.Float64(20), + CoolingSetPointCelsius: api.Float64(25), + }, + ) +} +``` + +#### Output + +```go +api.ActionAttempt{ActionAttemptId: "123e4567-e89b-12d3-a456-426614174000", Status: "success", ActionType: "SET_HVAC_MODE"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 7ce21e3aa..08c081e51 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -53,3 +53,130 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i ## Return Type void + +--- + +## Examples + +### Set a temperature threshold + +Specify the `device_id` of the desired thermostat, along with the desired upper and lower limits in °C or °F. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.setTemperatureThreshold({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30, +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.set_temperature_threshold( + device_id="123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius=4, + upper_limit_celsius=30, +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.set_temperature_threshold( + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30, +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->set_temperature_threshold( + device_id: "123e4567-e89b-12d3-a456-426614174000", + lower_limit_celsius: 4, + upper_limit_celsius: 30 +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats set-temperature-threshold --device_id "123e4567-e89b-12d3-a456-426614174000" --lower_limit_celsius 4 --upper_limit_celsius 30 +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.SetTemperatureThreshold( + context.Background(), + api.ThermostatsSetTemperatureThresholdRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + LowerLimitCelsius: api.Float64(4), + UpperLimitCelsius: api.Float64(30), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 67cf6220d..913509d19 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -84,3 +84,135 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther ## Return Type void + +--- + +## Examples + +### Update a climate preset + +Specify the `device_id` of the desired thermostat and the `climate_preset_key` of the desired climate preset, along with the desired updated settings for the climate preset, including `manual_override_allowed`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.thermostats.updateClimatePreset({ + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + cooling_set_point_celsius: 24, + manual_override_allowed: true, +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.thermostats.update_climate_preset( + device_id="123e4567-e89b-12d3-a456-426614174000", + climate_preset_key="occupied", + cooling_set_point_celsius=24, + manual_override_allowed=true, +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.thermostats.update_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + cooling_set_point_celsius: 24, + manual_override_allowed: true, +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +thermostats->update_climate_preset( + device_id: "123e4567-e89b-12d3-a456-426614174000", + climate_preset_key: "occupied", + cooling_set_point_celsius: 24, + manual_override_allowed: true +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam thermostats update-climate-preset --device_id "123e4567-e89b-12d3-a456-426614174000" --climate_preset_key "occupied" --cooling_set_point_celsius 24 --manual_override_allowed true +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.Thermostats.UpdateClimatePreset( + context.Background(), + api.ThermostatsUpdateClimatePresetRequest{ + DeviceId: api.String("123e4567-e89b-12d3-a456-426614174000"), + ClimatePresetKey: api.String("occupied"), + CoolingSetPointCelsius: api.Float64(24), + ManualOverrideAllowed: api.Bool(true), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index d228070f4..0fb60b436 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -35,3 +35,125 @@ ID of the desired user identity. ## Return Type void + +--- + +## Examples + +### Add an ACS user to a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.addAcsUser({ + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.add_acs_user( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.add_acs_user( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->add_acs_user( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + acs_user_id: "4d223973-0874-4831-8630-bfcb29e6bce0" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities add-acs-user --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" --acs_user_id "4d223973-0874-4831-8630-bfcb29e6bce0" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.AddAcsUser( + context.Background(), + api.UserIdentitiesAddAcsUserRequest{ + UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), + AcsUserId: api.String("4d223973-0874-4831-8630-bfcb29e6bce0"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 8ab890dcd..8a5dd62e4 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -47,3 +47,181 @@ Unique key for the user identity. ## Return Type [user\_identity](./) + +--- + +## Examples + +### Create a user identity + +Specify one or more of the unique `user_identity_key`, `email_address`, or `phone_number`. You can also specify the `full_name` of the user associated with the `user_identity`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.create({ + user_identity_key: "jean_doe", + email_address: "jean@example.com", + phone_number: "+15555550110", + full_name: "Jean Doe", +}); +``` + +#### Output + +```javascript +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.create( + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + full_name="Jean Doe", +) +``` + +#### Output + +```python +UserIdentity( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + display_name="Jean Doe", + full_name="Jean Doe", + created_at="2024-01-11T05:37:50.264Z", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.create( + user_identity_key: "jean_doe", + email_address: "jean@example.com", + phone_number: "+15555550110", + full_name: "Jean Doe", +) +``` + +#### Output + +```ruby +{ + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->create( + user_identity_key: "jean_doe", + email_address: "jean@example.com", + phone_number: "+15555550110", + full_name: "Jean Doe" +); +``` + +#### Output + +```php + "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities create --user_identity_key "jean_doe" --email_address "jean@example.com" --phone_number "+15555550110" --full_name "Jean Doe" +``` + +#### Output + +```seam_cli +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.Create( + context.Background(), + api.UserIdentitiesCreateRequest{ + UserIdentityKey: api.String("jean_doe"), + EmailAddress: api.String("jean@example.com"), + PhoneNumber: api.String("+15555550110"), + FullName: api.String("Jean Doe"), + }, + ) +} +``` + +#### Output + +```go +api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index e393907da..f201c15bc 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -29,3 +29,116 @@ ID of the desired user identity. ## Return Type void + +--- + +## Examples + +### Delete a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.delete({ + user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.delete(user_identity_id="44d48b20-0dbe-419d-91ca-ab8bceecd135") +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.delete(user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135") +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->delete( + user_identity_id: "44d48b20-0dbe-419d-91ca-ab8bceecd135" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities delete --user_identity_id "44d48b20-0dbe-419d-91ca-ab8bceecd135" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.Delete( + context.Background(), + api.UserIdentitiesDeleteRequest{ + UserIdentityId: api.String("44d48b20-0dbe-419d-91ca-ab8bceecd135"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index b8a70cbb9..97fa90d6e 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -29,3 +29,121 @@ ID of the desired enrollment automation. ## Return Type void + +--- + +## Examples + +### Delete an enrollment automation + +Specify the desired `enrollment_automation_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.enrollmentAutomations.delete({ + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.enrollment_automations.delete( + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.enrollment_automations.delete( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->enrollment_automations->delete( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities enrollment-automations delete --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.Delete( + context.Background(), + enrollmentautomations.EnrollmentAutomationsDeleteRequest{ + EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index e0ffb2cf6..f8a63e33a 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -30,3 +30,164 @@ ID of the desired enrollment automation. ## Return Type [enrollment\_automation](./) + +--- + +## Examples + +### Get an enrollment automation + +Specify the desired `enrollment_automation_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.enrollmentAutomations.get({ + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +}); +``` + +#### Output + +```javascript +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.enrollment_automations.get( + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895" +) +``` + +#### Output + +```python +EnrollmentAutomation( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", + acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + is_running=true, + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-09T05:45:33.068Z", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.enrollment_automations.get( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895", +) +``` + +#### Output + +```ruby +{ + "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->enrollment_automations->get( + enrollment_automation_id: "05505650-aa57-49ab-8f19-429738758895" +); +``` + +#### Output + +```php + "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => + "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => + "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities enrollment-automations get --enrollment_automation_id "05505650-aa57-49ab-8f19-429738758895" +``` + +#### Output + +```seam_cli +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.Get( + context.Background(), + enrollmentautomations.EnrollmentAutomationsGetRequest{ + EnrollmentAutomationId: api.String("05505650-aa57-49ab-8f19-429738758895"), + }, + ) +} +``` + +#### Output + +```go +api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index f66b5caf6..9ba663a51 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -53,3 +53,179 @@ ID of the associated ACS user within the credential manager. If you specify a `c ## Return Type [unknown](./) + +--- + +## Examples + +### Launch an enrollment automation + +Specify the desired `user_identity_id` and `credential_manager_acs_system_id`. You can also specify an `acs_credential_pool_id`. Either set `create_credential_manager_user` to `true` or specify the `credential_manager_acs_user_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.enrollmentAutomations.launch({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user: true, +}); +``` + +#### Output + +```javascript +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.enrollment_automations.launch( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id="3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user=true, +) +``` + +#### Output + +```python +Unknown( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", + acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + is_running=true, + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-09T05:45:33.068Z", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.enrollment_automations.launch( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user: true, +) +``` + +#### Output + +```ruby +{ + "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->enrollment_automations->launch( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + credential_manager_acs_system_id: "6737e186-8d54-48ce-a7da-a0be4d252172", + acs_credential_pool_id: "3fa85f64-5717-4562-b3fc-2c963f66afa6", + create_credential_manager_user: true +); +``` + +#### Output + +```php + "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => + "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => + "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities enrollment-automations launch --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --credential_manager_acs_system_id "6737e186-8d54-48ce-a7da-a0be4d252172" --acs_credential_pool_id "3fa85f64-5717-4562-b3fc-2c963f66afa6" --create_credential_manager_user true +``` + +#### Output + +```seam_cli +{ + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.Launch( + context.Background(), + enrollmentautomations.EnrollmentAutomationsLaunchRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + CredentialManagerAcsSystemId: api.String("6737e186-8d54-48ce-a7da-a0be4d252172"), + AcsCredentialPoolId: api.String("3fa85f64-5717-4562-b3fc-2c963f66afa6"), + CreateCredentialManagerUser: api.Bool(true), + }, + ) +} +``` + +#### Output + +```go +api.Unknown{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 2d649b65e..21d7dd4bf 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -29,4 +29,175 @@ ID of the user identity for which you want to retrieve all enrollment automation ## Return Type -Array<[enrollment\_automation](./)> +Array of [enrollment\_automations](./) + +--- + +## Examples + +### List enrollment automations + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.enrollmentAutomations.list({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", +}); +``` + +#### Output + +```javascript +[ + { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.enrollment_automations.list( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" +) +``` + +#### Output + +```python +[ + EnrollmentAutomation( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + enrollment_automation_id="05505650-aa57-49ab-8f19-429738758895", + acs_credential_provisioning_automation_id="05505650-aa57-49ab-8f19-429738758895", + credential_manager_acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + is_running=true, + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-09T05:45:33.068Z", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.enrollment_automations.list( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", +) +``` + +#### Output + +```ruby +[ + { + "user_identity_id" => "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->enrollment_automations->list( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +); +``` + +#### Output + +```php + "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id" => "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id" => + "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id" => + "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running" => true, + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-09T05:45:33.068Z", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities enrollment-automations list --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +``` + +#### Output + +```seam_cli +[ + { + "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "acs_credential_provisioning_automation_id": "05505650-aa57-49ab-8f19-429738758895", + "credential_manager_acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "is_running": true, + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-09T05:45:33.068Z" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" +import enrollmentautomations "github.com/seamapi/go/enrollmentautomations" + +func main() { + client.UserIdentities.EnrollmentAutomations.List( + context.Background(), + enrollmentautomations.EnrollmentAutomationsListRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + }, + ) +} +``` + +#### Output + +```go +[]api.EnrollmentAutomation{api.EnrollmentAutomation{UserIdentityId: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895", AcsCredentialProvisioningAutomationId: "05505650-aa57-49ab-8f19-429738758895", CredentialManagerAcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", IsRunning: true, WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-09T05:45:33.068Z"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 200d84904..0e65eb402 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -33,3 +33,162 @@ ID of the desired user identity. ## Return Type [user\_identity](./) + +--- + +## Examples + +### Get a user identity + +Specify the `user_identity_id` of the user identity that you want to retrieve. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.get({ + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", +}); +``` + +#### Output + +```javascript +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.get(user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") +``` + +#### Output + +```python +UserIdentity( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + display_name="Jean Doe", + full_name="Jean Doe", + created_at="2024-01-11T05:37:50.264Z", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", +) +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.get(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") +``` + +#### Output + +```ruby +{ + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +} +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->get( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +); +``` + +#### Output + +```php + "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities get --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +``` + +#### Output + +```seam_cli +{ + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" +} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.Get( + context.Background(), + api.UserIdentitiesGetRequest{ + UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), + }, + ) +} +``` + +#### Output + +```go +api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 76dda86aa..880f602e8 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -35,3 +35,125 @@ ID of the desired user identity. ## Return Type void + +--- + +## Examples + +### Grant a user identity access to a device + +Specify the desired `user_identity_id` and `device_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.grantAccessToDevice({ + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.grant_access_to_device( + user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id="054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.grant_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->grant_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities grant-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.GrantAccessToDevice( + context.Background(), + api.UserIdentitiesGrantAccessToDeviceRequest{ + UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), + DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index ed5275ad3..05c21380e 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -27,4 +27,162 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ## Return Type -Array<[user\_identity](./)> +Array of [user\_identitys](./) + +--- + +## Examples + +### List user identities + +To filter the list of user identities, specify the desired `credential_manager_acs_system_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.list(); +``` + +#### Output + +```javascript +[ + { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.list() +``` + +#### Output + +```python +[ + UserIdentity( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_key="jean_doe", + email_address="jean@example.com", + phone_number="+15555550110", + display_name="Jean Doe", + full_name="Jean Doe", + created_at="2024-01-11T05:37:50.264Z", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.list() +``` + +#### Output + +```ruby +[ + { + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->list(); +``` + +#### Output + +```php + "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key" => "jean_doe", + "email_address" => "jean@example.com", + "phone_number" => "+15555550110", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "created_at" => "2024-01-11T05:37:50.264Z", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities list +``` + +#### Output + +```seam_cli +[ + { + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_key": "jean_doe", + "email_address": "jean@example.com", + "phone_number": "+15555550110", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "created_at": "2024-01-11T05:37:50.264Z", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +func main() { + client.UserIdentities.List(context.Background()) +} +``` + +#### Output + +```go +[]api.UserIdentity{api.UserIdentity{UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityKey: "jean_doe", EmailAddress: "jean@example.com", PhoneNumber: "+15555550110", DisplayName: "Jean Doe", FullName: "Jean Doe", CreatedAt: "2024-01-11T05:37:50.264Z", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 14d8c520f..bd9d3022f 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -28,4 +28,393 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Return Type -Array<[device](./)> +Array of [devices](./) + +--- + +## Examples + +### List accessible devices for a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.listAccessibleDevices({ + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", +}); +``` + +#### Output + +```javascript +[ + { + "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname": "", + "display_name": "Seam Thermostat", + "device_type": "nest_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68 + }, + "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": { "name": "" }, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false + }, + "location": null, + "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-02-29T21:57:33.397Z", + "errors": [], + "warnings": [], + "is_managed": true, + "custom_metadata": {} + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.list_accessible_devices( + user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf" +) +``` + +#### Output + +```python +[ + Device( + device_id="054765c8-a2fc-4599-b486-14c19f462c45", + nickname="", + display_name="Seam Thermostat", + device_type="nest_thermostat", + capabilities_supported=["thermostat"], + properties={ + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a", + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68, + }, + "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": {"name": ""}, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false, + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false, + }, + location=None, + connected_account_id="44284499-a50b-4947-86c1-58264f014be5", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-02-29T21:57:33.397Z", + errors=[], + warnings=[], + is_managed=true, + custom_metadata={}, + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.list_accessible_devices( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", +) +``` + +#### Output + +```ruby +[ + { + "device_id" => "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname" => "", + "display_name" => "Seam Thermostat", + "device_type" => "nest_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => { + online: true, + is_cooling: false, + is_heating: false, + manufacturer: "nest", + nest_metadata: { + custom_name: "", + device_name: + "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + nest_device_id: "bcca8c5f-1854-4906-9911-c877d513e00a", + }, + is_fan_running: false, + has_direct_power: true, + relative_humidity: 0.46, + temperature_celsius: 24.64, + temperature_fahrenheit: 76.352, + current_climate_setting: { + hvac_mode_setting: "heat_cool", + manual_override_allowed: true, + cooling_set_point_celsius: 21.5, + heating_set_point_celsius: 20, + cooling_set_point_fahrenheit: 70.7, + heating_set_point_fahrenheit: 68, + }, + available_hvac_mode_settings: %w[heat cool heat_cool off], + is_temporary_manual_override_active: false, + name: "", + appearance: { + name: "", + }, + model: { + display_name: "Thermostat", + manufacturer_display_name: "Nest", + accessory_keypad_supported: false, + }, + image_url: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + image_alt_text: "Placeholder Lock Image", + is_climate_setting_schedule_active: false, + }, + "location" => nil, + "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-02-29T21:57:33.397Z", + "errors" => [], + "warnings" => [], + "is_managed" => true, + "custom_metadata" => { + }, + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->list_accessible_devices( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf" +); +``` + +#### Output + +```php + "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname" => "", + "display_name" => "Seam Thermostat", + "device_type" => "nest_thermostat", + "capabilities_supported" => ["thermostat"], + "properties" => [ + "online" => true, + "is_cooling" => false, + "is_heating" => false, + "manufacturer" => "nest", + "nest_metadata" => [ + "custom_name" => "", + "device_name" => + "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id" => "bcca8c5f-1854-4906-9911-c877d513e00a", + ], + "is_fan_running" => false, + "has_direct_power" => true, + "relative_humidity" => 0.46, + "temperature_celsius" => 24.64, + "temperature_fahrenheit" => 76.352, + "current_climate_setting" => [ + "hvac_mode_setting" => "heat_cool", + "manual_override_allowed" => true, + "cooling_set_point_celsius" => 21.5, + "heating_set_point_celsius" => 20, + "cooling_set_point_fahrenheit" => 70.7, + "heating_set_point_fahrenheit" => 68, + ], + "available_hvac_mode_settings" => [ + "heat", + "cool", + "heat_cool", + "off", + ], + "is_temporary_manual_override_active" => false, + "name" => "", + "appearance" => ["name" => ""], + "model" => [ + "display_name" => "Thermostat", + "manufacturer_display_name" => "Nest", + "accessory_keypad_supported" => false, + ], + "image_url" => + "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text" => "Placeholder Lock Image", + "is_climate_setting_schedule_active" => false, + ], + "location" => null, + "connected_account_id" => "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-02-29T21:57:33.397Z", + "errors" => [], + "warnings" => [], + "is_managed" => true, + "custom_metadata" => [], + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities list-accessible-devices --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" +``` + +#### Output + +```seam_cli +[ + { + "device_id": "054765c8-a2fc-4599-b486-14c19f462c45", + "nickname": "", + "display_name": "Seam Thermostat", + "device_type": "nest_thermostat", + "capabilities_supported": ["thermostat"], + "properties": { + "online": true, + "is_cooling": false, + "is_heating": false, + "manufacturer": "nest", + "nest_metadata": { + "custom_name": "", + "device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", + "nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a" + }, + "is_fan_running": false, + "has_direct_power": true, + "relative_humidity": 0.46, + "temperature_celsius": 24.64, + "temperature_fahrenheit": 76.352, + "current_climate_setting": { + "hvac_mode_setting": "heat_cool", + "manual_override_allowed": true, + "cooling_set_point_celsius": 21.5, + "heating_set_point_celsius": 20, + "cooling_set_point_fahrenheit": 70.7, + "heating_set_point_fahrenheit": 68 + }, + "available_hvac_mode_settings": ["heat", "cool", "heat_cool", "off"], + "is_temporary_manual_override_active": false, + "name": "", + "appearance": { "name": "" }, + "model": { + "display_name": "Thermostat", + "manufacturer_display_name": "Nest", + "accessory_keypad_supported": false + }, + "image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png", + "image_alt_text": "Placeholder Lock Image", + "is_climate_setting_schedule_active": false + }, + "location": null, + "connected_account_id": "44284499-a50b-4947-86c1-58264f014be5", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-02-29T21:57:33.397Z", + "errors": [], + "warnings": [], + "is_managed": true, + "custom_metadata": {} + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.ListAccessibleDevices( + context.Background(), + api.UserIdentitiesListAccessibleDevicesRequest{ + UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), + }, + ) +} +``` + +#### Output + +```go +[]api.Device{api.Device{DeviceId: "054765c8-a2fc-4599-b486-14c19f462c45", Nickname: "", DisplayName: "Seam Thermostat", DeviceType: "nest_thermostat", CapabilitiesSupported: []string{"thermostat"}, Properties: api.DeviceProperties{Online: true, IsCooling: false, IsHeating: false, Manufacturer: "nest", NestMetadata: api.DevicePropertiesNestMetadata{CustomName: "", DeviceName: "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g", NestDeviceId: "bcca8c5f-1854-4906-9911-c877d513e00a"}, IsFanRunning: false, HasDirectPower: true, RelativeHumidity: 0.46, TemperatureCelsius: 24.64, TemperatureFahrenheit: 76.352, CurrentClimateSetting: api.DevicePropertiesCurrentClimateSetting{HvacModeSetting: "heat_cool", ManualOverrideAllowed: true, CoolingSetPointCelsius: 21.5, HeatingSetPointCelsius: 20, CoolingSetPointFahrenheit: 70.7, HeatingSetPointFahrenheit: 68}, AvailableHvacModeSettings: []string{"heat", "cool", "heat_cool", "off"}, IsTemporaryManualOverrideActive: false, Name: "", Appearance: api.DevicePropertiesAppearance{Name: ""}, Model: api.DevicePropertiesModel{DisplayName: "Thermostat", ManufacturerDisplayName: "Nest", AccessoryKeypadSupported: false}, ImageUrl: "https://connect.getseam.com/assets/images/devices/unknown-lock.png", ImageAltText: "Placeholder Lock Image", IsClimateSettingScheduleActive: false}, Location: nil, ConnectedAccountId: "44284499-a50b-4947-86c1-58264f014be5", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-02-29T21:57:33.397Z", Errors: nil, Warnings: nil, IsManaged: true, CustomMetadata: struct{}{}}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 2be3ab3bb..435ebf8bd 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -29,4 +29,180 @@ ID of the user identity for which you want to retrieve all access control system ## Return Type -Array<[acs\_system](./)> +Array of [acs\_systems](./) + +--- + +## Examples + +### List ACS systems associated with a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.listAcsSystems({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", +}); +``` + +#### Output + +```javascript +[ + { + "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "name": "Assa Abloy Credential Service", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-05T07:16:51.971Z", + "system_type": "assa_abloy_credential_service", + "system_type_display_name": "Assa Abloy Credential Service", + "external_type": "assa_abloy_credential_service", + "external_type_display_name": "Assa Abloy Credential Service", + "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.list_acs_systems( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f" +) +``` + +#### Output + +```python +[ + AcsSystem( + acs_system_id="6737e186-8d54-48ce-a7da-a0be4d252172", + name="Assa Abloy Credential Service", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-05T07:16:51.971Z", + system_type="assa_abloy_credential_service", + system_type_display_name="Assa Abloy Credential Service", + external_type="assa_abloy_credential_service", + external_type_display_name="Assa Abloy Credential Service", + connected_account_ids=["dc08066f-d9b8-42f0-9c4b-c781cd900153"], + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.list_acs_systems(user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f") +``` + +#### Output + +```ruby +[ + { + "acs_system_id" => "6737e186-8d54-48ce-a7da-a0be4d252172", + "name" => "Assa Abloy Credential Service", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-05T07:16:51.971Z", + "system_type" => "assa_abloy_credential_service", + "system_type_display_name" => "Assa Abloy Credential Service", + "external_type" => "assa_abloy_credential_service", + "external_type_display_name" => "Assa Abloy Credential Service", + "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->list_acs_systems( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +); +``` + +#### Output + +```php + "6737e186-8d54-48ce-a7da-a0be4d252172", + "name" => "Assa Abloy Credential Service", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-05T07:16:51.971Z", + "system_type" => "assa_abloy_credential_service", + "system_type_display_name" => "Assa Abloy Credential Service", + "external_type" => "assa_abloy_credential_service", + "external_type_display_name" => "Assa Abloy Credential Service", + "connected_account_ids" => ["dc08066f-d9b8-42f0-9c4b-c781cd900153"], + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities list-acs-systems --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" +``` + +#### Output + +```seam_cli +[ + { + "acs_system_id": "6737e186-8d54-48ce-a7da-a0be4d252172", + "name": "Assa Abloy Credential Service", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-05T07:16:51.971Z", + "system_type": "assa_abloy_credential_service", + "system_type_display_name": "Assa Abloy Credential Service", + "external_type": "assa_abloy_credential_service", + "external_type_display_name": "Assa Abloy Credential Service", + "connected_account_ids": ["dc08066f-d9b8-42f0-9c4b-c781cd900153"] + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.ListAcsSystems( + context.Background(), + api.UserIdentitiesListAcsSystemsRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsSystem{api.AcsSystem{AcsSystemId: "6737e186-8d54-48ce-a7da-a0be4d252172", Name: "Assa Abloy Credential Service", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-05T07:16:51.971Z", SystemType: "assa_abloy_credential_service", SystemTypeDisplayName: "Assa Abloy Credential Service", ExternalType: "assa_abloy_credential_service", ExternalTypeDisplayName: "Assa Abloy Credential Service", ConnectedAccountIds: []string{"dc08066f-d9b8-42f0-9c4b-c781cd900153"}}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index ccf08a2e1..97d502d5f 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -28,4 +28,190 @@ ID of the user identity for which you want to retrieve all ACS users. ## Return Type -Array<[acs\_user](./)> +Array of [acs\_users](./) + +--- + +## Examples + +### List ACS users for a user identity + +Specify the desired `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.listAcsUsers({ + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", +}); +``` + +#### Output + +```javascript +[ + { + "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "email_address": "jean@example.com", + "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-11T05:45:41.349Z", + "is_suspended": false, + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address": "jean@example.com", + "user_identity_phone_number": "+15555550110" + } +] +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.list_acs_users( + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +) +``` + +#### Output + +```python +[ + AcsUser( + acs_user_id="4d223973-0874-4831-8630-bfcb29e6bce0", + display_name="Jean Doe", + full_name="Jean Doe", + email_address="jean@example.com", + acs_system_id="8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be", + created_at="2024-01-11T05:45:41.349Z", + is_suspended=false, + user_identity_id="48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + user_identity_email_address="jean@example.com", + user_identity_phone_number="+15555550110", + ) +] +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.list_acs_users(user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a") +``` + +#### Output + +```ruby +[ + { + "acs_user_id" => "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "email_address" => "jean@example.com", + "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-11T05:45:41.349Z", + "is_suspended" => false, + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address" => "jean@example.com", + "user_identity_phone_number" => "+15555550110", + }, +] +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->list_acs_users( + user_identity_id: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +); +``` + +#### Output + +```php + "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name" => "Jean Doe", + "full_name" => "Jean Doe", + "email_address" => "jean@example.com", + "acs_system_id" => "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id" => "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at" => "2024-01-11T05:45:41.349Z", + "is_suspended" => false, + "user_identity_id" => "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address" => "jean@example.com", + "user_identity_phone_number" => "+15555550110", + ], +]; +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities list-acs-users --user_identity_id "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a" +``` + +#### Output + +```seam_cli +[ + { + "acs_user_id": "4d223973-0874-4831-8630-bfcb29e6bce0", + "display_name": "Jean Doe", + "full_name": "Jean Doe", + "email_address": "jean@example.com", + "acs_system_id": "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", + "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be", + "created_at": "2024-01-11T05:45:41.349Z", + "is_suspended": false, + "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", + "user_identity_email_address": "jean@example.com", + "user_identity_phone_number": "+15555550110" + } +] +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.ListAcsUsers( + context.Background(), + api.UserIdentitiesListAcsUsersRequest{ + UserIdentityId: api.String("48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"), + }, + ) +} +``` + +#### Output + +```go +[]api.AcsUser{api.AcsUser{AcsUserId: "4d223973-0874-4831-8630-bfcb29e6bce0", DisplayName: "Jean Doe", FullName: "Jean Doe", EmailAddress: "jean@example.com", AcsSystemId: "8aaa5fa0-9381-4463-a0ed-85f9c1fbcef4", WorkspaceId: "398d80b7-3f96-47c2-b85a-6f8ba21d07be", CreatedAt: "2024-01-11T05:45:41.349Z", IsSuspended: false, UserIdentityId: "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a", UserIdentityEmailAddress: "jean@example.com", UserIdentityPhoneNumber: "+15555550110"}} +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e01936615..aa8c58f99 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -35,3 +35,125 @@ ID of the desired user identity. ## Return Type void + +--- + +## Examples + +### Remove an ACS user from a user identity + +Specify the desired `acs_user_id` and `user_identity_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.removeAcsUser({ + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.remove_acs_user( + user_identity_id="5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id="c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.remove_acs_user( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->remove_acs_user( + user_identity_id: "5c945ab5-c75e-4bcb-8e5f-9410061c401f", + acs_user_id: "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities remove-acs-user --user_identity_id "5c945ab5-c75e-4bcb-8e5f-9410061c401f" --acs_user_id "c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.RemoveAcsUser( + context.Background(), + api.UserIdentitiesRemoveAcsUserRequest{ + UserIdentityId: api.String("5c945ab5-c75e-4bcb-8e5f-9410061c401f"), + AcsUserId: api.String("c0184e54-0d93-4bca-8a4e-47bbd2ee3bfe"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 57c64fb4a..1dbf79762 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -35,3 +35,125 @@ ID of the desired user identity. ## Return Type void + +--- + +## Examples + +### Revoke access to a device from a user identity + +Specify the desired `user_identity_id` and `device_id`. + +{% tabs %} +{% tab title="JavaScript" %} +#### Code + +```javascript +await seam.userIdentities.revokeAccessToDevice({ + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +}); +``` + +#### Output + +```javascript +// void +``` +{% endtab %} + +{% tab title="Python" %} +#### Code + +```python +seam.user_identities.revoke_access_to_device( + user_identity_id="f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id="054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Output + +```python +None +``` +{% endtab %} + +{% tab title="Ruby" %} +#### Code + +```ruby +seam.user_identities.revoke_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45", +) +``` + +#### Output + +```ruby +nil +``` +{% endtab %} + +{% tab title="PHP" %} +#### Code + +```php +user_identities->revoke_access_to_device( + user_identity_id: "f3a328b4-dd04-4370-9000-d52b7a01b0bf", + device_id: "054765c8-a2fc-4599-b486-14c19f462c45" +); +``` + +#### Output + +```php +null +``` +{% endtab %} + +{% tab title="Seam CLI" %} +#### Code + +```seam_cli +seam user-identities revoke-access-to-device --user_identity_id "f3a328b4-dd04-4370-9000-d52b7a01b0bf" --device_id "054765c8-a2fc-4599-b486-14c19f462c45" +``` + +#### Output + +```seam_cli +{} +``` +{% endtab %} + +{% tab title="Go" %} +#### Code + +```go +package main + +import api "github.com/seamapi/go" + +func main() { + client.UserIdentities.RevokeAccessToDevice( + context.Background(), + api.UserIdentitiesRevokeAccessToDeviceRequest{ + UserIdentityId: api.String("f3a328b4-dd04-4370-9000-d52b7a01b0bf"), + DeviceId: api.String("054765c8-a2fc-4599-b486-14c19f462c45"), + }, + ) +} +``` + +#### Output + +```go +nil +``` +{% endtab %} + +{% endtabs %} + + From a2f2c4cecdf8d309526778795b7f7b91fad2617e Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 22:18:37 -0400 Subject: [PATCH 169/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index b77aabcb3..9b8911919 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -55,6 +55,14 @@ None {{> api-resource headingOffset=true}} {{/with}} +{{#if response.resourceType}} +{{#unless response.actionAttempt}} +{{#with response}} + +{{> api-resource headingOffset=true}} +{{/with}} +{{/unless}} +{{/if}} {{#if primaryCodeSample}} --- From 9638de99a8c96a48d4d720df7b6071e5bec1777d Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 02:19:42 +0000 Subject: [PATCH 170/233] ci: Generate docs --- docs/api/acs/access_groups/get.md | 18 ++++++++++++++++++ docs/api/acs/access_groups/list.md | 18 ++++++++++++++++++ .../access_groups/list_accessible_entrances.md | 18 ++++++++++++++++++ docs/api/acs/access_groups/list_users.md | 18 ++++++++++++++++++ docs/api/acs/credentials/create.md | 18 ++++++++++++++++++ docs/api/acs/credentials/get.md | 18 ++++++++++++++++++ docs/api/acs/credentials/list.md | 18 ++++++++++++++++++ .../credentials/list_accessible_entrances.md | 18 ++++++++++++++++++ docs/api/acs/encoders/list.md | 18 ++++++++++++++++++ docs/api/acs/entrances/get.md | 18 ++++++++++++++++++ docs/api/acs/entrances/list.md | 18 ++++++++++++++++++ .../entrances/list_credentials_with_access.md | 18 ++++++++++++++++++ docs/api/acs/systems/get.md | 18 ++++++++++++++++++ docs/api/acs/systems/list.md | 18 ++++++++++++++++++ ...ompatible_credential_manager_acs_systems.md | 18 ++++++++++++++++++ docs/api/acs/users/create.md | 18 ++++++++++++++++++ docs/api/acs/users/get.md | 18 ++++++++++++++++++ docs/api/acs/users/list.md | 18 ++++++++++++++++++ .../api/acs/users/list_accessible_entrances.md | 18 ++++++++++++++++++ docs/api/phones/get.md | 18 ++++++++++++++++++ docs/api/phones/list.md | 18 ++++++++++++++++++ .../phones/simulate/create_sandbox_phone.md | 18 ++++++++++++++++++ docs/api/thermostats/list.md | 18 ++++++++++++++++++ docs/api/thermostats/schedules/create.md | 18 ++++++++++++++++++ docs/api/thermostats/schedules/get.md | 18 ++++++++++++++++++ docs/api/thermostats/schedules/list.md | 18 ++++++++++++++++++ docs/api/user_identities/create.md | 18 ++++++++++++++++++ .../enrollment_automations/get.md | 18 ++++++++++++++++++ .../enrollment_automations/launch.md | 18 ++++++++++++++++++ .../enrollment_automations/list.md | 18 ++++++++++++++++++ docs/api/user_identities/get.md | 18 ++++++++++++++++++ docs/api/user_identities/list.md | 18 ++++++++++++++++++ .../user_identities/list_accessible_devices.md | 18 ++++++++++++++++++ docs/api/user_identities/list_acs_systems.md | 18 ++++++++++++++++++ docs/api/user_identities/list_acs_users.md | 18 ++++++++++++++++++ 35 files changed, 630 insertions(+) diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 5088e0be0..5518e6647 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -30,6 +30,24 @@ ID of the desired access group. [acs\_access\_group](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 03db7347e..bfe0274b4 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -36,6 +36,24 @@ ID of the user for which you want to retrieve all access groups. Array of [acs\_access\_groups](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 7c96a6138..a22064f50 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -30,6 +30,24 @@ ID of the access group for which you want to retrieve all accessible entrances. Array of [acs\_entrances](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index b828c3fff..d486bb7ea 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -30,6 +30,24 @@ ID of the access group for which you want to retrieve all users. Array of [acs\_users](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 12390ac88..161d0d5fe 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -90,6 +90,24 @@ Visionline-specific metadata for the new credential. [acs\_credential](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index b06bc6db5..68770fa73 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -30,6 +30,24 @@ ID of the desired credential. [acs\_credential](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 44c2a1b95..204ea40b4 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -61,6 +61,24 @@ ID of the user identity for which you want to retrieve all credentials. Array of [acs\_credentials](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index e8da9105b..475fa9ef3 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -30,6 +30,24 @@ ID of the credential for which you want to retrieve all entrances to which this Array of [acs\_entrances](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 791005e9a..91c3187e4 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -47,3 +47,21 @@ Number of `acs_encoders` to return. ## Return Type Array of [acs\_encoders](./) + +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index e8049fe0d..f9e666d5c 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -27,6 +27,24 @@ POST /acs/entrances/get ⇒ { acs_entrance } [acs\_entrance](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 171028c70..26bff9134 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -33,6 +33,24 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } Array of [acs\_entrances](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 915c84fde..62c6882b3 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -40,6 +40,24 @@ Possible enum values: Array of [acs\_credentials](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 0ec9b88fb..db49d68ff 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -32,6 +32,24 @@ ID of the desired access control system. [acs\_system](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 63f0bac00..ca618d1e6 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -33,6 +33,24 @@ ID of the connected account by which to filter the list of returned access contr Array of [acs\_systems](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index b9e7f084c..3d52bcd30 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -34,6 +34,24 @@ ID of the ACS system for which you want to retrieve all compatible credential ma Array of [acs\_systems](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 408731fdc..880c9b465 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -70,6 +70,24 @@ ID of the user identity with which to associate the new `acs_user`. [acs\_user](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 7021de14f..b7ec075f2 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -30,6 +30,24 @@ ID of the desired `acs_user`. [acs\_user](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 542612c25..200c41fec 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -71,6 +71,24 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s Array of [acs\_users](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 269c052e9..487d02311 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -30,3 +30,21 @@ ID of the desired `acs_user`. ## Return Type Array of [acs\_entrances](./) + +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 90dfb5042..dabd3eadd 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -29,3 +29,21 @@ Device ID of the desired phone. ## Return Type [phone](./) + +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 61becf943..81d369a83 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,3 +35,21 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type Array of [phones](./) + +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 37ca38ef1..cdf683870 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -47,3 +47,21 @@ Metadata to associate with the simulated phone. ## Return Type [phone](./) + +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 3d83e5792..6db44df86 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -132,6 +132,24 @@ Your own internal user ID for the user by which to filter devices. Array of [devices](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 8b254e6e8..0ef55dadd 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -67,6 +67,24 @@ User-friendly name to identify the thermostat schedule. [thermostat\_schedule](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 4bfb5baf3..d784e7821 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -31,6 +31,24 @@ ID of the desired thermostat schedule. [thermostat\_schedule](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 7b1e4c7b5..3d47875ed 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -37,6 +37,24 @@ User identifier key by which to filter the list of returned thermostat schedules Array of [thermostat\_schedules](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 8a5dd62e4..b875e277e 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -48,6 +48,24 @@ Unique key for the user identity. [user\_identity](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index f8a63e33a..cde0efbd1 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -31,6 +31,24 @@ ID of the desired enrollment automation. [enrollment\_automation](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 9ba663a51..6493a5000 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -54,6 +54,24 @@ ID of the associated ACS user within the credential manager. If you specify a `c [unknown](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 21d7dd4bf..69313dbf3 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -31,6 +31,24 @@ ID of the user identity for which you want to retrieve all enrollment automation Array of [enrollment\_automations](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 0e65eb402..f740efe5e 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -34,6 +34,24 @@ ID of the desired user identity. [user\_identity](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 05c21380e..18cd7462e 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -29,6 +29,24 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } Array of [user\_identitys](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index bd9d3022f..06a04c717 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -30,6 +30,24 @@ ID of the user identity for which you want to retrieve all accessible devices. Array of [devices](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 435ebf8bd..11a7ae729 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -31,6 +31,24 @@ ID of the user identity for which you want to retrieve all access control system Array of [acs\_systems](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 97d502d5f..5754e8838 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -30,6 +30,24 @@ ID of the user identity for which you want to retrieve all ACS users. Array of [acs\_users](./) +### The `` Resource + +OK + +{% tabs %} +{% tab title="JSON" %} +```json +{ +} +``` +{% endtab %} +{% endtabs %} + +--- + +### Properties + + --- ## Examples From 948b541417eb51678bd5c254f780779309c75300 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 22:22:08 -0400 Subject: [PATCH 171/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 9b8911919..3d73b1320 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -57,10 +57,7 @@ None {{/with}} {{#if response.resourceType}} {{#unless response.actionAttempt}} -{{#with response}} - -{{> api-resource headingOffset=true}} -{{/with}} +{{response}} {{/unless}} {{/if}} {{#if primaryCodeSample}} From 7cf333506fda74ebe6e51775b186d7904b4f8973 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 02:23:30 +0000 Subject: [PATCH 172/233] ci: Generate docs --- docs/api/acs/access_groups/get.md | 19 +------------------ docs/api/acs/access_groups/list.md | 19 +------------------ .../list_accessible_entrances.md | 19 +------------------ docs/api/acs/access_groups/list_users.md | 19 +------------------ docs/api/acs/credentials/create.md | 19 +------------------ docs/api/acs/credentials/get.md | 19 +------------------ docs/api/acs/credentials/list.md | 19 +------------------ .../credentials/list_accessible_entrances.md | 19 +------------------ docs/api/acs/encoders/list.md | 19 +------------------ docs/api/acs/entrances/get.md | 19 +------------------ docs/api/acs/entrances/list.md | 19 +------------------ .../entrances/list_credentials_with_access.md | 19 +------------------ docs/api/acs/systems/get.md | 19 +------------------ docs/api/acs/systems/list.md | 19 +------------------ ...mpatible_credential_manager_acs_systems.md | 19 +------------------ docs/api/acs/users/create.md | 19 +------------------ docs/api/acs/users/get.md | 19 +------------------ docs/api/acs/users/list.md | 19 +------------------ .../acs/users/list_accessible_entrances.md | 19 +------------------ docs/api/phones/get.md | 19 +------------------ docs/api/phones/list.md | 19 +------------------ .../phones/simulate/create_sandbox_phone.md | 19 +------------------ docs/api/thermostats/list.md | 19 +------------------ docs/api/thermostats/schedules/create.md | 19 +------------------ docs/api/thermostats/schedules/get.md | 19 +------------------ docs/api/thermostats/schedules/list.md | 19 +------------------ docs/api/user_identities/create.md | 19 +------------------ .../enrollment_automations/get.md | 19 +------------------ .../enrollment_automations/launch.md | 19 +------------------ .../enrollment_automations/list.md | 19 +------------------ docs/api/user_identities/get.md | 19 +------------------ docs/api/user_identities/list.md | 19 +------------------ .../list_accessible_devices.md | 19 +------------------ docs/api/user_identities/list_acs_systems.md | 19 +------------------ docs/api/user_identities/list_acs_users.md | 19 +------------------ 35 files changed, 35 insertions(+), 630 deletions(-) diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 5518e6647..36678abb4 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -29,24 +29,7 @@ ID of the desired access group. ## Return Type [acs\_access\_group](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index bfe0274b4..220f75c8d 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -35,24 +35,7 @@ ID of the user for which you want to retrieve all access groups. ## Return Type Array of [acs\_access\_groups](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index a22064f50..549303bd9 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -29,24 +29,7 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Return Type Array of [acs\_entrances](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index d486bb7ea..fe6398ed6 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -29,24 +29,7 @@ ID of the access group for which you want to retrieve all users. ## Return Type Array of [acs\_users](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 161d0d5fe..a06fbc8cb 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -89,24 +89,7 @@ Visionline-specific metadata for the new credential. ## Return Type [acs\_credential](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 68770fa73..c21717714 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -29,24 +29,7 @@ ID of the desired credential. ## Return Type [acs\_credential](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 204ea40b4..71d8b6103 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -60,24 +60,7 @@ ID of the user identity for which you want to retrieve all credentials. ## Return Type Array of [acs\_credentials](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 475fa9ef3..8d0d3706e 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -29,24 +29,7 @@ ID of the credential for which you want to retrieve all entrances to which this ## Return Type Array of [acs\_entrances](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 91c3187e4..be519b8bc 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -47,21 +47,4 @@ Number of `acs_encoders` to return. ## Return Type Array of [acs\_encoders](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index f9e666d5c..a937ee436 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -26,24 +26,7 @@ POST /acs/entrances/get ⇒ { acs_entrance } ## Return Type [acs\_entrance](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 26bff9134..2ef83b7a8 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -32,24 +32,7 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ## Return Type Array of [acs\_entrances](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 62c6882b3..835f196a9 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -39,24 +39,7 @@ Possible enum values: ## Return Type Array of [acs\_credentials](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index db49d68ff..83a07ab35 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -31,24 +31,7 @@ ID of the desired access control system. ## Return Type [acs\_system](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index ca618d1e6..48ae389ba 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -32,24 +32,7 @@ ID of the connected account by which to filter the list of returned access contr ## Return Type Array of [acs\_systems](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 3d52bcd30..977271c10 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -33,24 +33,7 @@ ID of the ACS system for which you want to retrieve all compatible credential ma ## Return Type Array of [acs\_systems](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 880c9b465..88a6d4af1 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -69,24 +69,7 @@ ID of the user identity with which to associate the new `acs_user`. ## Return Type [acs\_user](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index b7ec075f2..e207159ad 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -29,24 +29,7 @@ ID of the desired `acs_user`. ## Return Type [acs\_user](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 200c41fec..a11af3918 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -70,24 +70,7 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s ## Return Type Array of [acs\_users](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 487d02311..fd578910f 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -30,21 +30,4 @@ ID of the desired `acs_user`. ## Return Type Array of [acs\_entrances](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index dabd3eadd..0fe9e3be8 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -29,21 +29,4 @@ Device ID of the desired phone. ## Return Type [phone](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 81d369a83..f9c4914fa 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,21 +35,4 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type Array of [phones](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index cdf683870..612e545d3 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -47,21 +47,4 @@ Metadata to associate with the simulated phone. ## Return Type [phone](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 6db44df86..55802b0a2 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -131,24 +131,7 @@ Your own internal user ID for the user by which to filter devices. ## Return Type Array of [devices](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 0ef55dadd..c7fba379c 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -66,24 +66,7 @@ User-friendly name to identify the thermostat schedule. ## Return Type [thermostat\_schedule](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index d784e7821..3e839e023 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -30,24 +30,7 @@ ID of the desired thermostat schedule. ## Return Type [thermostat\_schedule](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 3d47875ed..f1ad6ff2a 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -36,24 +36,7 @@ User identifier key by which to filter the list of returned thermostat schedules ## Return Type Array of [thermostat\_schedules](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index b875e277e..1c3c0fd1d 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -47,24 +47,7 @@ Unique key for the user identity. ## Return Type [user\_identity](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index cde0efbd1..ee39f18f5 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -30,24 +30,7 @@ ID of the desired enrollment automation. ## Return Type [enrollment\_automation](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 6493a5000..6f4e9fc0f 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -53,24 +53,7 @@ ID of the associated ACS user within the credential manager. If you specify a `c ## Return Type [unknown](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 69313dbf3..025728836 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -30,24 +30,7 @@ ID of the user identity for which you want to retrieve all enrollment automation ## Return Type Array of [enrollment\_automations](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index f740efe5e..4719bc46f 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -33,24 +33,7 @@ ID of the desired user identity. ## Return Type [user\_identity](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 18cd7462e..3c49d5e6e 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -28,24 +28,7 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ## Return Type Array of [user\_identitys](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 06a04c717..1b58d7138 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -29,24 +29,7 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Return Type Array of [devices](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 11a7ae729..7a41f3e5b 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -30,24 +30,7 @@ ID of the user identity for which you want to retrieve all access control system ## Return Type Array of [acs\_systems](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 5754e8838..bc66aa668 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -29,24 +29,7 @@ ID of the user identity for which you want to retrieve all ACS users. ## Return Type Array of [acs\_users](./) - -### The `` Resource - -OK - -{% tabs %} -{% tab title="JSON" %} -```json -{ -} -``` -{% endtab %} -{% endtabs %} - ---- - -### Properties - +[object Object] --- From 5ae4bb5c7cc94c8dd086d57fd97f409de44937dd Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 22:25:55 -0400 Subject: [PATCH 173/233] Create api-response-resource --- src/layouts/partials/api-response-resource | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 src/layouts/partials/api-response-resource diff --git a/src/layouts/partials/api-response-resource b/src/layouts/partials/api-response-resource new file mode 100644 index 000000000..05d1a512d --- /dev/null +++ b/src/layouts/partials/api-response-resource @@ -0,0 +1,15 @@ +{% tabs %} +{% tab title="JSON" %} +```json +{ +{{#each properties}} +{{#if @last}} + {{name}}: [example value] +{{else}} + {{name}}: [example value], +{{/if}} +{{/each}} +} +``` +{% endtab %} +{% endtabs %} From 8504bb7acb5b529f34d6444273995e8d3df04598 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 22:26:19 -0400 Subject: [PATCH 174/233] Rename api-response-resource to api-response-resource.hbs --- .../partials/{api-response-resource => api-response-resource.hbs} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename src/layouts/partials/{api-response-resource => api-response-resource.hbs} (100%) diff --git a/src/layouts/partials/api-response-resource b/src/layouts/partials/api-response-resource.hbs similarity index 100% rename from src/layouts/partials/api-response-resource rename to src/layouts/partials/api-response-resource.hbs From 884f12b73fe71530acbcce812c8a9bada39f3092 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 22:30:01 -0400 Subject: [PATCH 175/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 3d73b1320..f6086a097 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -53,7 +53,7 @@ None {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s](./){{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} {{#with response.actionAttempt}} -{{> api-resource headingOffset=true}} +{{> api-response-resource headingOffset=true}} {{/with}} {{#if response.resourceType}} {{#unless response.actionAttempt}} From d836f90b6d881fb70f50753d2c57f063f0c69f96 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 02:31:08 +0000 Subject: [PATCH 176/233] ci: Generate docs --- docs/api/acs/encoders/encode_credential.md | 37 ------------------- docs/api/acs/encoders/scan_credential.md | 35 ------------------ .../thermostats/activate_climate_preset.md | 35 ------------------ docs/api/thermostats/cool.md | 35 ------------------ docs/api/thermostats/heat.md | 35 ------------------ docs/api/thermostats/heat_cool.md | 35 ------------------ docs/api/thermostats/off.md | 35 ------------------ docs/api/thermostats/set_fan_mode.md | 35 ------------------ docs/api/thermostats/set_hvac_mode.md | 35 ------------------ 9 files changed, 317 deletions(-) diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index e622fa6c8..1900d8d89 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -36,10 +36,6 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. [action\_attempt](./) -### The `ENCODE_CREDENTIAL` Resource - -Action attempt to track encoding credential data from the physical encoder onto a card. - {% tabs %} {% tab title="JSON" %} ```json @@ -51,36 +47,3 @@ Action attempt to track encoding credential data from the physical encoder onto ``` {% endtab %} {% endtabs %} - ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - -Type of action that the action attempt tracks. - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index c3313243b..9e37a93fe 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -30,10 +30,6 @@ ID of the `acs_encoder` to use for the scan. [action\_attempt](./) -### The `SCAN_CREDENTIAL` Resource - -Reading credential data from physical encoder. - {% tabs %} {% tab title="JSON" %} ```json @@ -45,34 +41,3 @@ Reading credential data from physical encoder. ``` {% endtab %} {% endtabs %} - ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 79b3de12c..d0342862f 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -36,10 +36,6 @@ ID of the desired thermostat device. [action\_attempt](./) -### The `ACTIVATE_CLIMATE_PRESET` Resource - -Activating climate preset. - {% tabs %} {% tab title="JSON" %} ```json @@ -52,37 +48,6 @@ Activating climate preset. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 20a80d7f6..c0dac5512 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -43,10 +43,6 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - {% tabs %} {% tab title="JSON" %} ```json @@ -59,37 +55,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 423098267..b9bcc3773 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -43,10 +43,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - {% tabs %} {% tab title="JSON" %} ```json @@ -59,37 +55,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 95558f734..c5d591d88 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -55,10 +55,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - {% tabs %} {% tab title="JSON" %} ```json @@ -71,37 +67,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 2b7473084..3a80a2a36 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -31,10 +31,6 @@ ID of the desired thermostat device. [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - {% tabs %} {% tab title="JSON" %} ```json @@ -47,37 +43,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 3432f47c7..77e8d850a 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -39,10 +39,6 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos [action\_attempt](./) -### The `SET_FAN_MODE` Resource - -Setting fan mode. - {% tabs %} {% tab title="JSON" %} ```json @@ -55,37 +51,6 @@ Setting fan mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 5a5296af9..82054d845 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -59,10 +59,6 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - {% tabs %} {% tab title="JSON" %} ```json @@ -75,37 +71,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples From 87077752b0dee77218f21d75eaaddcadff42e9d3 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 22:44:43 -0400 Subject: [PATCH 177/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index f6086a097..e8fcf41be 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -53,11 +53,11 @@ None {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s](./){{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} {{#with response.actionAttempt}} -{{> api-response-resource headingOffset=true}} +{{> api-resource headingOffset=true}} {{/with}} {{#if response.resourceType}} {{#unless response.actionAttempt}} -{{response}} +{{response.responseKey}} {{/unless}} {{/if}} {{#if primaryCodeSample}} From f362c562de0a86642e24c3f99c5c848023537e88 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 02:45:49 +0000 Subject: [PATCH 178/233] ci: Generate docs --- docs/api/acs/access_groups/get.md | 2 +- docs/api/acs/access_groups/list.md | 2 +- .../list_accessible_entrances.md | 2 +- docs/api/acs/access_groups/list_users.md | 2 +- docs/api/acs/credentials/create.md | 2 +- docs/api/acs/credentials/get.md | 2 +- docs/api/acs/credentials/list.md | 2 +- .../credentials/list_accessible_entrances.md | 2 +- docs/api/acs/encoders/encode_credential.md | 37 +++++++++++++++++++ docs/api/acs/encoders/list.md | 2 +- docs/api/acs/encoders/scan_credential.md | 35 ++++++++++++++++++ docs/api/acs/entrances/get.md | 2 +- docs/api/acs/entrances/list.md | 2 +- .../entrances/list_credentials_with_access.md | 2 +- docs/api/acs/systems/get.md | 2 +- docs/api/acs/systems/list.md | 2 +- ...mpatible_credential_manager_acs_systems.md | 2 +- docs/api/acs/users/create.md | 2 +- docs/api/acs/users/get.md | 2 +- docs/api/acs/users/list.md | 2 +- .../acs/users/list_accessible_entrances.md | 2 +- docs/api/phones/get.md | 2 +- docs/api/phones/list.md | 2 +- .../phones/simulate/create_sandbox_phone.md | 2 +- .../thermostats/activate_climate_preset.md | 35 ++++++++++++++++++ docs/api/thermostats/cool.md | 35 ++++++++++++++++++ docs/api/thermostats/heat.md | 35 ++++++++++++++++++ docs/api/thermostats/heat_cool.md | 35 ++++++++++++++++++ docs/api/thermostats/list.md | 2 +- docs/api/thermostats/off.md | 35 ++++++++++++++++++ docs/api/thermostats/schedules/create.md | 2 +- docs/api/thermostats/schedules/get.md | 2 +- docs/api/thermostats/schedules/list.md | 2 +- docs/api/thermostats/set_fan_mode.md | 35 ++++++++++++++++++ docs/api/thermostats/set_hvac_mode.md | 35 ++++++++++++++++++ docs/api/user_identities/create.md | 2 +- .../enrollment_automations/get.md | 2 +- .../enrollment_automations/launch.md | 2 +- .../enrollment_automations/list.md | 2 +- docs/api/user_identities/get.md | 2 +- docs/api/user_identities/list.md | 2 +- .../list_accessible_devices.md | 2 +- docs/api/user_identities/list_acs_systems.md | 2 +- docs/api/user_identities/list_acs_users.md | 2 +- 44 files changed, 352 insertions(+), 35 deletions(-) diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 36678abb4..d2f7b8d56 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -29,7 +29,7 @@ ID of the desired access group. ## Return Type [acs\_access\_group](./) -[object Object] +acs_access_group --- diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 220f75c8d..c244d9c16 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -35,7 +35,7 @@ ID of the user for which you want to retrieve all access groups. ## Return Type Array of [acs\_access\_groups](./) -[object Object] +acs_access_groups --- diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 549303bd9..b3046915c 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -29,7 +29,7 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Return Type Array of [acs\_entrances](./) -[object Object] +acs_entrances --- diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index fe6398ed6..c20d1aa10 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -29,7 +29,7 @@ ID of the access group for which you want to retrieve all users. ## Return Type Array of [acs\_users](./) -[object Object] +acs_users --- diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index a06fbc8cb..461fd348e 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -89,7 +89,7 @@ Visionline-specific metadata for the new credential. ## Return Type [acs\_credential](./) -[object Object] +acs_credential --- diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index c21717714..142f0c6c1 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -29,7 +29,7 @@ ID of the desired credential. ## Return Type [acs\_credential](./) -[object Object] +acs_credential --- diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 71d8b6103..ced0189c1 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -60,7 +60,7 @@ ID of the user identity for which you want to retrieve all credentials. ## Return Type Array of [acs\_credentials](./) -[object Object] +acs_credentials --- diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 8d0d3706e..3c6e5bbb2 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -29,7 +29,7 @@ ID of the credential for which you want to retrieve all entrances to which this ## Return Type Array of [acs\_entrances](./) -[object Object] +acs_entrances --- diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 1900d8d89..e622fa6c8 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -36,6 +36,10 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. [action\_attempt](./) +### The `ENCODE_CREDENTIAL` Resource + +Action attempt to track encoding credential data from the physical encoder onto a card. + {% tabs %} {% tab title="JSON" %} ```json @@ -47,3 +51,36 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. ``` {% endtab %} {% endtabs %} + +--- + +### Properties + +**`action_attempt_id`** *UUID* + +ID of the action attempt. + + +--- + +**`action_type`** *String* + +Type of action that the action attempt tracks. + + +--- + +**`status`** *Enum* + +
+ +Enum values + +- `success` +- `pending` +- `error` +
+ + +--- + diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index be519b8bc..bcb9eeb64 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -47,4 +47,4 @@ Number of `acs_encoders` to return. ## Return Type Array of [acs\_encoders](./) -[object Object] +acs_encoders diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 9e37a93fe..c3313243b 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -30,6 +30,10 @@ ID of the `acs_encoder` to use for the scan. [action\_attempt](./) +### The `SCAN_CREDENTIAL` Resource + +Reading credential data from physical encoder. + {% tabs %} {% tab title="JSON" %} ```json @@ -41,3 +45,34 @@ ID of the `acs_encoder` to use for the scan. ``` {% endtab %} {% endtabs %} + +--- + +### Properties + +**`action_attempt_id`** *UUID* + +ID of the action attempt. + + +--- + +**`action_type`** *String* + + +--- + +**`status`** *Enum* + +
+ +Enum values + +- `success` +- `pending` +- `error` +
+ + +--- + diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index a937ee436..18395581e 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -26,7 +26,7 @@ POST /acs/entrances/get ⇒ { acs_entrance } ## Return Type [acs\_entrance](./) -[object Object] +acs_entrance --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 2ef83b7a8..7f8db4f9a 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -32,7 +32,7 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ## Return Type Array of [acs\_entrances](./) -[object Object] +acs_entrances --- diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 835f196a9..c8da138e1 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -39,7 +39,7 @@ Possible enum values: ## Return Type Array of [acs\_credentials](./) -[object Object] +acs_credentials --- diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 83a07ab35..2244e87cd 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -31,7 +31,7 @@ ID of the desired access control system. ## Return Type [acs\_system](./) -[object Object] +acs_system --- diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 48ae389ba..b21b2bf7d 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -32,7 +32,7 @@ ID of the connected account by which to filter the list of returned access contr ## Return Type Array of [acs\_systems](./) -[object Object] +acs_systems --- diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 977271c10..f25426f53 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -33,7 +33,7 @@ ID of the ACS system for which you want to retrieve all compatible credential ma ## Return Type Array of [acs\_systems](./) -[object Object] +acs_systems --- diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 88a6d4af1..bb7fba2e0 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -69,7 +69,7 @@ ID of the user identity with which to associate the new `acs_user`. ## Return Type [acs\_user](./) -[object Object] +acs_user --- diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index e207159ad..97a49e4ad 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -29,7 +29,7 @@ ID of the desired `acs_user`. ## Return Type [acs\_user](./) -[object Object] +acs_user --- diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index a11af3918..a7dde3de6 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -70,7 +70,7 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s ## Return Type Array of [acs\_users](./) -[object Object] +acs_users --- diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index fd578910f..c899909df 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -30,4 +30,4 @@ ID of the desired `acs_user`. ## Return Type Array of [acs\_entrances](./) -[object Object] +acs_entrances diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 0fe9e3be8..9c6ef95d9 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -29,4 +29,4 @@ Device ID of the desired phone. ## Return Type [phone](./) -[object Object] +phone diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index f9c4914fa..ab272bc56 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,4 +35,4 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type Array of [phones](./) -[object Object] +phones diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 612e545d3..29e7de016 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -47,4 +47,4 @@ Metadata to associate with the simulated phone. ## Return Type [phone](./) -[object Object] +phone diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index d0342862f..79b3de12c 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -36,6 +36,10 @@ ID of the desired thermostat device. [action\_attempt](./) +### The `ACTIVATE_CLIMATE_PRESET` Resource + +Activating climate preset. + {% tabs %} {% tab title="JSON" %} ```json @@ -48,6 +52,37 @@ ID of the desired thermostat device. {% endtab %} {% endtabs %} +--- + +### Properties + +**`action_attempt_id`** *UUID* + +ID of the action attempt. + + +--- + +**`action_type`** *String* + + +--- + +**`status`** *Enum* + +
+ +Enum values + +- `success` +- `pending` +- `error` +
+ + +--- + + --- ## Examples diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index c0dac5512..20a80d7f6 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -43,6 +43,10 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) +### The `SET_HVAC_MODE` Resource + +Setting HVAC mode. + {% tabs %} {% tab title="JSON" %} ```json @@ -55,6 +59,37 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th {% endtab %} {% endtabs %} +--- + +### Properties + +**`action_attempt_id`** *UUID* + +ID of the action attempt. + + +--- + +**`action_type`** *String* + + +--- + +**`status`** *Enum* + +
+ +Enum values + +- `success` +- `pending` +- `error` +
+ + +--- + + --- ## Examples diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index b9bcc3773..423098267 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -43,6 +43,10 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) +### The `SET_HVAC_MODE` Resource + +Setting HVAC mode. + {% tabs %} {% tab title="JSON" %} ```json @@ -55,6 +59,37 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th {% endtab %} {% endtabs %} +--- + +### Properties + +**`action_attempt_id`** *UUID* + +ID of the action attempt. + + +--- + +**`action_type`** *String* + + +--- + +**`status`** *Enum* + +
+ +Enum values + +- `success` +- `pending` +- `error` +
+ + +--- + + --- ## Examples diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index c5d591d88..95558f734 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -55,6 +55,10 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) +### The `SET_HVAC_MODE` Resource + +Setting HVAC mode. + {% tabs %} {% tab title="JSON" %} ```json @@ -67,6 +71,37 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th {% endtab %} {% endtabs %} +--- + +### Properties + +**`action_attempt_id`** *UUID* + +ID of the action attempt. + + +--- + +**`action_type`** *String* + + +--- + +**`status`** *Enum* + +
+ +Enum values + +- `success` +- `pending` +- `error` +
+ + +--- + + --- ## Examples diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 55802b0a2..8b386faba 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -131,7 +131,7 @@ Your own internal user ID for the user by which to filter devices. ## Return Type Array of [devices](./) -[object Object] +devices --- diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 3a80a2a36..2b7473084 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -31,6 +31,10 @@ ID of the desired thermostat device. [action\_attempt](./) +### The `SET_HVAC_MODE` Resource + +Setting HVAC mode. + {% tabs %} {% tab title="JSON" %} ```json @@ -43,6 +47,37 @@ ID of the desired thermostat device. {% endtab %} {% endtabs %} +--- + +### Properties + +**`action_attempt_id`** *UUID* + +ID of the action attempt. + + +--- + +**`action_type`** *String* + + +--- + +**`status`** *Enum* + +
+ +Enum values + +- `success` +- `pending` +- `error` +
+ + +--- + + --- ## Examples diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index c7fba379c..6b46bed82 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -66,7 +66,7 @@ User-friendly name to identify the thermostat schedule. ## Return Type [thermostat\_schedule](./) -[object Object] +thermostat_schedule --- diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 3e839e023..7919abe14 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -30,7 +30,7 @@ ID of the desired thermostat schedule. ## Return Type [thermostat\_schedule](./) -[object Object] +thermostat_schedule --- diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index f1ad6ff2a..5910f447e 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -36,7 +36,7 @@ User identifier key by which to filter the list of returned thermostat schedules ## Return Type Array of [thermostat\_schedules](./) -[object Object] +thermostat_schedules --- diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 77e8d850a..3432f47c7 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -39,6 +39,10 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos [action\_attempt](./) +### The `SET_FAN_MODE` Resource + +Setting fan mode. + {% tabs %} {% tab title="JSON" %} ```json @@ -51,6 +55,37 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos {% endtab %} {% endtabs %} +--- + +### Properties + +**`action_attempt_id`** *UUID* + +ID of the action attempt. + + +--- + +**`action_type`** *String* + + +--- + +**`status`** *Enum* + +
+ +Enum values + +- `success` +- `pending` +- `error` +
+ + +--- + + --- ## Examples diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 82054d845..5a5296af9 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -59,6 +59,10 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) +### The `SET_HVAC_MODE` Resource + +Setting HVAC mode. + {% tabs %} {% tab title="JSON" %} ```json @@ -71,6 +75,37 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th {% endtab %} {% endtabs %} +--- + +### Properties + +**`action_attempt_id`** *UUID* + +ID of the action attempt. + + +--- + +**`action_type`** *String* + + +--- + +**`status`** *Enum* + +
+ +Enum values + +- `success` +- `pending` +- `error` +
+ + +--- + + --- ## Examples diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 1c3c0fd1d..2f985269d 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -47,7 +47,7 @@ Unique key for the user identity. ## Return Type [user\_identity](./) -[object Object] +user_identity --- diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index ee39f18f5..0fb9120b9 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -30,7 +30,7 @@ ID of the desired enrollment automation. ## Return Type [enrollment\_automation](./) -[object Object] +enrollment_automation --- diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 6f4e9fc0f..ba789057f 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -53,7 +53,7 @@ ID of the associated ACS user within the credential manager. If you specify a `c ## Return Type [unknown](./) -[object Object] +enrollment_automation --- diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 025728836..c53165fe0 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -30,7 +30,7 @@ ID of the user identity for which you want to retrieve all enrollment automation ## Return Type Array of [enrollment\_automations](./) -[object Object] +enrollment_automations --- diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 4719bc46f..d8f7a8edb 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -33,7 +33,7 @@ ID of the desired user identity. ## Return Type [user\_identity](./) -[object Object] +user_identity --- diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 3c49d5e6e..0bfd9b680 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -28,7 +28,7 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ## Return Type Array of [user\_identitys](./) -[object Object] +user_identities --- diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 1b58d7138..de71f9773 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -29,7 +29,7 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Return Type Array of [devices](./) -[object Object] +devices --- diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 7a41f3e5b..55e9909c6 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -30,7 +30,7 @@ ID of the user identity for which you want to retrieve all access control system ## Return Type Array of [acs\_systems](./) -[object Object] +acs_systems --- diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index bc66aa668..cf358ca36 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -29,7 +29,7 @@ ID of the user identity for which you want to retrieve all ACS users. ## Return Type Array of [acs\_users](./) -[object Object] +acs_users --- From 6b6af50fd164b6c978ea3ac2e8881168a7a9b0c5 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 23:21:40 -0400 Subject: [PATCH 179/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index e8fcf41be..d60f3eb4d 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -53,11 +53,14 @@ None {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s](./){{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} {{#with response.actionAttempt}} -{{> api-resource headingOffset=true}} +**Action attempt type: {{name}}** +{{> api-response-resource headingOffset=true}} {{/with}} {{#if response.resourceType}} {{#unless response.actionAttempt}} -{{response.responseKey}} +``` +JSON representation of {{response.resourceType}} +``` {{/unless}} {{/if}} {{#if primaryCodeSample}} From 742166e3e235a927168a4ea1d14261d92aa0c350 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 03:22:46 +0000 Subject: [PATCH 180/233] ci: Generate docs --- docs/api/acs/access_groups/get.md | 4 +- docs/api/acs/access_groups/list.md | 4 +- .../list_accessible_entrances.md | 4 +- docs/api/acs/access_groups/list_users.md | 4 +- docs/api/acs/credentials/create.md | 4 +- docs/api/acs/credentials/get.md | 4 +- docs/api/acs/credentials/list.md | 4 +- .../credentials/list_accessible_entrances.md | 4 +- docs/api/acs/encoders/encode_credential.md | 38 +------------------ docs/api/acs/encoders/list.md | 4 +- docs/api/acs/encoders/scan_credential.md | 36 +----------------- docs/api/acs/entrances/get.md | 4 +- docs/api/acs/entrances/list.md | 4 +- .../entrances/list_credentials_with_access.md | 4 +- docs/api/acs/systems/get.md | 4 +- docs/api/acs/systems/list.md | 4 +- ...mpatible_credential_manager_acs_systems.md | 4 +- docs/api/acs/users/create.md | 4 +- docs/api/acs/users/get.md | 4 +- docs/api/acs/users/list.md | 4 +- .../acs/users/list_accessible_entrances.md | 4 +- docs/api/phones/get.md | 4 +- docs/api/phones/list.md | 4 +- .../phones/simulate/create_sandbox_phone.md | 4 +- .../thermostats/activate_climate_preset.md | 36 +----------------- docs/api/thermostats/cool.md | 36 +----------------- docs/api/thermostats/heat.md | 36 +----------------- docs/api/thermostats/heat_cool.md | 36 +----------------- docs/api/thermostats/list.md | 4 +- docs/api/thermostats/off.md | 36 +----------------- docs/api/thermostats/schedules/create.md | 4 +- docs/api/thermostats/schedules/get.md | 4 +- docs/api/thermostats/schedules/list.md | 4 +- docs/api/thermostats/set_fan_mode.md | 36 +----------------- docs/api/thermostats/set_hvac_mode.md | 36 +----------------- docs/api/user_identities/create.md | 4 +- .../enrollment_automations/get.md | 4 +- .../enrollment_automations/launch.md | 4 +- .../enrollment_automations/list.md | 4 +- docs/api/user_identities/get.md | 4 +- docs/api/user_identities/list.md | 4 +- .../list_accessible_devices.md | 4 +- docs/api/user_identities/list_acs_systems.md | 4 +- docs/api/user_identities/list_acs_users.md | 4 +- 44 files changed, 114 insertions(+), 352 deletions(-) diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index d2f7b8d56..c0aabf9e2 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -29,7 +29,9 @@ ID of the desired access group. ## Return Type [acs\_access\_group](./) -acs_access_group +``` +JSON representation of acs_access_group +``` --- diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index c244d9c16..4742fc29f 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -35,7 +35,9 @@ ID of the user for which you want to retrieve all access groups. ## Return Type Array of [acs\_access\_groups](./) -acs_access_groups +``` +JSON representation of acs_access_group +``` --- diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index b3046915c..cf3379d3b 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -29,7 +29,9 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Return Type Array of [acs\_entrances](./) -acs_entrances +``` +JSON representation of acs_entrance +``` --- diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index c20d1aa10..de79090a5 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -29,7 +29,9 @@ ID of the access group for which you want to retrieve all users. ## Return Type Array of [acs\_users](./) -acs_users +``` +JSON representation of acs_user +``` --- diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 461fd348e..179764221 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -89,7 +89,9 @@ Visionline-specific metadata for the new credential. ## Return Type [acs\_credential](./) -acs_credential +``` +JSON representation of acs_credential +``` --- diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 142f0c6c1..d334d8155 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -29,7 +29,9 @@ ID of the desired credential. ## Return Type [acs\_credential](./) -acs_credential +``` +JSON representation of acs_credential +``` --- diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index ced0189c1..786304b12 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -60,7 +60,9 @@ ID of the user identity for which you want to retrieve all credentials. ## Return Type Array of [acs\_credentials](./) -acs_credentials +``` +JSON representation of acs_credential +``` --- diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3c6e5bbb2..e3fc186bf 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -29,7 +29,9 @@ ID of the credential for which you want to retrieve all entrances to which this ## Return Type Array of [acs\_entrances](./) -acs_entrances +``` +JSON representation of acs_entrance +``` --- diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index e622fa6c8..3c2203967 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -36,10 +36,7 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. [action\_attempt](./) -### The `ENCODE_CREDENTIAL` Resource - -Action attempt to track encoding credential data from the physical encoder onto a card. - +**Action attempt type: ENCODE_CREDENTIAL** {% tabs %} {% tab title="JSON" %} ```json @@ -51,36 +48,3 @@ Action attempt to track encoding credential data from the physical encoder onto ``` {% endtab %} {% endtabs %} - ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - -Type of action that the action attempt tracks. - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index bcb9eeb64..2280c2ccd 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -47,4 +47,6 @@ Number of `acs_encoders` to return. ## Return Type Array of [acs\_encoders](./) -acs_encoders +``` +JSON representation of acs_encoder +``` diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index c3313243b..8b063785c 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -30,10 +30,7 @@ ID of the `acs_encoder` to use for the scan. [action\_attempt](./) -### The `SCAN_CREDENTIAL` Resource - -Reading credential data from physical encoder. - +**Action attempt type: SCAN_CREDENTIAL** {% tabs %} {% tab title="JSON" %} ```json @@ -45,34 +42,3 @@ Reading credential data from physical encoder. ``` {% endtab %} {% endtabs %} - ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 18395581e..08bf2b4ac 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -26,7 +26,9 @@ POST /acs/entrances/get ⇒ { acs_entrance } ## Return Type [acs\_entrance](./) -acs_entrance +``` +JSON representation of acs_entrance +``` --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 7f8db4f9a..d0f491547 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -32,7 +32,9 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ## Return Type Array of [acs\_entrances](./) -acs_entrances +``` +JSON representation of acs_entrance +``` --- diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index c8da138e1..676cbf0c6 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -39,7 +39,9 @@ Possible enum values: ## Return Type Array of [acs\_credentials](./) -acs_credentials +``` +JSON representation of acs_credential +``` --- diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 2244e87cd..b2e0c68ba 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -31,7 +31,9 @@ ID of the desired access control system. ## Return Type [acs\_system](./) -acs_system +``` +JSON representation of acs_system +``` --- diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index b21b2bf7d..31d2bb98c 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -32,7 +32,9 @@ ID of the connected account by which to filter the list of returned access contr ## Return Type Array of [acs\_systems](./) -acs_systems +``` +JSON representation of acs_system +``` --- diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index f25426f53..75d279dcc 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -33,7 +33,9 @@ ID of the ACS system for which you want to retrieve all compatible credential ma ## Return Type Array of [acs\_systems](./) -acs_systems +``` +JSON representation of acs_system +``` --- diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index bb7fba2e0..799da7029 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -69,7 +69,9 @@ ID of the user identity with which to associate the new `acs_user`. ## Return Type [acs\_user](./) -acs_user +``` +JSON representation of acs_user +``` --- diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 97a49e4ad..dfec388a4 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -29,7 +29,9 @@ ID of the desired `acs_user`. ## Return Type [acs\_user](./) -acs_user +``` +JSON representation of acs_user +``` --- diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index a7dde3de6..5baa6688d 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -70,7 +70,9 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s ## Return Type Array of [acs\_users](./) -acs_users +``` +JSON representation of acs_user +``` --- diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index c899909df..19593bfdb 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -30,4 +30,6 @@ ID of the desired `acs_user`. ## Return Type Array of [acs\_entrances](./) -acs_entrances +``` +JSON representation of acs_entrance +``` diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 9c6ef95d9..7adc0c62c 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -29,4 +29,6 @@ Device ID of the desired phone. ## Return Type [phone](./) -phone +``` +JSON representation of phone +``` diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index ab272bc56..a36e60ce2 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,4 +35,6 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type Array of [phones](./) -phones +``` +JSON representation of phone +``` diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 29e7de016..95763c246 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -47,4 +47,6 @@ Metadata to associate with the simulated phone. ## Return Type [phone](./) -phone +``` +JSON representation of phone +``` diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 79b3de12c..db615175f 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -36,10 +36,7 @@ ID of the desired thermostat device. [action\_attempt](./) -### The `ACTIVATE_CLIMATE_PRESET` Resource - -Activating climate preset. - +**Action attempt type: ACTIVATE_CLIMATE_PRESET** {% tabs %} {% tab title="JSON" %} ```json @@ -52,37 +49,6 @@ Activating climate preset. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 20a80d7f6..469fe91f3 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -43,10 +43,7 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - +**Action attempt type: SET_HVAC_MODE** {% tabs %} {% tab title="JSON" %} ```json @@ -59,37 +56,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 423098267..2fe1ea06b 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -43,10 +43,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - +**Action attempt type: SET_HVAC_MODE** {% tabs %} {% tab title="JSON" %} ```json @@ -59,37 +56,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 95558f734..ac25ab6b0 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -55,10 +55,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - +**Action attempt type: SET_HVAC_MODE** {% tabs %} {% tab title="JSON" %} ```json @@ -71,37 +68,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 8b386faba..429999f9e 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -131,7 +131,9 @@ Your own internal user ID for the user by which to filter devices. ## Return Type Array of [devices](./) -devices +``` +JSON representation of device +``` --- diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 2b7473084..cc163ae6f 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -31,10 +31,7 @@ ID of the desired thermostat device. [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - +**Action attempt type: SET_HVAC_MODE** {% tabs %} {% tab title="JSON" %} ```json @@ -47,37 +44,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 6b46bed82..eaf249bea 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -66,7 +66,9 @@ User-friendly name to identify the thermostat schedule. ## Return Type [thermostat\_schedule](./) -thermostat_schedule +``` +JSON representation of thermostat_schedule +``` --- diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 7919abe14..4765be118 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -30,7 +30,9 @@ ID of the desired thermostat schedule. ## Return Type [thermostat\_schedule](./) -thermostat_schedule +``` +JSON representation of thermostat_schedule +``` --- diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 5910f447e..70205962c 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -36,7 +36,9 @@ User identifier key by which to filter the list of returned thermostat schedules ## Return Type Array of [thermostat\_schedules](./) -thermostat_schedules +``` +JSON representation of thermostat_schedule +``` --- diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 3432f47c7..b9b883d71 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -39,10 +39,7 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos [action\_attempt](./) -### The `SET_FAN_MODE` Resource - -Setting fan mode. - +**Action attempt type: SET_FAN_MODE** {% tabs %} {% tab title="JSON" %} ```json @@ -55,37 +52,6 @@ Setting fan mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 5a5296af9..ac77e713a 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -59,10 +59,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -### The `SET_HVAC_MODE` Resource - -Setting HVAC mode. - +**Action attempt type: SET_HVAC_MODE** {% tabs %} {% tab title="JSON" %} ```json @@ -75,37 +72,6 @@ Setting HVAC mode. {% endtab %} {% endtabs %} ---- - -### Properties - -**`action_attempt_id`** *UUID* - -ID of the action attempt. - - ---- - -**`action_type`** *String* - - ---- - -**`status`** *Enum* - -
- -Enum values - -- `success` -- `pending` -- `error` -
- - ---- - - --- ## Examples diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 2f985269d..09505928f 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -47,7 +47,9 @@ Unique key for the user identity. ## Return Type [user\_identity](./) -user_identity +``` +JSON representation of user_identity +``` --- diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 0fb9120b9..4ceed80b5 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -30,7 +30,9 @@ ID of the desired enrollment automation. ## Return Type [enrollment\_automation](./) -enrollment_automation +``` +JSON representation of enrollment_automation +``` --- diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index ba789057f..2a0146155 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -53,7 +53,9 @@ ID of the associated ACS user within the credential manager. If you specify a `c ## Return Type [unknown](./) -enrollment_automation +``` +JSON representation of unknown +``` --- diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index c53165fe0..308da9a37 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -30,7 +30,9 @@ ID of the user identity for which you want to retrieve all enrollment automation ## Return Type Array of [enrollment\_automations](./) -enrollment_automations +``` +JSON representation of enrollment_automation +``` --- diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index d8f7a8edb..618542c19 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -33,7 +33,9 @@ ID of the desired user identity. ## Return Type [user\_identity](./) -user_identity +``` +JSON representation of user_identity +``` --- diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 0bfd9b680..cb5033575 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -28,7 +28,9 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ## Return Type Array of [user\_identitys](./) -user_identities +``` +JSON representation of user_identity +``` --- diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index de71f9773..dafdd263a 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -29,7 +29,9 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Return Type Array of [devices](./) -devices +``` +JSON representation of device +``` --- diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 55e9909c6..b472a6793 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -30,7 +30,9 @@ ID of the user identity for which you want to retrieve all access control system ## Return Type Array of [acs\_systems](./) -acs_systems +``` +JSON representation of acs_system +``` --- diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index cf358ca36..ee10daddc 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -29,7 +29,9 @@ ID of the user identity for which you want to retrieve all ACS users. ## Return Type Array of [acs\_users](./) -acs_users +``` +JSON representation of acs_user +``` --- From 83c3516325ca8a056c988bfd8a84acb286fdb1bb Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 23:28:16 -0400 Subject: [PATCH 181/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index d60f3eb4d..b96bd981a 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -53,14 +53,20 @@ None {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s](./){{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} {{#with response.actionAttempt}} -**Action attempt type: {{name}}** +**`{{name}}`** {{> api-response-resource headingOffset=true}} {{/with}} {{#if response.resourceType}} {{#unless response.actionAttempt}} +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of {{response.resourceType}} +} ``` -JSON representation of {{response.resourceType}} -``` +{% endtab %} +{% endtabs %} {{/unless}} {{/if}} {{#if primaryCodeSample}} From 1ff0ef1d32fa50755ebf65fd4657f8604c59092d Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 03:29:14 +0000 Subject: [PATCH 182/233] ci: Generate docs --- docs/api/acs/access_groups/get.md | 10 ++++++++-- docs/api/acs/access_groups/list.md | 10 ++++++++-- .../api/acs/access_groups/list_accessible_entrances.md | 10 ++++++++-- docs/api/acs/access_groups/list_users.md | 10 ++++++++-- docs/api/acs/credentials/create.md | 10 ++++++++-- docs/api/acs/credentials/get.md | 10 ++++++++-- docs/api/acs/credentials/list.md | 10 ++++++++-- docs/api/acs/credentials/list_accessible_entrances.md | 10 ++++++++-- docs/api/acs/encoders/encode_credential.md | 2 +- docs/api/acs/encoders/list.md | 10 ++++++++-- docs/api/acs/encoders/scan_credential.md | 2 +- docs/api/acs/entrances/get.md | 10 ++++++++-- docs/api/acs/entrances/list.md | 10 ++++++++-- docs/api/acs/entrances/list_credentials_with_access.md | 10 ++++++++-- docs/api/acs/systems/get.md | 10 ++++++++-- docs/api/acs/systems/list.md | 10 ++++++++-- .../list_compatible_credential_manager_acs_systems.md | 10 ++++++++-- docs/api/acs/users/create.md | 10 ++++++++-- docs/api/acs/users/get.md | 10 ++++++++-- docs/api/acs/users/list.md | 10 ++++++++-- docs/api/acs/users/list_accessible_entrances.md | 10 ++++++++-- docs/api/phones/get.md | 10 ++++++++-- docs/api/phones/list.md | 10 ++++++++-- docs/api/phones/simulate/create_sandbox_phone.md | 10 ++++++++-- docs/api/thermostats/activate_climate_preset.md | 2 +- docs/api/thermostats/cool.md | 2 +- docs/api/thermostats/heat.md | 2 +- docs/api/thermostats/heat_cool.md | 2 +- docs/api/thermostats/list.md | 10 ++++++++-- docs/api/thermostats/off.md | 2 +- docs/api/thermostats/schedules/create.md | 10 ++++++++-- docs/api/thermostats/schedules/get.md | 10 ++++++++-- docs/api/thermostats/schedules/list.md | 10 ++++++++-- docs/api/thermostats/set_fan_mode.md | 2 +- docs/api/thermostats/set_hvac_mode.md | 2 +- docs/api/user_identities/create.md | 10 ++++++++-- docs/api/user_identities/enrollment_automations/get.md | 10 ++++++++-- .../user_identities/enrollment_automations/launch.md | 10 ++++++++-- .../api/user_identities/enrollment_automations/list.md | 10 ++++++++-- docs/api/user_identities/get.md | 10 ++++++++-- docs/api/user_identities/list.md | 10 ++++++++-- docs/api/user_identities/list_accessible_devices.md | 10 ++++++++-- docs/api/user_identities/list_acs_systems.md | 10 ++++++++-- docs/api/user_identities/list_acs_users.md | 10 ++++++++-- 44 files changed, 289 insertions(+), 79 deletions(-) diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index c0aabf9e2..b3ab80469 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -29,9 +29,15 @@ ID of the desired access group. ## Return Type [acs\_access\_group](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_access_group +} ``` -JSON representation of acs_access_group -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 4742fc29f..1210df476 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -35,9 +35,15 @@ ID of the user for which you want to retrieve all access groups. ## Return Type Array of [acs\_access\_groups](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_access_group +} ``` -JSON representation of acs_access_group -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index cf3379d3b..29dd2fd5a 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -29,9 +29,15 @@ ID of the access group for which you want to retrieve all accessible entrances. ## Return Type Array of [acs\_entrances](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_entrance +} ``` -JSON representation of acs_entrance -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index de79090a5..eee336a8a 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -29,9 +29,15 @@ ID of the access group for which you want to retrieve all users. ## Return Type Array of [acs\_users](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_user +} ``` -JSON representation of acs_user -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 179764221..b216d3b9d 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -89,9 +89,15 @@ Visionline-specific metadata for the new credential. ## Return Type [acs\_credential](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_credential +} ``` -JSON representation of acs_credential -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index d334d8155..451b7e8f2 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -29,9 +29,15 @@ ID of the desired credential. ## Return Type [acs\_credential](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_credential +} ``` -JSON representation of acs_credential -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 786304b12..c827eb368 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -60,9 +60,15 @@ ID of the user identity for which you want to retrieve all credentials. ## Return Type Array of [acs\_credentials](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_credential +} ``` -JSON representation of acs_credential -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index e3fc186bf..4ec9aba3c 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -29,9 +29,15 @@ ID of the credential for which you want to retrieve all entrances to which this ## Return Type Array of [acs\_entrances](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_entrance +} ``` -JSON representation of acs_entrance -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 3c2203967..40bf195dd 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -36,7 +36,7 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. [action\_attempt](./) -**Action attempt type: ENCODE_CREDENTIAL** +**`ENCODE_CREDENTIAL`** {% tabs %} {% tab title="JSON" %} ```json diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 2280c2ccd..fb3ee74f9 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -47,6 +47,12 @@ Number of `acs_encoders` to return. ## Return Type Array of [acs\_encoders](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_encoder +} ``` -JSON representation of acs_encoder -``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 8b063785c..2135edfda 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -30,7 +30,7 @@ ID of the `acs_encoder` to use for the scan. [action\_attempt](./) -**Action attempt type: SCAN_CREDENTIAL** +**`SCAN_CREDENTIAL`** {% tabs %} {% tab title="JSON" %} ```json diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 08bf2b4ac..17c846eba 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -26,9 +26,15 @@ POST /acs/entrances/get ⇒ { acs_entrance } ## Return Type [acs\_entrance](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_entrance +} ``` -JSON representation of acs_entrance -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index d0f491547..dec4f82d0 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -32,9 +32,15 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ## Return Type Array of [acs\_entrances](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_entrance +} ``` -JSON representation of acs_entrance -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 676cbf0c6..fd6d8a7f0 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -39,9 +39,15 @@ Possible enum values: ## Return Type Array of [acs\_credentials](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_credential +} ``` -JSON representation of acs_credential -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index b2e0c68ba..97d44f27e 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -31,9 +31,15 @@ ID of the desired access control system. ## Return Type [acs\_system](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_system +} ``` -JSON representation of acs_system -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 31d2bb98c..4bbe447a6 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -32,9 +32,15 @@ ID of the connected account by which to filter the list of returned access contr ## Return Type Array of [acs\_systems](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_system +} ``` -JSON representation of acs_system -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 75d279dcc..5a441f3bb 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -33,9 +33,15 @@ ID of the ACS system for which you want to retrieve all compatible credential ma ## Return Type Array of [acs\_systems](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_system +} ``` -JSON representation of acs_system -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 799da7029..dac61d3ff 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -69,9 +69,15 @@ ID of the user identity with which to associate the new `acs_user`. ## Return Type [acs\_user](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_user +} ``` -JSON representation of acs_user -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index dfec388a4..f86a5e1ec 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -29,9 +29,15 @@ ID of the desired `acs_user`. ## Return Type [acs\_user](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_user +} ``` -JSON representation of acs_user -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 5baa6688d..f612e7d76 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -70,9 +70,15 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s ## Return Type Array of [acs\_users](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_user +} ``` -JSON representation of acs_user -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 19593bfdb..059943aab 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -30,6 +30,12 @@ ID of the desired `acs_user`. ## Return Type Array of [acs\_entrances](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_entrance +} ``` -JSON representation of acs_entrance -``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 7adc0c62c..1401302a3 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -29,6 +29,12 @@ Device ID of the desired phone. ## Return Type [phone](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of phone +} ``` -JSON representation of phone -``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index a36e60ce2..028de3f4a 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -35,6 +35,12 @@ ID of the user identity that represents the owner by which to filter the list of ## Return Type Array of [phones](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of phone +} ``` -JSON representation of phone -``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 95763c246..9588d53b7 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -47,6 +47,12 @@ Metadata to associate with the simulated phone. ## Return Type [phone](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of phone +} ``` -JSON representation of phone -``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index db615175f..ec35d3659 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -36,7 +36,7 @@ ID of the desired thermostat device. [action\_attempt](./) -**Action attempt type: ACTIVATE_CLIMATE_PRESET** +**`ACTIVATE_CLIMATE_PRESET`** {% tabs %} {% tab title="JSON" %} ```json diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 469fe91f3..daee32130 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -43,7 +43,7 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -**Action attempt type: SET_HVAC_MODE** +**`SET_HVAC_MODE`** {% tabs %} {% tab title="JSON" %} ```json diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 2fe1ea06b..fa1a71ee1 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -43,7 +43,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -**Action attempt type: SET_HVAC_MODE** +**`SET_HVAC_MODE`** {% tabs %} {% tab title="JSON" %} ```json diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index ac25ab6b0..160878c1a 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -55,7 +55,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -**Action attempt type: SET_HVAC_MODE** +**`SET_HVAC_MODE`** {% tabs %} {% tab title="JSON" %} ```json diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 429999f9e..f4d2c2ed4 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -131,9 +131,15 @@ Your own internal user ID for the user by which to filter devices. ## Return Type Array of [devices](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of device +} ``` -JSON representation of device -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index cc163ae6f..b076e900f 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -31,7 +31,7 @@ ID of the desired thermostat device. [action\_attempt](./) -**Action attempt type: SET_HVAC_MODE** +**`SET_HVAC_MODE`** {% tabs %} {% tab title="JSON" %} ```json diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index eaf249bea..07a6bf768 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -66,9 +66,15 @@ User-friendly name to identify the thermostat schedule. ## Return Type [thermostat\_schedule](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of thermostat_schedule +} ``` -JSON representation of thermostat_schedule -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 4765be118..6f257b13a 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -30,9 +30,15 @@ ID of the desired thermostat schedule. ## Return Type [thermostat\_schedule](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of thermostat_schedule +} ``` -JSON representation of thermostat_schedule -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 70205962c..5d2cab178 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -36,9 +36,15 @@ User identifier key by which to filter the list of returned thermostat schedules ## Return Type Array of [thermostat\_schedules](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of thermostat_schedule +} ``` -JSON representation of thermostat_schedule -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index b9b883d71..397b72113 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -39,7 +39,7 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos [action\_attempt](./) -**Action attempt type: SET_FAN_MODE** +**`SET_FAN_MODE`** {% tabs %} {% tab title="JSON" %} ```json diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index ac77e713a..4490780d5 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -59,7 +59,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th [action\_attempt](./) -**Action attempt type: SET_HVAC_MODE** +**`SET_HVAC_MODE`** {% tabs %} {% tab title="JSON" %} ```json diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 09505928f..1b39ad0bc 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -47,9 +47,15 @@ Unique key for the user identity. ## Return Type [user\_identity](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of user_identity +} ``` -JSON representation of user_identity -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 4ceed80b5..bae4ee8b5 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -30,9 +30,15 @@ ID of the desired enrollment automation. ## Return Type [enrollment\_automation](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of enrollment_automation +} ``` -JSON representation of enrollment_automation -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 2a0146155..f9a037759 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -53,9 +53,15 @@ ID of the associated ACS user within the credential manager. If you specify a `c ## Return Type [unknown](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of unknown +} ``` -JSON representation of unknown -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 308da9a37..7ceb091b3 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -30,9 +30,15 @@ ID of the user identity for which you want to retrieve all enrollment automation ## Return Type Array of [enrollment\_automations](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of enrollment_automation +} ``` -JSON representation of enrollment_automation -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 618542c19..029956afb 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -33,9 +33,15 @@ ID of the desired user identity. ## Return Type [user\_identity](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of user_identity +} ``` -JSON representation of user_identity -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index cb5033575..1b563607d 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -28,9 +28,15 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ## Return Type Array of [user\_identitys](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of user_identity +} ``` -JSON representation of user_identity -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index dafdd263a..e1d85dfca 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -29,9 +29,15 @@ ID of the user identity for which you want to retrieve all accessible devices. ## Return Type Array of [devices](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of device +} ``` -JSON representation of device -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index b472a6793..df7000f7e 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -30,9 +30,15 @@ ID of the user identity for which you want to retrieve all access control system ## Return Type Array of [acs\_systems](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_system +} ``` -JSON representation of acs_system -``` +{% endtab %} +{% endtabs %} --- diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index ee10daddc..ef32c2048 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -29,9 +29,15 @@ ID of the user identity for which you want to retrieve all ACS users. ## Return Type Array of [acs\_users](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of acs_user +} ``` -JSON representation of acs_user -``` +{% endtab %} +{% endtabs %} --- From d90304c34518eeaef1c1ab8e0266b598712a2bb7 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Sun, 6 Apr 2025 23:54:27 -0400 Subject: [PATCH 183/233] Update api-namespace.hbs --- src/layouts/api-namespace.hbs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/layouts/api-namespace.hbs b/src/layouts/api-namespace.hbs index 16e7e1147..a17c63491 100644 --- a/src/layouts/api-namespace.hbs +++ b/src/layouts/api-namespace.hbs @@ -14,4 +14,5 @@ The {{title}} namespace contains the following resources: ### [`{{name}}`]({{link}}) {{description}} +--- {{/each}} From a88ac76fc750fd1cd3bf62a544149236a715fcac Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 03:55:33 +0000 Subject: [PATCH 184/233] ci: Generate docs --- docs/api/acs/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api/acs/README.md b/docs/api/acs/README.md index 78c99bd4b..f7f0c9bc9 100644 --- a/docs/api/acs/README.md +++ b/docs/api/acs/README.md @@ -30,6 +30,7 @@ Within an `acs_system`, create [`acs_user`s](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/latest/api/acs). +--- ### [`acs_user`](./users/README.md#acs_user) Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -37,11 +38,13 @@ An `acs_user` typically refers to an individual who requires access, like an emp For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems). +--- ### [`acs_entrance`](./entrances/README.md#acs_entrance) Represents an [entrance](../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/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. +--- ### [`acs_access_group`](./access_groups/README.md#acs_access_group) 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. @@ -49,6 +52,7 @@ Some access control systems use [access group](https://docs.seam.co/latest/capab To learn whether your access control system supports access groups, see the corresponding [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems). +--- ### [`acs_credential`](./credentials/README.md#acs_credential) Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -56,6 +60,7 @@ An access control system generally uses digital means of access to authorize a u For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type. +--- ### [`acs_encoder`](./encoders/README.md#acs_encoder) Represents a hardware device that encodes [credential](../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -72,3 +77,4 @@ Separately, the Seam API also supports card scanning, which enables you to scan To verify if your access control system requires a card encoder, see the corresponding [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems). +--- From 1bf27aee62e7fe0a59129da2f3159d3c44090579 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 7 Apr 2025 15:55:32 -0400 Subject: [PATCH 185/233] Update SUMMARY.md --- docs/SUMMARY.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index e0b72de26..6c7ddb1dc 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -126,19 +126,23 @@ * [Overview](api-clients/overview.md) * [Installation](api-clients/installation.md) * [Authentication](api-clients/authentication.md) -* [Access Codes](api-clients/access_codes/README.md) - * [Create an Access Code](api-clients/access_codes/create.md) - * [Create Multiple Linked Access Codes](api-clients/access_codes/create_multiple.md) - * [List Access Codes](api-clients/access_codes/list.md) - * [Get an Access Code](api-clients/access_codes/get.md) - * [Update an Access Code](api-clients/access_codes/update.md) - * [Update Multiple Linked Access Codes](api-clients/access_codes/update-multiple-linked-access-codes.md) - * [Delete an Access Code](api-clients/access_codes/delete.md) - * [Pull Backup Access Code](api-clients/access_codes/pull_backup_access_code.md) - * [Unmanaged Access Codes](api-clients/access_codes/unmanaged/README.md) - * [List Unmanaged Access Codes](api-clients/access_codes/unmanaged/list.md) - * [Convert an Unmanaged Access Code](api-clients/access_codes/unmanaged/convert_to_managed.md) - * [Delete an Unmanaged Access Code](api-clients/access_codes/unmanaged/delete.md) +* [Access Codes](api/access_codes/README.md) + * [Create an Access Code](api/access_codes/create.md) + * [Create Multiple Linked Access Codes](api/access_codes/create_multiple.md) + * [List Access Codes](api/access_codes/list.md) + * [Get an Access Code](api/access_codes/get.md) + * [Update an Access Code](api/access_codes/update.md) + * [Update Multiple Linked Access Codes](api/access_codes/update-multiple-linked-access-codes.md) + * [Delete an Access Code](api/access_codes/delete.md) + * [Pull a Backup Access Code](api/access_codes/pull_backup_access_code.md) + * [Unmanaged Access Codes](api/access_codes/unmanaged/README.md) + * [List Unmanaged Access Codes](api/access_codes/unmanaged/list.md) + * [Get an Unmanaged Access Code](api/access_codes/unmanaged/get.md) + * [Convert an Unmanaged Access Code](api/access_codes/unmanaged/convert_to_managed.md) + * [Update an Unmanaged Access Code](api/access_codes/unmanaged/update.md) + * [Delete an Unmanaged Access Code](api/access_codes/unmanaged/delete.md) + * [Access Code Simulations](api/access_codes/simulate/README.md) + * [Simulate Creating an Unmanaged Access Code](api/access_codes/simulate/create_unmanaged_access_code.md) * [Access Control Systems (ACS)](api/acs/README.md) * [Systems](api/acs/systems/README.md) * [List ACS Systems](api/acs/systems/list.md) From 88d7b5e0d21e4059d03ef551e1fce0323b65efb9 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 7 Apr 2025 15:56:18 -0400 Subject: [PATCH 186/233] Update paths.yaml --- src/data/paths.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 59ffc89a8..07dbb79ff 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -85,3 +85,6 @@ title: Access Codes resources: - access_code + +/access_codes/simulate: + title: Access Code Simulations From 6e75752407b6a10844e179c8c36442b0ca4bd7a6 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 19:57:24 +0000 Subject: [PATCH 187/233] ci: Generate docs --- docs/api/_report.md | 1 - docs/api/access_codes/simulate/README.md | 8 ++++++++ 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/api/access_codes/simulate/README.md diff --git a/docs/api/_report.md b/docs/api/_report.md index 9c9fc7d91..cbaacc1f2 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -4,7 +4,6 @@ ### Routes -- `/access_codes/simulate` - `/access_codes/unmanaged` - `/action_attempts` - `/bridges` diff --git a/docs/api/access_codes/simulate/README.md b/docs/api/access_codes/simulate/README.md new file mode 100644 index 000000000..7f4e746e4 --- /dev/null +++ b/docs/api/access_codes/simulate/README.md @@ -0,0 +1,8 @@ +# Access Code Simulations + +The Access Code Simulations route contains the following resources: + + +## Endpoints + + From 996793458ec898cde0ce7eb6e389b46c54fe4539 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 7 Apr 2025 17:49:28 -0400 Subject: [PATCH 188/233] Update package.json --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index c4bb7937d..29274306b 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,7 @@ "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.38.0", - "@seamapi/types": "1.370.3", + "@seamapi/types": "1.377.0", "change-case": "^5.4.4", "command-exists": "^1.2.9", "del": "^8.0.0", From 64c3c57c635feaabd180d8230e609623d000769c Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 21:50:39 +0000 Subject: [PATCH 189/233] ci: Generate docs --- docs/api/_report.md | 134 +++-------------- docs/api/access_codes/README.md | 81 +++++++++-- docs/api/access_codes/create.md | 131 +++++++++++++++++ docs/api/access_codes/create_multiple.md | 135 ++++++++++++++++++ docs/api/access_codes/delete.md | 38 +++++ docs/api/access_codes/get.md | 53 +++++++ docs/api/access_codes/list.md | 55 +++++++ .../access_codes/pull_backup_access_code.md | 49 +++++++ docs/api/access_codes/simulate/README.md | 5 + .../simulate/create_unmanaged_access_code.md | 53 +++++++ docs/api/access_codes/update.md | 132 +++++++++++++++++ docs/api/access_codes/update_multiple.md | 54 +++++++ docs/api/acs/credentials/README.md | 55 +++++++ docs/api/acs/systems/README.md | 24 +++- ...mpatible_credential_manager_acs_systems.md | 6 +- docs/api/acs/users/list.md | 2 +- docs/api/thermostats/list.md | 32 +---- package-lock.json | 8 +- 18 files changed, 874 insertions(+), 173 deletions(-) create mode 100644 docs/api/access_codes/create.md create mode 100644 docs/api/access_codes/create_multiple.md create mode 100644 docs/api/access_codes/delete.md create mode 100644 docs/api/access_codes/get.md create mode 100644 docs/api/access_codes/list.md create mode 100644 docs/api/access_codes/pull_backup_access_code.md create mode 100644 docs/api/access_codes/simulate/create_unmanaged_access_code.md create mode 100644 docs/api/access_codes/update.md create mode 100644 docs/api/access_codes/update_multiple.md diff --git a/docs/api/_report.md b/docs/api/_report.md index cbaacc1f2..e2549c3c6 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -24,21 +24,7 @@ ### Endpoints -- `/access_codes/create` -- `/access_codes/create_multiple` -- `/access_codes/delete` - `/access_codes/generate_code` -- `/access_codes/get` -- `/access_codes/list` -- `/access_codes/pull_backup_access_code` -- `/access_codes/update` -- `/access_codes/update_multiple` -- `/access_codes/simulate/create_unmanaged_access_code` -- `/access_codes/unmanaged/convert_to_managed` -- `/access_codes/unmanaged/delete` -- `/access_codes/unmanaged/get` -- `/access_codes/unmanaged/list` -- `/access_codes/unmanaged/update` - `/action_attempts/get` - `/action_attempts/list` - `/bridges/get` @@ -112,11 +98,11 @@ These items are intentionally undocumented. - `acs_user.is_latest_desired_state_synced_with_provider`: Only used internally. - `acs_user.latest_desired_state_synced_with_provider_at`: Only used internally. -- `acs_user.pending_modifications`: Experimental. +- `acs_user.pending_mutations`: Experimental. - `thermostat_schedule.unstable_is_override_allowed`: Unstable - `unmanaged_acs_user.is_latest_desired_state_synced_with_provider`: Only used internally. - `unmanaged_acs_user.latest_desired_state_synced_with_provider_at`: Only used internally. -- `unmanaged_acs_user.pending_modifications`: Experimental. +- `unmanaged_acs_user.pending_mutations`: Experimental. ### Namespaces @@ -152,6 +138,16 @@ These items are intentionally undocumented. ### Endpoint parameters +- `/access_codes/create` + - `sync`: Only used internally. +- `/access_codes/delete` + - `sync`: Only used internally. +- `/access_codes/update` + - `sync`: Only used internally. +- `/access_codes/unmanaged/convert_to_managed` + - `sync`: Only used internally. +- `/access_codes/unmanaged/delete` + - `sync`: Only used internally. - `/devices/list` - `exclude_if`: Only used internally. - `include_if`: Only used internally. @@ -190,7 +186,6 @@ Items that are intentionally undocumented are not included in this section. ### Resources -- `access_code` - `acs_credential_pool` - `acs_credential_provisioning_automation` - `client_session` @@ -201,7 +196,6 @@ Items that are intentionally undocumented are not included in this section. - `event` - `network` - `noise_threshold` -- `unmanaged_access_code` - `unmanaged_acs_access_group` - `unmanaged_device` - `webhook` @@ -227,6 +221,8 @@ Items that are intentionally undocumented are not included in this section. - `acs_credential_provisioning_automation.credential_manager_acs_system_id` - `acs_credential_provisioning_automation.user_identity_id` - `acs_credential_provisioning_automation.workspace_id` +- `acs_system.acs_access_group_count` +- `acs_system.acs_user_count` - `acs_system.location` - `acs_system.system_type` - `acs_system.system_type_display_name` @@ -236,7 +232,7 @@ Items that are intentionally undocumented are not included in this section. - `acs_user.is_latest_desired_state_synced_with_provider` - `acs_user.is_managed` - `acs_user.latest_desired_state_synced_with_provider_at` -- `acs_user.pending_modifications` +- `acs_user.pending_mutations` - `client_session.client_session_id` - `client_session.connect_webview_ids` - `client_session.connected_account_ids` @@ -314,8 +310,6 @@ Items that are intentionally undocumented are not included in this section. - `noise_threshold.noise_threshold_id` - `noise_threshold.noise_threshold_nrs` - `noise_threshold.starts_daily_at` -- `unmanaged_access_code.is_managed` -- `unmanaged_access_code.status` - `unmanaged_acs_access_group.access_group_type` - `unmanaged_acs_access_group.access_group_type_display_name` - `unmanaged_acs_access_group.display_name` @@ -327,7 +321,7 @@ Items that are intentionally undocumented are not included in this section. - `unmanaged_acs_user.is_latest_desired_state_synced_with_provider` - `unmanaged_acs_user.is_managed` - `unmanaged_acs_user.latest_desired_state_synced_with_provider_at` -- `unmanaged_acs_user.pending_modifications` +- `unmanaged_acs_user.pending_mutations` - `unmanaged_device.can_hvac_cool` - `unmanaged_device.can_hvac_heat` - `unmanaged_device.can_hvac_heat_cool` @@ -355,20 +349,7 @@ Items that are intentionally undocumented are not included in this section. ### Endpoints -- `/access_codes/create` -- `/access_codes/create_multiple` -- `/access_codes/delete` - `/access_codes/generate_code` -- `/access_codes/get` -- `/access_codes/list` -- `/access_codes/update` -- `/access_codes/update_multiple` -- `/access_codes/simulate/create_unmanaged_access_code` -- `/access_codes/unmanaged/convert_to_managed` -- `/access_codes/unmanaged/delete` -- `/access_codes/unmanaged/get` -- `/access_codes/unmanaged/list` -- `/access_codes/unmanaged/update` - `/acs/credential_pools/list` - `/acs/credential_provisioning_automations/launch` - `/acs/entrances/grant_access` @@ -434,106 +415,25 @@ Items that are intentionally undocumented are not included in this section. ### Endpoint parameters - `/access_codes/create` - - `allow_external_modification` - `attempt_for_offline_device` - - `code` - - `common_code_key` - - `device_id` - - `ends_at` - - `is_external_modification_allowed` - - `is_offline_access_code` - - `is_one_time_use` - - `max_time_rounding` - - `name` - - `prefer_native_scheduling` - - `preferred_code_length` - - `starts_at` - `sync` - - `use_backup_access_code_pool` - `use_offline_access_code` - `/access_codes/create_multiple` - - `allow_external_modification` - `attempt_for_offline_device` - - `behavior_when_code_cannot_be_shared` - - `code` - - `device_ids` - - `ends_at` - - `is_external_modification_allowed` - - `is_offline_access_code` - - `is_one_time_use` - - `max_time_rounding` - - `name` - - `prefer_native_scheduling` - - `preferred_code_length` - - `starts_at` - - `use_backup_access_code_pool` - `use_offline_access_code` - `/access_codes/delete` - - `access_code_id` - - `device_id` - `sync` - `/access_codes/generate_code` - `device_id` -- `/access_codes/get` - - `access_code_id` - - `code` - - `device_id` -- `/access_codes/list` - - `access_code_ids` - - `device_id` - - `user_identifier_key` -- `/access_codes/pull_backup_access_code` - - `access_code_id` - `/access_codes/update` - - `access_code_id` - - `allow_external_modification` - `attempt_for_offline_device` - - `code` - - `device_id` - - `ends_at` - - `is_external_modification_allowed` - - `is_managed` - - `is_offline_access_code` - - `is_one_time_use` - - `max_time_rounding` - - `name` - - `prefer_native_scheduling` - - `preferred_code_length` - - `starts_at` - `sync` - - `type` - - `use_backup_access_code_pool` - `use_offline_access_code` -- `/access_codes/update_multiple` - - `common_code_key` - - `ends_at` - - `name` - - `starts_at` -- `/access_codes/simulate/create_unmanaged_access_code` - - `code` - - `device_id` - - `name` - `/access_codes/unmanaged/convert_to_managed` - - `access_code_id` - - `allow_external_modification` - - `force` - - `is_external_modification_allowed` - `sync` - `/access_codes/unmanaged/delete` - - `access_code_id` - `sync` -- `/access_codes/unmanaged/get` - - `access_code_id` - - `code` - - `device_id` -- `/access_codes/unmanaged/list` - - `device_id` - - `user_identifier_key` - `/access_codes/unmanaged/update` - - `access_code_id` - - `allow_external_modification` - - `force` - - `is_external_modification_allowed` - `is_managed` - `/acs/credential_pools/list` - `acs_system_id` @@ -851,6 +751,8 @@ These items are deprecated. - `backup_access_code` - `/acs/users/list` - `pagination` +- `/connected_accounts/list` + - `pagination` - `/events/get` - `message` - `/locks/get` diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index c9738efc0..cb4c2104f 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -6,6 +6,14 @@ The Access Codes route contains the following resources: ## The `access_code` Resource +Represents a smart lock [access code](https://docs.seam.co/latest/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`. + +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. + {% tabs %} {% tab title="JSON" %} ```json @@ -84,7 +92,7 @@ Date and time after which the time-bound access code becomes inactive. [**`errors`**](./#errors) *List* *of Objects* -Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. +Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). --- @@ -119,14 +127,14 @@ Indicates whether Seam manages the access code. **`is_offline_access_code`** *Boolean* -Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. +Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. --- **`is_one_time_use`** *Boolean* -Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. +Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. --- @@ -168,9 +176,7 @@ Date and time at which the time-bound access code becomes active. **`status`** *Enum* - - 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. - +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.
@@ -188,7 +194,7 @@ Date and time at which the time-bound access code becomes active. **`type`** *Enum* -Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. +Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.
@@ -203,7 +209,7 @@ Nature of the access code. Values are "ongoing" for access codes that are active [**`warnings`**](./#warnings) *List* *of Objects* -Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. +Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). --- @@ -213,7 +219,7 @@ Collection of warnings associated with the access code, structured in a dictiona **`smartthings_failed_to_set_access_code`** -Failed to set code on Smart Things device. +Failed to set code on SmartThings device. --- @@ -267,13 +273,13 @@ Igloohome bridge is offline. **`igloohome_offline_access_code_no_variance_available`** -Lock as reached max amount of codes. +Lock has reached maximum amount of codes. --- **`kwikset_unable_to_confirm_code`** -Unable to confirm the access code is set on Kwikset device. +Unable to confirm that the access code is set on Kwikset device. --- @@ -439,12 +445,19 @@ 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). + +--- + ## Warnings **`smartthings_failed_to_set_access_code`** -Failed to set code on Smart Things device. +Failed to set code on SmartThings device. --- @@ -480,7 +493,7 @@ Delay in removing code from device. **`third_party_integration_detected`** -Third party integration detected that may cause access codes to fail. +Third-party integration detected that may cause access codes to fail. --- @@ -510,7 +523,7 @@ Management was transferred to another workspace. **`kwikset_unable_to_confirm_code`** -Unable to confirm the access code is set on Kwikset device. +Unable to confirm that the access code is set on Kwikset device. --- @@ -1511,3 +1524,43 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l ## Endpoints +[**`/access_codes/create`**](./create.md) + +Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + +[**`/access_codes/create_multiple`**](./create_multiple.md) + +Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. + + +[**`/access_codes/delete`**](./delete.md) + +Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + +[**`/access_codes/get`**](./get.md) + +Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + +[**`/access_codes/list`**](./list.md) + +Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + +[**`/access_codes/pull_backup_access_code`**](./pull_backup_access_code.md) + +Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). + + +[**`/access_codes/update`**](./update.md) + +Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + +[**`/access_codes/update_multiple`**](./update_multiple.md) + +Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. + + diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md new file mode 100644 index 000000000..e669299ee --- /dev/null +++ b/docs/api/access_codes/create.md @@ -0,0 +1,131 @@ +# Create an Access Code + +Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +{% hint style="success" %} +``` +POST /access_codes/create ⇒ { access_code } +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`device_id`** *String* (Required) + +ID of the device for which to create the new access code. + +--- + +**`allow_external_modification`** *Boolean* + +Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. + +--- + +**`attempt_for_offline_device`** *Boolean* + +--- + +**`code`** *String* + +Code to be used for access. + +--- + +**`common_code_key`** *String* + +Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md). + +--- + +**`ends_at`** *String* + +Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. + +--- + +**`is_external_modification_allowed`** *Boolean* + +Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. + +--- + +**`is_offline_access_code`** *Boolean* + +Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). + +--- + +**`is_one_time_use`** *Boolean* + +Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. + +--- + +**`max_time_rounding`** *String* + +Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. + +--- + +**`name`** *String* + +Name of the new access code. + +--- + +**`prefer_native_scheduling`** *Boolean* + +Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. + +--- + +**`preferred_code_length`** *Number* + +Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. + +--- + +**`starts_at`** *String* + +Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + +--- + +**`use_backup_access_code_pool`** *Boolean* + +Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). + +--- + +**`use_offline_access_code`** *Boolean* + +--- + + +## Return Type + +[access\_code](./) + +**`CREATE_ACCESS_CODE`** +{% tabs %} +{% tab title="JSON" %} +```json +{ + action_attempt_id: [example value], + action_type: [example value], + status: [example value] +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md new file mode 100644 index 000000000..4ae53a44f --- /dev/null +++ b/docs/api/access_codes/create_multiple.md @@ -0,0 +1,135 @@ +# Create Multiple Linked Access Codes + +Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. + +Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock. + +If you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes. + +If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`. + +See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md). + +{% hint style="success" %} +``` +PUT /access_codes/create_multiple ⇒ { access_codes: [access_code, …] } +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`device_ids`** *Array* *of UUIDs* (Required) + +IDs of the devices for which to create the new access codes. + +--- + +**`allow_external_modification`** *Boolean* + +Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. + +--- + +**`attempt_for_offline_device`** *Boolean* + +--- + +**`behavior_when_code_cannot_be_shared`** *String* + +Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. + +--- + +**`code`** *String* + +Code to be used for access. + +--- + +**`ends_at`** *String* + +Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. + +--- + +**`is_external_modification_allowed`** *Boolean* + +Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. + +--- + +**`is_offline_access_code`** *Boolean* + +Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). + +--- + +**`is_one_time_use`** *Boolean* + +Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. + +--- + +**`max_time_rounding`** *String* + +Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. + +--- + +**`name`** *String* + +Name of the new access code. + +--- + +**`prefer_native_scheduling`** *Boolean* + +Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. + +--- + +**`preferred_code_length`** *Number* + +Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. + +--- + +**`starts_at`** *String* + +Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + +--- + +**`use_backup_access_code_pool`** *Boolean* + +Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). + +--- + +**`use_offline_access_code`** *Boolean* + +--- + + +## Return Type + +Array of [access\_codes](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of access_code +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md new file mode 100644 index 000000000..e28b26d59 --- /dev/null +++ b/docs/api/access_codes/delete.md @@ -0,0 +1,38 @@ +# Delete an Access Code + +Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +{% hint style="success" %} +``` +POST /access_codes/delete ⇒ void +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`access_code_id`** *String* (Required) + +ID of the access code to delete. + +--- + +**`device_id`** *String* + +ID of the device for which to delete the access code. + +--- + + +## Return Type + +void diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md new file mode 100644 index 000000000..e47a43f33 --- /dev/null +++ b/docs/api/access_codes/get.md @@ -0,0 +1,53 @@ +# Get an Access Code + +Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +You must specify either `access_code_id` or both `device_id` and `code`. + +{% hint style="success" %} +``` +POST /access_codes/get ⇒ { access_code } +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +
+ +## Parameters + +**`access_code_id`** *String* + +ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. + +--- + +**`code`** *String* + +Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. + +--- + +**`device_id`** *String* + +ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. + +--- + + +## Return Type + +[access\_code](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of access_code +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md new file mode 100644 index 000000000..f8b1666b5 --- /dev/null +++ b/docs/api/access_codes/list.md @@ -0,0 +1,55 @@ +# List Access Codes + +Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +Specify either `device_id` or `access_code_ids`. + +{% hint style="success" %} +``` +POST /access_codes/list ⇒ { access_codes: [access_code, …] } +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`access_code_ids`** *Array* *of UUIDs* + +IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. + +--- + +**`device_id`** *String* + +ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. + +--- + +**`user_identifier_key`** *String* + +Your user ID for the user by which to filter access codes. + +--- + + +## Return Type + +Array of [access\_codes](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of access_code +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md new file mode 100644 index 000000000..39a0898f3 --- /dev/null +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -0,0 +1,49 @@ +# Pull a Backup Access Code + +Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). + +A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. + +If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access. + +You can only pull backup access codes for time-bound access codes. + +Before pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code. + +{% hint style="success" %} +``` +POST /access_codes/pull_backup_access_code ⇒ { access_code } +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`access_code_id`** *String* (Required) + +ID of the access code for which you want to pull a backup access code. + +--- + + +## Return Type + +[access\_code](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of access_code +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/simulate/README.md b/docs/api/access_codes/simulate/README.md index 7f4e746e4..b41bd2cf6 100644 --- a/docs/api/access_codes/simulate/README.md +++ b/docs/api/access_codes/simulate/README.md @@ -6,3 +6,8 @@ The Access Code Simulations route contains the following resources: ## Endpoints +[**`/access_codes/simulate/create_unmanaged_access_code`**](./create_unmanaged_access_code.md) + +Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md new file mode 100644 index 000000000..81022b33b --- /dev/null +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -0,0 +1,53 @@ +# Simulate Creating an Unmanaged Access Code + +Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). + +{% hint style="success" %} +``` +POST /access_codes/simulate/create_unmanaged_access_code ⇒ { access_code } +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`code`** *String* (Required) + +Code of the simulated unmanaged access code. + +--- + +**`device_id`** *String* (Required) + +ID of the device for which you want to simulate the creation of an unmanaged access code. + +--- + +**`name`** *String* (Required) + +Name of the simulated unmanaged access code. + +--- + + +## Return Type + +[unmanaged\_access\_code](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of unmanaged_access_code +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md new file mode 100644 index 000000000..c077faa70 --- /dev/null +++ b/docs/api/access_codes/update.md @@ -0,0 +1,132 @@ +# Update an Access Code + +Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +See also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes). + +{% hint style="success" %} +``` +PUT /access_codes/update ⇒ void +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`access_code_id`** *String* (Required) + +ID of the access code that you want to update. + +--- + +**`allow_external_modification`** *Boolean* + +Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. + +--- + +**`attempt_for_offline_device`** *Boolean* + +--- + +**`code`** *String* + +Code to be used for access. + +--- + +**`device_id`** *String* + +ID of the device containing the access code that you want to update. + +--- + +**`ends_at`** *String* + +Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. + +--- + +**`is_external_modification_allowed`** *Boolean* + +Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. + +--- + +**`is_managed`** *Boolean* + +Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`. + +--- + +**`is_offline_access_code`** *Boolean* + +Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). + +--- + +**`is_one_time_use`** *Boolean* + +Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. + +--- + +**`max_time_rounding`** *String* + +Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. + +--- + +**`name`** *String* + +Name of the new access code. + +--- + +**`prefer_native_scheduling`** *Boolean* + +Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. + +--- + +**`preferred_code_length`** *Number* + +Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. + +--- + +**`starts_at`** *String* + +Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + +--- + +**`type`** *String* + +Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access). + +--- + +**`use_backup_access_code_pool`** *Boolean* + +Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). + +--- + +**`use_offline_access_code`** *Boolean* + +--- + + +## Return Type + +void diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md new file mode 100644 index 000000000..1b323196b --- /dev/null +++ b/docs/api/access_codes/update_multiple.md @@ -0,0 +1,54 @@ +# Update Multiple Linked Access Codes + +Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. + +Specify the `common_code_key` to identify the set of access codes that you want to update. + +See also [Update Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md#update-linked-access-codes). + +{% hint style="success" %} +``` +PATCH /access_codes/update_multiple ⇒ void +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`common_code_key`** *String* (Required) + +Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. + +--- + +**`ends_at`** *String* + +Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. + +--- + +**`name`** *String* + +Name of the new access code. + +--- + +**`starts_at`** *String* + +Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + +--- + + +## Return Type + +void diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 8b87364c9..33e7787c7 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -527,6 +527,61 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia +- occurred_at Datetime + + Date and time at which the event occurred. + + + +- workspace_id UUID + + ID of the [workspace](../../../core-concepts/workspaces/README.md). + + +
+ +--- + +**`acs_credential.invalidated`** + +An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was invalidated. + +
+ +Properties + +- acs_credential_id UUID + + + +- acs_system_id UUID + + ID of the [ACS system](https://docs.seam.co/latest/capability-guides/access-systems). + + + +- connected_account_id UUID + + ID of the [connected account](../../../core-concepts/connected-accounts/README.md). + + + +- created_at Datetime + + Date and time at which the event was created. + + + +- event_id UUID + + ID of the event. + + + +- event_type String + + + - occurred_at Datetime Date and time at which the event occurred. diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 7a3ad54e8..3b4d1384e 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -16,7 +16,9 @@ For details about the resources associated with an access control system, see th {% tab title="JSON" %} ```json { + acs_access_group_count: [example value], acs_system_id: [example value], + acs_user_count: [example value], can_add_acs_users_to_acs_access_groups: [example value], can_automate_enrollment: [example value], can_create_acs_access_groups: [example value], @@ -47,11 +49,21 @@ For details about the resources associated with an access control system, see th ## Properties +**`acs_access_group_count`** *Number* + + +--- + **`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). +--- + +**`acs_user_count`** *Number* + + --- **`can_add_acs_users_to_acs_access_groups`** *Boolean* @@ -284,7 +296,14 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains 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. This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md). - See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected). + See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). + +--- + +**`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). --- @@ -506,7 +525,6 @@ Returns a list of all [access control systems](https://docs.seam.co/latest/capab [**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md) -Returns a list of all credential manager ACS systems that are compatible with a specified -[access control system](https://docs.seam.co/latest/capability-guides/access-systems). +Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 5a441f3bb..da145f734 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -1,10 +1,8 @@ # List Compatible Credential Manager ACS Systems -Returns a list of all credential manager ACS systems that are compatible with a specified -[access control system](https://docs.seam.co/latest/capability-guides/access-systems). +Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). -Specify the ACS system for which you want to retrieve all compatible credential manager ACS -systems by including the corresponding `acs_system_id` in the request body. +Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. {% hint style="success" %} ``` diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index f612e7d76..3d682f217 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -44,7 +44,7 @@ Identifies the specific page of results to return, obtained from the previous pa **`search`** *String* -String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, or `email_address`. +String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. --- diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index f4d2c2ed4..69a10c9b8 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -70,41 +70,11 @@ Array of device types by which to filter devices. Enum values Possible enum values: -- `akuvox_lock` -- `august_lock` -- `brivo_access_point` -- `butterflymx_panel` -- `avigilon_alta_entry` -- `doorking_lock` -- `genie_door` -- `igloo_lock` -- `linear_lock` -- `lockly_lock` -- `kwikset_lock` -- `nuki_lock` -- `salto_lock` -- `schlage_lock` -- `seam_relay` -- `smartthings_lock` -- `wyze_lock` -- `yale_lock` -- `two_n_intercom` -- `controlbyweb_device` -- `ttlock_lock` -- `igloohome_lock` -- `hubitat_lock` -- `four_suites_door` -- `dormakaba_oracode_door` -- `tedee_lock` -- `akiles_lock` -- `noiseaware_activity_zone` -- `minut_sensor` - `ecobee_thermostat` - `nest_thermostat` - `honeywell_resideo_thermostat` - `tado_thermostat` -- `ios_phone` -- `android_phone` +- `sensi_thermostat`
--- diff --git a/package-lock.json b/package-lock.json index 7908cdbc4..20cdfa61d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-php": "^0.22.2", "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.38.0", - "@seamapi/types": "1.370.3", + "@seamapi/types": "1.377.0", "change-case": "^5.4.4", "command-exists": "^1.2.9", "del": "^8.0.0", @@ -781,9 +781,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.370.3", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.370.3.tgz", - "integrity": "sha512-GrSejH90rJzuyZgWgD7T5nh+MtRt0B5ggj2oBzqCAiuitSth/EjTDJ55AzEEtvPtpDRfaKacSzYe7ME2jHyV/g==", + "version": "1.377.0", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.377.0.tgz", + "integrity": "sha512-EOdujTToK8AxrMn7TSL3Ju4X+3GeHB8RsrF4M8w5aIGjyOzJzPcxOMJHlhfCzB+x5A6r3VA50FIOsB8U9KmFiw==", "license": "MIT", "engines": { "node": ">=18.12.0", From 3f8ecd2c79213ec21eed673b7c31d8d76b4339a0 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 7 Apr 2025 17:59:50 -0400 Subject: [PATCH 190/233] Update paths.yaml --- src/data/paths.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/data/paths.yaml b/src/data/paths.yaml index 07dbb79ff..f27f7831e 100644 --- a/src/data/paths.yaml +++ b/src/data/paths.yaml @@ -86,5 +86,10 @@ resources: - access_code +/access_codes/unmanaged: + title: Unmanaged Access Code + resources: + - unmanaged_access_code + /access_codes/simulate: title: Access Code Simulations From 539f6aa6338f3d8673d6f0056563cc9b4f7fee06 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Mon, 7 Apr 2025 22:01:19 +0000 Subject: [PATCH 191/233] ci: Generate docs --- docs/api/_report.md | 1 - docs/api/access_codes/unmanaged/README.md | 474 ++++++++++++++++++ .../unmanaged/convert_to_managed.md | 54 ++ docs/api/access_codes/unmanaged/delete.md | 32 ++ docs/api/access_codes/unmanaged/get.md | 55 ++ docs/api/access_codes/unmanaged/list.md | 47 ++ docs/api/access_codes/unmanaged/update.md | 54 ++ 7 files changed, 716 insertions(+), 1 deletion(-) create mode 100644 docs/api/access_codes/unmanaged/README.md create mode 100644 docs/api/access_codes/unmanaged/convert_to_managed.md create mode 100644 docs/api/access_codes/unmanaged/delete.md create mode 100644 docs/api/access_codes/unmanaged/get.md create mode 100644 docs/api/access_codes/unmanaged/list.md create mode 100644 docs/api/access_codes/unmanaged/update.md diff --git a/docs/api/_report.md b/docs/api/_report.md index e2549c3c6..cdc7453d1 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -4,7 +4,6 @@ ### Routes -- `/access_codes/unmanaged` - `/action_attempts` - `/bridges` - `/client_sessions` diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md new file mode 100644 index 000000000..da920c8e2 --- /dev/null +++ b/docs/api/access_codes/unmanaged/README.md @@ -0,0 +1,474 @@ +# Unmanaged Access Code + +The Unmanaged Access Code route contains the following resources: + +- [`unmanaged_access_code`](./#unmanaged_access_code) + +## The `unmanaged_access_code` Resource + +Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/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. + +When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes. + +Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. + +{% tabs %} +{% tab title="JSON" %} +```json +{ + access_code_id: [example value], + code: [example value], + created_at: [example value], + device_id: [example value], + ends_at: [example value], + errors: [example value], + is_managed: [example value], + name: [example value], + starts_at: [example value], + status: [example value], + type: [example value], + warnings: [example value] +} +``` +{% endtab %} +{% endtabs %} + +--- + +## Properties + +**`access_code_id`** *UUID* + +Unique identifier for the access code. + + +--- + +**`code`** *String* + +Code used for access. Typically, a numeric or alphanumeric string. + + +--- + +**`created_at`** *Datetime* + +Date and time at which the access code was created. + + +--- + +**`device_id`** *UUID* + +Unique identifier for the device associated with the access code. + + +--- + +**`ends_at`** *Datetime* + +Date and time after which the time-bound access code becomes inactive. + + +--- + +[**`errors`**](./#errors) *List* *of Objects* + +Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + +--- + +**`is_managed`** *Boolean* + +Indicates that Seam does not manage the access code. + + +--- + +**`name`** *String* + +Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. + + +--- + +**`starts_at`** *Datetime* + +Date and time at which the time-bound access code becomes active. + + +--- + +**`status`** *String* + +Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. + + +--- + +**`type`** *Enum* + +Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. + +
+ +Enum values + +- `time_bound` +- `ongoing` +
+ + +--- + +[**`warnings`**](./#warnings) *List* *of Objects* + +Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + +--- + + +## Errors + +**`smartthings_failed_to_set_access_code`** + +Failed to set code on SmartThings device. + +--- + +**`smartthings_failed_to_set_after_multiple_retries`** + +Failed to set code after multiple retries. + +--- + +**`smartthings_no_free_slots_available`** + +No free slots available on the device. + +--- + +**`failed_to_set_on_device`** + +Failed to set code on device. + +--- + +**`failed_to_remove_from_device`** + +Failed to remove code from device. + +--- + +**`duplicate_code_on_device`** + +Duplicate access code detected on device. + +--- + +**`duplicate_code_attempt_prevented`** + +An attempt to modify this access code was prevented. + +--- + +**`igloohome_bridge_too_many_pending_jobs`** + +Igloohome bridge has too many pending jobs in the queue. + +--- + +**`igloohome_bridge_offline`** + +Igloohome bridge is offline. + +--- + +**`igloohome_offline_access_code_no_variance_available`** + +Lock has reached maximum amount of codes. + +--- + +**`kwikset_unable_to_confirm_code`** + +Unable to confirm that the access code is set on Kwikset device. + +--- + +**`kwikset_unable_to_confirm_deletion`** + +Unable to confirm the deletion of the access code on Kwikset device. + +--- + +**`code_modified_external_to_seam`** + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +**`august_lock_invalid_code_length`** + +Invalid code length for August lock. + +--- + +**`august_device_programming_delay`** + +Access code has not yet been fully moved to the device. + +--- + +**`august_device_slots_full`** + +All access code slots on the device are full. + +--- + +**`august_lock_missing_keypad`** + +August lock is missing a keypad. + +--- + +**`august_lock_temporarily_offline`** + +August lock is temporarily offline. + +--- + +**`salto_ks_user_not_subscribed`** + +Salto site user is not subscribed. + +--- + +**`hubitat_device_programming_delay`** + +Access code has not yet been fully moved to the device. + +--- + +**`hubitat_no_free_positions_available`** + +No free positions available on the device. + +--- + +**`wyze_duplicate_code_name`** + +Duplicate access code name detected. + +--- + +**`wyze_potential_duplicate_code`** + +Potential duplicate access code detected. + +--- + +**`dormakaba_oracode_no_valid_user_level`** + +No valid user level for Oracode. + +--- + +**`account_disconnected`** + +Account is disconnected + +--- + +**`salto_ks_subscription_limit_exceeded`** + +Salto site user limit reached. + +--- + +**`device_offline`** + +Device is offline + +--- + +**`device_removed`** + +Device has been removed + +--- + +**`hub_disconnected`** + +Hub is disconnected + +--- + +**`device_disconnected`** + +Device is disconnected + +--- + +**`empty_backup_access_code_pool`** + +The backup access code pool is empty. + +--- + +**`august_lock_not_authorized`** + +User is not authorized to use the August Lock. + +--- + +**`august_lock_missing_bridge`** + +Lock is not connected to the Seam Bridge. + +--- + +**`ttlock_lock_not_paired_to_gateway`** + +Lock is not paired with a Gateway. + +--- + +**`missing_device_credentials`** + +Missing device credentials. + +--- + +**`auxiliary_heat_running`** + +The auxiliary heat is running. + +--- + +**`subscription_required`** + +Subscription required to connect. + +--- + +**`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). + +--- + + +## Warnings + +**`smartthings_failed_to_set_access_code`** + +Failed to set code on SmartThings device. + +--- + +**`schlage_detected_duplicate`** + +Duplicate access code detected. + +--- + +**`schlage_creation_outage`** + +Received an error when attempting to create this code. + +--- + +**`code_modified_external_to_seam`** + +Code was modified or removed externally after Seam successfully set it on the device. + +--- + +**`delay_in_setting_on_device`** + +Delay in setting code on device. + +--- + +**`delay_in_removing_from_device`** + +Delay in removing code from device. + +--- + +**`third_party_integration_detected`** + +Third-party integration detected that may cause access codes to fail. + +--- + +**`august_device_programming_delay`** + +Access code has not yet been fully moved to the device. + +--- + +**`august_lock_temporarily_offline`** + +August lock is temporarily offline. + +--- + +**`igloo_algopin_must_be_used_within_24_hours`** + +Algopins must be used within 24 hours. + +--- + +**`management_transferred`** + +Management was transferred to another workspace. + +--- + +**`kwikset_unable_to_confirm_code`** + +Unable to confirm that the access code is set on Kwikset device. + +--- + +## Endpoints + + +[**`/access_codes/unmanaged/convert_to_managed`**](./convert_to_managed.md) + +Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + +[**`/access_codes/unmanaged/delete`**](./delete.md) + +Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + + +[**`/access_codes/unmanaged/get`**](./get.md) + +Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + + +[**`/access_codes/unmanaged/list`**](./list.md) + +Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + + +[**`/access_codes/unmanaged/update`**](./update.md) + +Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + + diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md new file mode 100644 index 000000000..986a99024 --- /dev/null +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -0,0 +1,54 @@ +# Convert an Unmanaged Access Code + +Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + +An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it. + +Note that not all device providers support converting an unmanaged access code to a managed access code. + +{% hint style="success" %} +``` +PATCH /access_codes/unmanaged/convert_to_managed ⇒ void +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`access_code_id`** *String* (Required) + +ID of the unmanaged access code that you want to convert to a managed access code. + +--- + +**`allow_external_modification`** *Boolean* + +Indicates whether external modification of the access code is allowed. + +--- + +**`force`** *Boolean* + +Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. + +--- + +**`is_external_modification_allowed`** *Boolean* + +Indicates whether external modification of the access code is allowed. + +--- + + +## Return Type + +void diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md new file mode 100644 index 000000000..e88837319 --- /dev/null +++ b/docs/api/access_codes/unmanaged/delete.md @@ -0,0 +1,32 @@ +# Delete an Unmanaged Access Code + +Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + +{% hint style="success" %} +``` +POST /access_codes/unmanaged/delete ⇒ void +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`access_code_id`** *String* (Required) + +ID of the unmanaged access code to delete. + +--- + + +## Return Type + +void diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md new file mode 100644 index 000000000..459f0320d --- /dev/null +++ b/docs/api/access_codes/unmanaged/get.md @@ -0,0 +1,55 @@ +# Get an Unmanaged Access Code + +Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + +You must specify either `access_code_id` or both `device_id` and `code`. + +{% hint style="success" %} +``` +POST /access_codes/unmanaged/get ⇒ { access_code } +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`access_code_id`** *String* + +ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. + +--- + +**`code`** *String* + +Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. + +--- + +**`device_id`** *String* + +ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. + +--- + + +## Return Type + +[unmanaged\_access\_code](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of unmanaged_access_code +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md new file mode 100644 index 000000000..26d89e752 --- /dev/null +++ b/docs/api/access_codes/unmanaged/list.md @@ -0,0 +1,47 @@ +# List Unmanaged Access Codes + +Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + +{% hint style="success" %} +``` +POST /access_codes/unmanaged/list ⇒ { access_codes: [unmanaged_access_code, …] } +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`device_id`** *String* (Required) + +ID of the device for which you want to list unmanaged access codes. + +--- + +**`user_identifier_key`** *String* + +Your user ID for the user by which to filter unmanaged access codes. + +--- + + +## Return Type + +Array of [unmanaged\_access\_codes](./) +{% tabs %} +{% tab title="JSON" %} +```json +{ + JSON representation of unmanaged_access_code +} +``` +{% endtab %} +{% endtabs %} diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md new file mode 100644 index 000000000..929cc5e71 --- /dev/null +++ b/docs/api/access_codes/unmanaged/update.md @@ -0,0 +1,54 @@ +# Update an Unmanaged Access Code + +Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + +{% hint style="success" %} +``` +PATCH /access_codes/unmanaged/update ⇒ void +``` +{% endhint %} + +
+ +Authentication Methods + +- API key +- Client session token +- Personal access token +
Must also include the `seam-workspace` header in the request. +
+ +## Parameters + +**`access_code_id`** *String* (Required) + +ID of the unmanaged access code that you want to update. + +--- + +**`is_managed`** *Boolean* (Required) + +--- + +**`allow_external_modification`** *Boolean* + +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. + +--- + +**`force`** *Boolean* + +Indicates whether to force the unmanaged access code update. + +--- + +**`is_external_modification_allowed`** *Boolean* + +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. + +--- + + +## Return Type + +void From 59f12bceb0cf69ff8b4b1377413ba7f10cdb0d3c Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 22:06:57 -0400 Subject: [PATCH 192/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index b96bd981a..96d9a9c30 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -11,7 +11,7 @@ {{#if authMethods}}
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} {{#each authMethods}} - {{this}} @@ -22,7 +22,7 @@
{{/if}} -## Parameters +## Request Parameters {{#if request.parameters.length}} {{#each request.parameters}} @@ -48,7 +48,7 @@ None {{/if}} -## Return Type +## Response {{#if response.resourceType}}{{#if (eq response.responseType "resource_list")}}Array of [{{response.escapedResourceType}}s](./){{else}}[{{response.escapedResourceType}}](./){{/if}}{{else}}void{{/if}} {{#with response.actionAttempt}} From ab47612775b571f9d3cc4f3798f40dee441d1903 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 22:08:17 -0400 Subject: [PATCH 193/233] Update api-route.hbs --- src/layouts/api-route.hbs | 8 -------- 1 file changed, 8 deletions(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index efecacf7b..b9012d4e9 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -1,13 +1,5 @@ # {{title}} -The {{title}} route contains the following resources: - -{{#if resources.length}} -{{#each resources}} -- [`{{name}}`](./#{{name}}) -{{/each}} -{{/if}} - {{#each resources}} {{> api-resource }} {{#if errors.length}} From 5ca0b21f07cccf8b22d11d6c519169c8f4715ddc Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 02:09:17 +0000 Subject: [PATCH 194/233] ci: Generate docs --- docs/api/access_codes/README.md | 4 ---- docs/api/access_codes/create.md | 6 +++--- docs/api/access_codes/create_multiple.md | 6 +++--- docs/api/access_codes/delete.md | 6 +++--- docs/api/access_codes/get.md | 6 +++--- docs/api/access_codes/list.md | 6 +++--- docs/api/access_codes/pull_backup_access_code.md | 6 +++--- docs/api/access_codes/simulate/README.md | 3 --- .../access_codes/simulate/create_unmanaged_access_code.md | 6 +++--- docs/api/access_codes/unmanaged/README.md | 4 ---- docs/api/access_codes/unmanaged/convert_to_managed.md | 6 +++--- docs/api/access_codes/unmanaged/delete.md | 6 +++--- docs/api/access_codes/unmanaged/get.md | 6 +++--- docs/api/access_codes/unmanaged/list.md | 6 +++--- docs/api/access_codes/unmanaged/update.md | 6 +++--- docs/api/access_codes/update.md | 6 +++--- docs/api/access_codes/update_multiple.md | 6 +++--- docs/api/acs/access_groups/README.md | 4 ---- docs/api/acs/access_groups/add_user.md | 6 +++--- docs/api/acs/access_groups/get.md | 6 +++--- docs/api/acs/access_groups/list.md | 6 +++--- docs/api/acs/access_groups/list_accessible_entrances.md | 6 +++--- docs/api/acs/access_groups/list_users.md | 6 +++--- docs/api/acs/access_groups/remove_user.md | 6 +++--- docs/api/acs/credentials/README.md | 4 ---- docs/api/acs/credentials/assign.md | 6 +++--- docs/api/acs/credentials/create.md | 6 +++--- docs/api/acs/credentials/delete.md | 6 +++--- docs/api/acs/credentials/get.md | 6 +++--- docs/api/acs/credentials/list.md | 6 +++--- docs/api/acs/credentials/list_accessible_entrances.md | 6 +++--- docs/api/acs/credentials/unassign.md | 6 +++--- docs/api/acs/credentials/update.md | 6 +++--- docs/api/acs/encoders/README.md | 4 ---- docs/api/acs/encoders/encode_credential.md | 6 +++--- docs/api/acs/encoders/list.md | 6 +++--- docs/api/acs/encoders/scan_credential.md | 6 +++--- docs/api/acs/encoders/simulate/README.md | 3 --- .../encoders/simulate/next_credential_encode_will_fail.md | 6 +++--- .../simulate/next_credential_encode_will_succeed.md | 6 +++--- .../encoders/simulate/next_credential_scan_will_fail.md | 6 +++--- .../simulate/next_credential_scan_will_succeed.md | 6 +++--- docs/api/acs/entrances/README.md | 4 ---- docs/api/acs/entrances/get.md | 6 +++--- docs/api/acs/entrances/grant_access.md | 6 +++--- docs/api/acs/entrances/list.md | 6 +++--- docs/api/acs/entrances/list_credentials_with_access.md | 6 +++--- docs/api/acs/systems/README.md | 4 ---- docs/api/acs/systems/get.md | 6 +++--- docs/api/acs/systems/list.md | 6 +++--- .../list_compatible_credential_manager_acs_systems.md | 6 +++--- docs/api/acs/users/README.md | 4 ---- docs/api/acs/users/add_to_access_group.md | 6 +++--- docs/api/acs/users/create.md | 6 +++--- docs/api/acs/users/delete.md | 6 +++--- docs/api/acs/users/get.md | 6 +++--- docs/api/acs/users/list.md | 6 +++--- docs/api/acs/users/list_accessible_entrances.md | 6 +++--- docs/api/acs/users/remove_from_access_group.md | 6 +++--- docs/api/acs/users/revoke_access_to_all_entrances.md | 6 +++--- docs/api/acs/users/suspend.md | 6 +++--- docs/api/acs/users/unsuspend.md | 6 +++--- docs/api/acs/users/update.md | 6 +++--- docs/api/phones/README.md | 4 ---- docs/api/phones/deactivate.md | 6 +++--- docs/api/phones/get.md | 6 +++--- docs/api/phones/list.md | 8 ++++---- docs/api/phones/simulate/README.md | 3 --- docs/api/phones/simulate/create_sandbox_phone.md | 6 +++--- docs/api/thermostats/README.md | 3 --- docs/api/thermostats/activate_climate_preset.md | 6 +++--- docs/api/thermostats/cool.md | 6 +++--- docs/api/thermostats/create_climate_preset.md | 6 +++--- docs/api/thermostats/delete_climate_preset.md | 6 +++--- docs/api/thermostats/heat.md | 6 +++--- docs/api/thermostats/heat_cool.md | 6 +++--- docs/api/thermostats/list.md | 8 ++++---- docs/api/thermostats/off.md | 6 +++--- docs/api/thermostats/schedules/README.md | 4 ---- docs/api/thermostats/schedules/create.md | 6 +++--- docs/api/thermostats/schedules/delete.md | 6 +++--- docs/api/thermostats/schedules/get.md | 6 +++--- docs/api/thermostats/schedules/list.md | 6 +++--- docs/api/thermostats/schedules/update.md | 6 +++--- docs/api/thermostats/set_fallback_climate_preset.md | 6 +++--- docs/api/thermostats/set_fan_mode.md | 6 +++--- docs/api/thermostats/set_hvac_mode.md | 6 +++--- docs/api/thermostats/set_temperature_threshold.md | 6 +++--- docs/api/thermostats/simulate/README.md | 3 --- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 6 +++--- docs/api/thermostats/simulate/temperature_reached.md | 6 +++--- docs/api/thermostats/update_climate_preset.md | 6 +++--- docs/api/user_identities/README.md | 4 ---- docs/api/user_identities/add_acs_user.md | 6 +++--- docs/api/user_identities/create.md | 6 +++--- docs/api/user_identities/delete.md | 6 +++--- docs/api/user_identities/enrollment_automations/README.md | 4 ---- docs/api/user_identities/enrollment_automations/delete.md | 6 +++--- docs/api/user_identities/enrollment_automations/get.md | 6 +++--- docs/api/user_identities/enrollment_automations/launch.md | 6 +++--- docs/api/user_identities/enrollment_automations/list.md | 6 +++--- docs/api/user_identities/get.md | 6 +++--- docs/api/user_identities/grant_access_to_device.md | 6 +++--- docs/api/user_identities/list.md | 6 +++--- docs/api/user_identities/list_accessible_devices.md | 6 +++--- docs/api/user_identities/list_acs_systems.md | 6 +++--- docs/api/user_identities/list_acs_users.md | 6 +++--- docs/api/user_identities/remove_acs_user.md | 6 +++--- docs/api/user_identities/revoke_access_to_device.md | 6 +++--- docs/api/user_identities/update.md | 6 +++--- 110 files changed, 281 insertions(+), 344 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index cb4c2104f..f93ff24bf 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -1,9 +1,5 @@ # Access Codes -The Access Codes route contains the following resources: - -- [`access_code`](./#access_code) - ## The `access_code` Resource Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index e669299ee..7f046fd67 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -10,7 +10,7 @@ POST /access_codes/create ⇒ { access_code }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /access_codes/create ⇒ { access_code }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -113,7 +113,7 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest --- -## Return Type +## Response [access\_code](./) diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 4ae53a44f..3a755ffe8 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -18,7 +18,7 @@ PUT /access_codes/create_multiple ⇒ { access_codes: [access_code, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -26,7 +26,7 @@ PUT /access_codes/create_multiple ⇒ { access_codes: [access_code, …] }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_ids`** *Array* *of UUIDs* (Required) @@ -121,7 +121,7 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest --- -## Return Type +## Response Array of [access\_codes](./) {% tabs %} diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index e28b26d59..56c565405 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -10,7 +10,7 @@ POST /access_codes/delete ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /access_codes/delete ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`access_code_id`** *String* (Required) @@ -33,6 +33,6 @@ ID of the device for which to delete the access code. --- -## Return Type +## Response void diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index e47a43f33..b0494da77 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -12,13 +12,13 @@ POST /access_codes/get ⇒ { access_code }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token
-## Parameters +## Request Parameters **`access_code_id`** *String* @@ -39,7 +39,7 @@ ID of the device containing the access code that you want to get. You must speci --- -## Return Type +## Response [access\_code](./) {% tabs %} diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index f8b1666b5..36d2e1ec2 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -12,7 +12,7 @@ POST /access_codes/list ⇒ { access_codes: [access_code, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -20,7 +20,7 @@ POST /access_codes/list ⇒ { access_codes: [access_code, …] }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`access_code_ids`** *Array* *of UUIDs* @@ -41,7 +41,7 @@ Your user ID for the user by which to filter access codes. --- -## Return Type +## Response Array of [access\_codes](./) {% tabs %} diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 39a0898f3..2572bc19d 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -18,7 +18,7 @@ POST /access_codes/pull_backup_access_code ⇒ { access_code }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -26,7 +26,7 @@ POST /access_codes/pull_backup_access_code ⇒ { access_code }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`access_code_id`** *String* (Required) @@ -35,7 +35,7 @@ ID of the access code for which you want to pull a backup access code. --- -## Return Type +## Response [access\_code](./) {% tabs %} diff --git a/docs/api/access_codes/simulate/README.md b/docs/api/access_codes/simulate/README.md index b41bd2cf6..02bd1d359 100644 --- a/docs/api/access_codes/simulate/README.md +++ b/docs/api/access_codes/simulate/README.md @@ -1,8 +1,5 @@ # Access Code Simulations -The Access Code Simulations route contains the following resources: - - ## Endpoints diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index 81022b33b..09baab9f3 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -10,7 +10,7 @@ POST /access_codes/simulate/create_unmanaged_access_code ⇒ { access_code }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /access_codes/simulate/create_unmanaged_access_code ⇒ { access_code }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`code`** *String* (Required) @@ -39,7 +39,7 @@ Name of the simulated unmanaged access code. --- -## Return Type +## Response [unmanaged\_access\_code](./) {% tabs %} diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index da920c8e2..b2abd2443 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -1,9 +1,5 @@ # Unmanaged Access Code -The Unmanaged Access Code route contains the following resources: - -- [`unmanaged_access_code`](./#unmanaged_access_code) - ## The `unmanaged_access_code` Resource Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 986a99024..31539d8fc 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -14,7 +14,7 @@ PATCH /access_codes/unmanaged/convert_to_managed ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -22,7 +22,7 @@ PATCH /access_codes/unmanaged/convert_to_managed ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`access_code_id`** *String* (Required) @@ -49,6 +49,6 @@ Indicates whether external modification of the access code is allowed. --- -## Return Type +## Response void diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index e88837319..ec3831bce 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -10,7 +10,7 @@ POST /access_codes/unmanaged/delete ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /access_codes/unmanaged/delete ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`access_code_id`** *String* (Required) @@ -27,6 +27,6 @@ ID of the unmanaged access code to delete. --- -## Return Type +## Response void diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index 459f0320d..2f9280021 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -12,7 +12,7 @@ POST /access_codes/unmanaged/get ⇒ { access_code }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -20,7 +20,7 @@ POST /access_codes/unmanaged/get ⇒ { access_code }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`access_code_id`** *String* @@ -41,7 +41,7 @@ ID of the device containing the unmanaged access code that you want to get. You --- -## Return Type +## Response [unmanaged\_access\_code](./) {% tabs %} diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index 26d89e752..bc5468e99 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -10,7 +10,7 @@ POST /access_codes/unmanaged/list ⇒ { access_codes: [unmanaged_access_code,
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /access_codes/unmanaged/list ⇒ { access_codes: [unmanaged_access_code,
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -33,7 +33,7 @@ Your user ID for the user by which to filter unmanaged access codes. --- -## Return Type +## Response Array of [unmanaged\_access\_codes](./) {% tabs %} diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index 929cc5e71..d38dbe545 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -10,7 +10,7 @@ PATCH /access_codes/unmanaged/update ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ PATCH /access_codes/unmanaged/update ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`access_code_id`** *String* (Required) @@ -49,6 +49,6 @@ Indicates whether [external modification](https://docs.seam.co/latest/capability --- -## Return Type +## Response void diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index c077faa70..8b8d180a2 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -12,7 +12,7 @@ PUT /access_codes/update ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -20,7 +20,7 @@ PUT /access_codes/update ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`access_code_id`** *String* (Required) @@ -127,6 +127,6 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest --- -## Return Type +## Response void diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index 1b323196b..780ffb12d 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -14,7 +14,7 @@ PATCH /access_codes/update_multiple ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -22,7 +22,7 @@ PATCH /access_codes/update_multiple ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`common_code_key`** *String* (Required) @@ -49,6 +49,6 @@ Date and time at which the validity of the new access code starts, in [ISO 8601] --- -## Return Type +## Response void diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 4cc8a9f15..a27e8d9e0 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -1,9 +1,5 @@ # Access Groups -The Access Groups route contains the following resources: - -- [`acs_access_group`](./#acs_access_group) - ## The `acs_access_group` Resource 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. diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index b1da231e8..11032ebe6 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -10,14 +10,14 @@ PUT /acs/access_groups/add_user ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_access_group_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired user. --- -## Return Type +## Response void diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index b3ab80469..001f7cca9 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -10,14 +10,14 @@ POST /acs/access_groups/get ⇒ { acs_access_group }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_access_group_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the desired access group. --- -## Return Type +## Response [acs\_access\_group](./) {% tabs %} diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 1210df476..6f0a7b0ba 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -10,14 +10,14 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_system_id`** *String* @@ -32,7 +32,7 @@ ID of the user for which you want to retrieve all access groups. --- -## Return Type +## Response Array of [acs\_access\_groups](./) {% tabs %} diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 29dd2fd5a..e009539e7 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -10,14 +10,14 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_access_group_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the access group for which you want to retrieve all accessible entrances. --- -## Return Type +## Response Array of [acs\_entrances](./) {% tabs %} diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index eee336a8a..db96671f7 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -10,14 +10,14 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_access_group_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the access group for which you want to retrieve all users. --- -## Return Type +## Response Array of [acs\_users](./) {% tabs %} diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index dd587ec0e..52147bfb3 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -10,14 +10,14 @@ POST /acs/access_groups/remove_user ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_access_group_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired user. --- -## Return Type +## Response void diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 33e7787c7..c4e4fda41 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -1,9 +1,5 @@ # Credentials -The Credentials route contains the following resources: - -- [`acs_credential`](./#acs_credential) - ## The `acs_credential` Resource Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index c84be2aba..7c5fc33ab 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -10,14 +10,14 @@ PATCH /acs/credentials/assign ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_credential_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired user. --- -## Return Type +## Response void diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index b216d3b9d..26cfbd107 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -10,14 +10,14 @@ POST /acs/credentials/create ⇒ { acs_credential }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`access_method`** *String* (Required) @@ -86,7 +86,7 @@ Visionline-specific metadata for the new credential. --- -## Return Type +## Response [acs\_credential](./) {% tabs %} diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 5d7b511d4..ce83a8a9f 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -10,14 +10,14 @@ POST /acs/credentials/delete ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_credential_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the desired credential. --- -## Return Type +## Response void diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 451b7e8f2..953030990 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -10,14 +10,14 @@ POST /acs/credentials/get ⇒ { acs_credential }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_credential_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the desired credential. --- -## Return Type +## Response [acs\_credential](./) {% tabs %} diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index c827eb368..f7d658096 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -10,7 +10,7 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_system_id`** *String* @@ -57,7 +57,7 @@ ID of the user identity for which you want to retrieve all credentials. --- -## Return Type +## Response Array of [acs\_credentials](./) {% tabs %} diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 4ec9aba3c..8db8b9f7e 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -10,14 +10,14 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_credential_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the credential for which you want to retrieve all entrances to which this --- -## Return Type +## Response Array of [acs\_entrances](./) {% tabs %} diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 7bf3aa3ff..54a4ce823 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -10,14 +10,14 @@ PATCH /acs/credentials/unassign ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_credential_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired user. --- -## Return Type +## Response void diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 48e8fce25..cd788451a 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -10,14 +10,14 @@ PATCH /acs/credentials/update ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_credential_id`** *String* (Required) @@ -38,7 +38,7 @@ Replacement date and time at which the validity of the credential ends, in [ISO --- -## Return Type +## Response void diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 7a646c663..55d44e7dd 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -1,9 +1,5 @@ # Encoders -The Encoders route contains the following resources: - -- [`acs_encoder`](./#acs_encoder) - ## The `acs_encoder` Resource Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 40bf195dd..84e4203c5 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -10,14 +10,14 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_credential_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the `acs_encoder` to use to encode the `acs_credential`. --- -## Return Type +## Response [action\_attempt](./) diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index fb3ee74f9..e1ca8784b 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -10,14 +10,14 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_encoder_ids`** *Array* *of UUIDs* @@ -44,7 +44,7 @@ Number of `acs_encoders` to return. --- -## Return Type +## Response Array of [acs\_encoders](./) {% tabs %} diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 2135edfda..6b6056852 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -10,14 +10,14 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_encoder_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the `acs_encoder` to use for the scan. --- -## Return Type +## Response [action\_attempt](./) diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index 988f7da0f..91ad7fa2c 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -1,8 +1,5 @@ # Encoder Simulations -The Encoder Simulations route contains the following resources: - - ## Endpoints diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 12d161fc5..18890afb8 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -10,14 +10,14 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_encoder_id`** *String* (Required) @@ -38,6 +38,6 @@ Code of the error to simulate. --- -## Return Type +## Response void diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index afcbc5ed7..ffc0e0c25 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -10,14 +10,14 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_encoder_id`** *String* (Required) @@ -32,6 +32,6 @@ Scenario to simulate. --- -## Return Type +## Response void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 63c6e5b2d..39744681b 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -10,14 +10,14 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_encoder_id`** *String* (Required) @@ -34,6 +34,6 @@ ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next --- -## Return Type +## Response void diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 6968fd893..a2c1b37d5 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -10,14 +10,14 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_encoder_id`** *String* (Required) @@ -38,6 +38,6 @@ Scenario to simulate. --- -## Return Type +## Response void diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 72b7ed724..8fa6ae54d 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -1,9 +1,5 @@ # Entrances -The Entrances route contains the following resources: - -- [`acs_entrance`](./#acs_entrance) - ## The `acs_entrance` Resource Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 17c846eba..48fe31326 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -10,20 +10,20 @@ POST /acs/entrances/get ⇒ { acs_entrance }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token
-## Parameters +## Request Parameters **`acs_entrance_id`** *String* (Required) --- -## Return Type +## Response [acs\_entrance](./) {% tabs %} diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index af7db87a9..f8a80107f 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -10,14 +10,14 @@ POST /acs/entrances/grant_access ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_entrance_id`** *String* (Required) @@ -28,6 +28,6 @@ POST /acs/entrances/grant_access ⇒ void --- -## Return Type +## Response void diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index dec4f82d0..4497c499a 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -10,7 +10,7 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_credential_id`** *String* @@ -29,7 +29,7 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } --- -## Return Type +## Response Array of [acs\_entrances](./) {% tabs %} diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index fd6d8a7f0..e504d3f9c 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -10,7 +10,7 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_entrance_id`** *String* (Required) @@ -36,7 +36,7 @@ Possible enum values: --- -## Return Type +## Response Array of [acs\_credentials](./) {% tabs %} diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 3b4d1384e..315b06bcf 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -1,9 +1,5 @@ # Systems -The Systems route contains the following resources: - -- [`acs_system`](./#acs_system) - ## The `acs_system` Resource Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 97d44f27e..95a292438 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -12,14 +12,14 @@ POST /acs/systems/get ⇒ { acs_system }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_system_id`** *String* (Required) @@ -28,7 +28,7 @@ ID of the desired access control system. --- -## Return Type +## Response [acs\_system](./) {% tabs %} diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 4bbe447a6..6b61b8adf 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -12,7 +12,7 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -20,7 +20,7 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`connected_account_id`** *String* @@ -29,7 +29,7 @@ ID of the connected account by which to filter the list of returned access contr --- -## Return Type +## Response Array of [acs\_systems](./) {% tabs %} diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index da145f734..b83d3e20a 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -12,14 +12,14 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_system_id`** *String* (Required) @@ -28,7 +28,7 @@ ID of the ACS system for which you want to retrieve all compatible credential ma --- -## Return Type +## Response Array of [acs\_systems](./) {% tabs %} diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index a94abc26b..2100c9ca1 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -1,9 +1,5 @@ # ACS Users -The ACS Users route contains the following resources: - -- [`acs_user`](./#acs_user) - ## The `acs_user` Resource Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index b9958f1b6..b5b79ab7a 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -10,14 +10,14 @@ PUT /acs/users/add_to_access_group ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_access_group_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired `acs_user`. --- -## Return Type +## Response void diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index dac61d3ff..481953393 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -10,14 +10,14 @@ POST /acs/users/create ⇒ { acs_user }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_system_id`** *String* (Required) @@ -66,7 +66,7 @@ ID of the user identity with which to associate the new `acs_user`. --- -## Return Type +## Response [acs\_user](./) {% tabs %} diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 1bdd595fd..88298d791 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -10,14 +10,14 @@ POST /acs/users/delete ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_user_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the desired `acs_user`. --- -## Return Type +## Response void diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index f86a5e1ec..120975ea1 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -10,14 +10,14 @@ POST /acs/users/get ⇒ { acs_user }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_user_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the desired `acs_user`. --- -## Return Type +## Response [acs\_user](./) {% tabs %} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 3d682f217..87dd3803a 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -10,7 +10,7 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_system_id`** *String* @@ -67,7 +67,7 @@ Phone number of the user identity for which you want to retrieve all `acs_user`s --- -## Return Type +## Response Array of [acs\_users](./) {% tabs %} diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 059943aab..331ed6f0e 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -10,7 +10,7 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance,
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance,
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_user_id`** *String* (Required) @@ -27,7 +27,7 @@ ID of the desired `acs_user`. --- -## Return Type +## Response Array of [acs\_entrances](./) {% tabs %} diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index e9cb574a4..5dd8cb406 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -10,14 +10,14 @@ POST /acs/users/remove_from_access_group ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_access_group_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired `acs_user`. --- -## Return Type +## Response void diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 987364694..72e45d0ac 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -10,14 +10,14 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_user_id`** *String* (Required) @@ -26,6 +26,6 @@ ID of the desired `acs_user`. --- -## Return Type +## Response void diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 961f9c9a5..4d3a0b1b5 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -10,14 +10,14 @@ POST /acs/users/suspend ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_user_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the desired `acs_user`. --- -## Return Type +## Response void diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 88f7d9f71..0aae7e499 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -10,14 +10,14 @@ POST /acs/users/unsuspend ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_user_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the desired `acs_user`. --- -## Return Type +## Response void diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 02731bb83..fc86716f3 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -10,14 +10,14 @@ PATCH /acs/users/update ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_user_id`** *String* (Required) @@ -58,7 +58,7 @@ Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/acc --- -## Return Type +## Response void diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 275d1229e..ecd8fcad0 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -1,9 +1,5 @@ # Phones -The Phones route contains the following resources: - -- [`phone`](./#phone) - ## The `phone` Resource Represents an app user's mobile phone. diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index e995c05d0..a70562412 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -10,7 +10,7 @@ POST /phones/deactivate ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /phones/deactivate ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -27,6 +27,6 @@ Device ID of the desired phone. --- -## Return Type +## Response void diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 1401302a3..91af66588 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -10,14 +10,14 @@ POST /phones/get ⇒ { phone }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -26,7 +26,7 @@ Device ID of the desired phone. --- -## Return Type +## Response [phone](./) {% tabs %} diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 028de3f4a..7d0d910ce 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -10,18 +10,18 @@ POST /phones/list ⇒ { phones: [phone, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_credential_id`** *String* -ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. +ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones. --- @@ -32,7 +32,7 @@ ID of the user identity that represents the owner by which to filter the list of --- -## Return Type +## Response Array of [phones](./) {% tabs %} diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index f025bda7a..f40205492 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -1,8 +1,5 @@ # Phone Simulations -The Phone Simulations route contains the following resources: - - ## Endpoints diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 9588d53b7..373111019 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -10,14 +10,14 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`user_identity_id`** *String* (Required) @@ -44,7 +44,7 @@ Metadata to associate with the simulated phone. --- -## Return Type +## Response [phone](./) {% tabs %} diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index c7a28f5d9..ed509331e 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -1,8 +1,5 @@ # Thermostats -The Thermostats route contains the following resources: - - ## Endpoints diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index ec35d3659..4e88b8d7d 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -10,14 +10,14 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`climate_preset_key`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired thermostat device. --- -## Return Type +## Response [action\_attempt](./) diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index daee32130..4ea321103 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -10,7 +10,7 @@ POST /thermostats/cool ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/cool ⇒ { action_attempt }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -39,7 +39,7 @@ Desired [cooling set point](../../capability-guides/thermostats/understanding-th --- -## Return Type +## Response [action\_attempt](./) diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index e7a5cdcf0..478ba4cdd 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -10,7 +10,7 @@ POST /thermostats/create_climate_preset ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/create_climate_preset ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`climate_preset_key`** *String* (Required) @@ -81,7 +81,7 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- -## Return Type +## Response void diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 03b415807..ac0bd0551 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -10,7 +10,7 @@ POST /thermostats/delete_climate_preset ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/delete_climate_preset ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`climate_preset_key`** *String* (Required) @@ -33,7 +33,7 @@ ID of the desired thermostat device. --- -## Return Type +## Response void diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index fa1a71ee1..5ef09c8b0 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -10,7 +10,7 @@ POST /thermostats/heat ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/heat ⇒ { action_attempt }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -39,7 +39,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- -## Return Type +## Response [action\_attempt](./) diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 160878c1a..ead85e94b 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -10,7 +10,7 @@ POST /thermostats/heat_cool ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/heat_cool ⇒ { action_attempt }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -51,7 +51,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- -## Return Type +## Response [action\_attempt](./) diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 69a10c9b8..85d1965ab 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -10,7 +10,7 @@ POST /thermostats/list ⇒ { devices: [device, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/list ⇒ { devices: [device, …] }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`connect_webview_id`** *String* @@ -46,7 +46,7 @@ Date threshold for devices to return. If specified, returns only devices created **`custom_metadata_has`** *Object* -Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. +Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. --- @@ -98,7 +98,7 @@ Your own internal user ID for the user by which to filter devices. --- -## Return Type +## Response Array of [devices](./) {% tabs %} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index b076e900f..9f9a965c0 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -10,7 +10,7 @@ POST /thermostats/off ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/off ⇒ { action_attempt }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -27,7 +27,7 @@ ID of the desired thermostat device. --- -## Return Type +## Response [action\_attempt](./) diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index d56cac0e6..93268b942 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -1,9 +1,5 @@ # Thermostat Schedules -The Thermostat Schedules route contains the following resources: - -- [`thermostat_schedule`](./#thermostat_schedule) - ## The `thermostat_schedule` Resource Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 07a6bf768..68df8dcd5 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -10,7 +10,7 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`climate_preset_key`** *String* (Required) @@ -63,7 +63,7 @@ User-friendly name to identify the thermostat schedule. --- -## Return Type +## Response [thermostat\_schedule](./) {% tabs %} diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 1e2148256..246ff49da 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -10,7 +10,7 @@ POST /thermostats/schedules/delete ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/schedules/delete ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`thermostat_schedule_id`** *String* (Required) @@ -27,7 +27,7 @@ ID of the desired thermostat schedule. --- -## Return Type +## Response void diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 6f257b13a..87a8feace 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -10,7 +10,7 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`thermostat_schedule_id`** *String* (Required) @@ -27,7 +27,7 @@ ID of the desired thermostat schedule. --- -## Return Type +## Response [thermostat\_schedule](./) {% tabs %} diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 5d2cab178..f40cba246 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -10,7 +10,7 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -33,7 +33,7 @@ User identifier key by which to filter the list of returned thermostat schedules --- -## Return Type +## Response Array of [thermostat\_schedules](./) {% tabs %} diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index ead3f2020..e3346e4f6 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -10,7 +10,7 @@ PATCH /thermostats/schedules/update ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ PATCH /thermostats/schedules/update ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`thermostat_schedule_id`** *String* (Required) @@ -63,7 +63,7 @@ Date and time at which the thermostat schedule starts, in [ISO 8601](https://www --- -## Return Type +## Response void diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 7650e9f3b..71e7be444 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -10,14 +10,14 @@ POST /thermostats/set_fallback_climate_preset ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`climate_preset_key`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired thermostat device. --- -## Return Type +## Response void diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 397b72113..c93a0f8e6 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -10,7 +10,7 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -35,7 +35,7 @@ Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermos --- -## Return Type +## Response [action\_attempt](./) diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 4490780d5..7168d105e 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -10,7 +10,7 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -55,7 +55,7 @@ Desired [heating set point](../../capability-guides/thermostats/understanding-th --- -## Return Type +## Response [action\_attempt](./) diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 08c081e51..6bdf19953 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -10,14 +10,14 @@ PATCH /thermostats/set_temperature_threshold ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -50,7 +50,7 @@ Upper temperature limit in in °C. Seam alerts you if the reported temperature i --- -## Return Type +## Response void diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index b785755d5..b05e76fe5 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -1,8 +1,5 @@ # Thermostat Simulations -The Thermostat Simulations route contains the following resources: - - ## Endpoints diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index f751cffa0..f5ac112d1 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -10,14 +10,14 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -56,6 +56,6 @@ Desired simulated heating [set point](../../../capability-guides/thermostats/und --- -## Return Type +## Response void diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index d025e277d..8b85f7ae4 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -10,14 +10,14 @@ POST /thermostats/simulate/temperature_reached ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -38,6 +38,6 @@ Desired simulated temperature in °F. You must set `temperature_fahrenheit` or ` --- -## Return Type +## Response void diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 913509d19..8c932862b 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -10,7 +10,7 @@ PATCH /thermostats/update_climate_preset ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ PATCH /thermostats/update_climate_preset ⇒ void
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`climate_preset_key`** *String* (Required) @@ -81,7 +81,7 @@ User-friendly name to identify the [climate preset](../../capability-guides/ther --- -## Return Type +## Response void diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index d83a3df5f..07581d70e 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -1,9 +1,5 @@ # User Identities -The User Identities route contains the following resources: - -- [`user_identity`](./#user_identity) - ## The `user_identity` Resource Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 0fb60b436..c7d00df74 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -10,14 +10,14 @@ PUT /user_identities/add_acs_user ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_user_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired user identity. --- -## Return Type +## Response void diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 1b39ad0bc..c6c2e5877 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -10,14 +10,14 @@ POST /user_identities/create ⇒ { user_identity }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`email_address`** *String* @@ -44,7 +44,7 @@ Unique key for the user identity. --- -## Return Type +## Response [user\_identity](./) {% tabs %} diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index f201c15bc..7e7853661 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -10,14 +10,14 @@ POST /user_identities/delete ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`user_identity_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the desired user identity. --- -## Return Type +## Response void diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 036202043..24c7d68fe 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -1,9 +1,5 @@ # Enrollment Automations -The Enrollment Automations route contains the following resources: - -- [`enrollment_automation`](./#enrollment_automation) - ## The `enrollment_automation` Resource Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 97fa90d6e..8dbc6e677 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -10,14 +10,14 @@ POST /user_identities/enrollment_automations/delete ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`enrollment_automation_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the desired enrollment automation. --- -## Return Type +## Response void diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index bae4ee8b5..b5baf4397 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -10,7 +10,7 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`enrollment_automation_id`** *String* (Required) @@ -27,7 +27,7 @@ ID of the desired enrollment automation. --- -## Return Type +## Response [enrollment\_automation](./) {% tabs %} diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index f9a037759..2e02b3143 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -10,14 +10,14 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`credential_manager_acs_system_id`** *String* (Required) @@ -50,7 +50,7 @@ ID of the associated ACS user within the credential manager. If you specify a `c --- -## Return Type +## Response [unknown](./) {% tabs %} diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 7ceb091b3..ad31295cc 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -10,7 +10,7 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations:
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations:
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`user_identity_id`** *String* (Required) @@ -27,7 +27,7 @@ ID of the user identity for which you want to retrieve all enrollment automation --- -## Return Type +## Response Array of [enrollment\_automations](./) {% tabs %} diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 029956afb..bca89650b 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -10,14 +10,14 @@ POST /user_identities/get ⇒ { user_identity }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`user_identity_id`** *String* @@ -30,7 +30,7 @@ ID of the desired user identity. --- -## Return Type +## Response [user\_identity](./) {% tabs %} diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 880f602e8..f5f8692d8 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -10,14 +10,14 @@ PUT /user_identities/grant_access_to_device ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired user identity. --- -## Return Type +## Response void diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 1b563607d..c132c6d13 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -10,7 +10,7 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,14 +18,14 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`credential_manager_acs_system_id`** *String* --- -## Return Type +## Response Array of [user\_identitys](./) {% tabs %} diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index e1d85dfca..61553ab7a 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -10,14 +10,14 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`user_identity_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the user identity for which you want to retrieve all accessible devices. --- -## Return Type +## Response Array of [devices](./) {% tabs %} diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index df7000f7e..f17c19c9e 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -10,7 +10,7 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Client session token @@ -18,7 +18,7 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] }
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`user_identity_id`** *String* (Required) @@ -27,7 +27,7 @@ ID of the user identity for which you want to retrieve all access control system --- -## Return Type +## Response Array of [acs\_systems](./) {% tabs %} diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index ef32c2048..987fd3c16 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -10,14 +10,14 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] }
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`user_identity_id`** *String* (Required) @@ -26,7 +26,7 @@ ID of the user identity for which you want to retrieve all ACS users. --- -## Return Type +## Response Array of [acs\_users](./) {% tabs %} diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index aa8c58f99..7fa26db2e 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -10,14 +10,14 @@ POST /user_identities/remove_acs_user ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`acs_user_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired user identity. --- -## Return Type +## Response void diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 1dbf79762..5a68d654a 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -10,14 +10,14 @@ POST /user_identities/revoke_access_to_device ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`device_id`** *String* (Required) @@ -32,7 +32,7 @@ ID of the desired user identity. --- -## Return Type +## Response void diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index d4c4ae0ee..5608497f0 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -10,14 +10,14 @@ PATCH /user_identities/update ⇒ void
-Authentication Methods +[Authentication Methods]{https://docs.seam.co/latest/api/authentication} - API key - Personal access token
Must also include the `seam-workspace` header in the request.
-## Parameters +## Request Parameters **`user_identity_id`** *String* (Required) @@ -48,6 +48,6 @@ Unique key for the user identity. --- -## Return Type +## Response void From 2bd99e1c4175a8752419ea63833472868b76ba99 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 22:18:06 -0400 Subject: [PATCH 195/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index c3358393b..5d829d423 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -1,8 +1,15 @@ {{#if headingOffset}} -### The `{{name}}` Resource +### The {{name}} Object {{else}} -## The `{{name}}` Resource +## The {{name}} Object {{/if}} + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + {{#if description}} {{description}} From d958d02e1e550c2dc3936feeeb260871914932b0 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 02:19:17 +0000 Subject: [PATCH 196/233] ci: Generate docs --- docs/api/access_codes/README.md | 9 ++++++++- docs/api/access_codes/unmanaged/README.md | 9 ++++++++- docs/api/acs/access_groups/README.md | 9 ++++++++- docs/api/acs/credentials/README.md | 9 ++++++++- docs/api/acs/encoders/README.md | 9 ++++++++- docs/api/acs/entrances/README.md | 9 ++++++++- docs/api/acs/systems/README.md | 9 ++++++++- docs/api/acs/users/README.md | 9 ++++++++- docs/api/phones/README.md | 9 ++++++++- docs/api/thermostats/schedules/README.md | 9 ++++++++- docs/api/user_identities/README.md | 9 ++++++++- .../api/user_identities/enrollment_automations/README.md | 9 ++++++++- 12 files changed, 96 insertions(+), 12 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index f93ff24bf..7ee0fe7f6 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -1,6 +1,13 @@ # Access Codes -## The `access_code` Resource +## The access_code Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index b2abd2443..b225bb5b3 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -1,6 +1,13 @@ # Unmanaged Access Code -## The `unmanaged_access_code` Resource +## The unmanaged_access_code Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index a27e8d9e0..3254596c2 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -1,6 +1,13 @@ # Access Groups -## The `acs_access_group` Resource +## The acs_access_group Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + 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. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index c4e4fda41..5dd241a56 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -1,6 +1,13 @@ # Credentials -## The `acs_credential` Resource +## The acs_credential Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 55d44e7dd..eaac7cff0 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -1,6 +1,13 @@ # Encoders -## The `acs_encoder` Resource +## The acs_encoder Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 8fa6ae54d..b40939df5 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -1,6 +1,13 @@ # Entrances -## The `acs_entrance` Resource +## The acs_entrance Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 315b06bcf..ab0587557 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -1,6 +1,13 @@ # Systems -## The `acs_system` Resource +## The acs_system Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 2100c9ca1..9da26a0f4 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -1,6 +1,13 @@ # ACS Users -## The `acs_user` Resource +## The acs_user Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index ecd8fcad0..7d3d20318 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -1,6 +1,13 @@ # Phones -## The `phone` Resource +## The phone Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents an app user's mobile phone. diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 93268b942..c9138a0df 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -1,6 +1,13 @@ # Thermostat Schedules -## The `thermostat_schedule` Resource +## The thermostat_schedule Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 07581d70e..808777071 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -1,6 +1,13 @@ # User Identities -## The `user_identity` Resource +## The user_identity Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 24c7d68fe..088cc75a6 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -1,6 +1,13 @@ # Enrollment Automations -## The `enrollment_automation` Resource +## The enrollment_automation Object + +- [Properties](./#Properties) +- [Errors](./#Errors) +- [Warnings](./#Warnings) +- [Events](./#Events) +- [Endpoints](./#Endpoints) + Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). From b9643517e001484b885791f036f822924cb08798 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 22:19:53 -0400 Subject: [PATCH 197/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 96d9a9c30..e452d335d 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -1,5 +1,9 @@ # {{title}} +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + {{{description}}} {% hint style="success" %} From acae7fe9c737a5335e4fef74adeef9e27b13696b Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 22:20:24 -0400 Subject: [PATCH 198/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 5d829d423..43e4b63dc 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -4,11 +4,11 @@ ## The {{name}} Object {{/if}} -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) {{#if description}} From 91737a002ff8a9f937a7e4d2a6d823b82226dfab Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 02:21:30 +0000 Subject: [PATCH 199/233] ci: Generate docs --- docs/api/access_codes/README.md | 10 +++++----- docs/api/access_codes/create.md | 4 ++++ docs/api/access_codes/create_multiple.md | 4 ++++ docs/api/access_codes/delete.md | 4 ++++ docs/api/access_codes/get.md | 4 ++++ docs/api/access_codes/list.md | 4 ++++ docs/api/access_codes/pull_backup_access_code.md | 4 ++++ .../simulate/create_unmanaged_access_code.md | 4 ++++ docs/api/access_codes/unmanaged/README.md | 10 +++++----- docs/api/access_codes/unmanaged/convert_to_managed.md | 4 ++++ docs/api/access_codes/unmanaged/delete.md | 4 ++++ docs/api/access_codes/unmanaged/get.md | 4 ++++ docs/api/access_codes/unmanaged/list.md | 4 ++++ docs/api/access_codes/unmanaged/update.md | 4 ++++ docs/api/access_codes/update.md | 4 ++++ docs/api/access_codes/update_multiple.md | 4 ++++ docs/api/acs/access_groups/README.md | 10 +++++----- docs/api/acs/access_groups/add_user.md | 4 ++++ docs/api/acs/access_groups/get.md | 4 ++++ docs/api/acs/access_groups/list.md | 4 ++++ .../api/acs/access_groups/list_accessible_entrances.md | 4 ++++ docs/api/acs/access_groups/list_users.md | 4 ++++ docs/api/acs/access_groups/remove_user.md | 4 ++++ docs/api/acs/credentials/README.md | 10 +++++----- docs/api/acs/credentials/assign.md | 4 ++++ docs/api/acs/credentials/create.md | 4 ++++ docs/api/acs/credentials/delete.md | 4 ++++ docs/api/acs/credentials/get.md | 4 ++++ docs/api/acs/credentials/list.md | 4 ++++ docs/api/acs/credentials/list_accessible_entrances.md | 4 ++++ docs/api/acs/credentials/unassign.md | 4 ++++ docs/api/acs/credentials/update.md | 4 ++++ docs/api/acs/encoders/README.md | 10 +++++----- docs/api/acs/encoders/encode_credential.md | 4 ++++ docs/api/acs/encoders/list.md | 4 ++++ docs/api/acs/encoders/scan_credential.md | 4 ++++ .../simulate/next_credential_encode_will_fail.md | 4 ++++ .../simulate/next_credential_encode_will_succeed.md | 4 ++++ .../simulate/next_credential_scan_will_fail.md | 4 ++++ .../simulate/next_credential_scan_will_succeed.md | 4 ++++ docs/api/acs/entrances/README.md | 10 +++++----- docs/api/acs/entrances/get.md | 4 ++++ docs/api/acs/entrances/grant_access.md | 4 ++++ docs/api/acs/entrances/list.md | 4 ++++ docs/api/acs/entrances/list_credentials_with_access.md | 4 ++++ docs/api/acs/systems/README.md | 10 +++++----- docs/api/acs/systems/get.md | 4 ++++ docs/api/acs/systems/list.md | 4 ++++ .../list_compatible_credential_manager_acs_systems.md | 4 ++++ docs/api/acs/users/README.md | 10 +++++----- docs/api/acs/users/add_to_access_group.md | 4 ++++ docs/api/acs/users/create.md | 4 ++++ docs/api/acs/users/delete.md | 4 ++++ docs/api/acs/users/get.md | 4 ++++ docs/api/acs/users/list.md | 4 ++++ docs/api/acs/users/list_accessible_entrances.md | 4 ++++ docs/api/acs/users/remove_from_access_group.md | 4 ++++ docs/api/acs/users/revoke_access_to_all_entrances.md | 4 ++++ docs/api/acs/users/suspend.md | 4 ++++ docs/api/acs/users/unsuspend.md | 4 ++++ docs/api/acs/users/update.md | 4 ++++ docs/api/phones/README.md | 10 +++++----- docs/api/phones/deactivate.md | 4 ++++ docs/api/phones/get.md | 4 ++++ docs/api/phones/list.md | 4 ++++ docs/api/phones/simulate/create_sandbox_phone.md | 4 ++++ docs/api/thermostats/activate_climate_preset.md | 4 ++++ docs/api/thermostats/cool.md | 4 ++++ docs/api/thermostats/create_climate_preset.md | 4 ++++ docs/api/thermostats/delete_climate_preset.md | 4 ++++ docs/api/thermostats/heat.md | 4 ++++ docs/api/thermostats/heat_cool.md | 4 ++++ docs/api/thermostats/list.md | 4 ++++ docs/api/thermostats/off.md | 4 ++++ docs/api/thermostats/schedules/README.md | 10 +++++----- docs/api/thermostats/schedules/create.md | 4 ++++ docs/api/thermostats/schedules/delete.md | 4 ++++ docs/api/thermostats/schedules/get.md | 4 ++++ docs/api/thermostats/schedules/list.md | 4 ++++ docs/api/thermostats/schedules/update.md | 4 ++++ docs/api/thermostats/set_fallback_climate_preset.md | 4 ++++ docs/api/thermostats/set_fan_mode.md | 4 ++++ docs/api/thermostats/set_hvac_mode.md | 4 ++++ docs/api/thermostats/set_temperature_threshold.md | 4 ++++ docs/api/thermostats/simulate/hvac_mode_adjusted.md | 4 ++++ docs/api/thermostats/simulate/temperature_reached.md | 4 ++++ docs/api/thermostats/update_climate_preset.md | 4 ++++ docs/api/user_identities/README.md | 10 +++++----- docs/api/user_identities/add_acs_user.md | 4 ++++ docs/api/user_identities/create.md | 4 ++++ docs/api/user_identities/delete.md | 4 ++++ .../user_identities/enrollment_automations/README.md | 10 +++++----- .../user_identities/enrollment_automations/delete.md | 4 ++++ docs/api/user_identities/enrollment_automations/get.md | 4 ++++ .../user_identities/enrollment_automations/launch.md | 4 ++++ .../api/user_identities/enrollment_automations/list.md | 4 ++++ docs/api/user_identities/get.md | 4 ++++ docs/api/user_identities/grant_access_to_device.md | 4 ++++ docs/api/user_identities/list.md | 4 ++++ docs/api/user_identities/list_accessible_devices.md | 4 ++++ docs/api/user_identities/list_acs_systems.md | 4 ++++ docs/api/user_identities/list_acs_users.md | 4 ++++ docs/api/user_identities/remove_acs_user.md | 4 ++++ docs/api/user_identities/revoke_access_to_device.md | 4 ++++ docs/api/user_identities/update.md | 4 ++++ 105 files changed, 432 insertions(+), 60 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 7ee0fe7f6..9bfc9a9a8 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -2,11 +2,11 @@ ## The access_code Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index 7f046fd67..75c968089 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -1,5 +1,9 @@ # Create an Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). {% hint style="success" %} diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 3a755ffe8..b17be2cdd 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -1,5 +1,9 @@ # Create Multiple Linked Access Codes +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock. diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index 56c565405..91a8afa99 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -1,5 +1,9 @@ # Delete an Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). {% hint style="success" %} diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index b0494da77..9f8a8bc4e 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -1,5 +1,9 @@ # Get an Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). You must specify either `access_code_id` or both `device_id` and `code`. diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 36d2e1ec2..63cceafbf 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -1,5 +1,9 @@ # List Access Codes +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). Specify either `device_id` or `access_code_ids`. diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 2572bc19d..7e893471f 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -1,5 +1,9 @@ # Pull a Backup Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index 09baab9f3..cfb381334 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -1,5 +1,9 @@ # Simulate Creating an Unmanaged Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). {% hint style="success" %} diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index b225bb5b3..5a0b3c009 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -2,11 +2,11 @@ ## The unmanaged_access_code Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 31539d8fc..d2cbadc19 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -1,5 +1,9 @@ # Convert an Unmanaged Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it. diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index ec3831bce..76fc64bd0 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -1,5 +1,9 @@ # Delete an Unmanaged Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). {% hint style="success" %} diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index 2f9280021..d7e4340bc 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -1,5 +1,9 @@ # Get an Unmanaged Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). You must specify either `access_code_id` or both `device_id` and `code`. diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index bc5468e99..24579999c 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -1,5 +1,9 @@ # List Unmanaged Access Codes +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). {% hint style="success" %} diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index d38dbe545..f77ab5ecc 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -1,5 +1,9 @@ # Update an Unmanaged Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). {% hint style="success" %} diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index 8b8d180a2..c28cbb96d 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -1,5 +1,9 @@ # Update an Access Code +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes). diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index 780ffb12d..2c445aa34 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -1,5 +1,9 @@ # Update Multiple Linked Access Codes +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. Specify the `common_code_key` to identify the set of access codes that you want to update. diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 3254596c2..5577680b8 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -2,11 +2,11 @@ ## The acs_access_group Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) 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. diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 11032ebe6..bfef2cb81 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -1,5 +1,9 @@ # Add an ACS User to an Access Group +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% hint style="success" %} diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 001f7cca9..1ee1cd8d8 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -1,5 +1,9 @@ # Get an Access Group +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% hint style="success" %} diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 6f0a7b0ba..a003e034d 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -1,5 +1,9 @@ # List Access Groups +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% hint style="success" %} diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index e009539e7..4f7fafe9a 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -1,5 +1,9 @@ # List Entrances Accessible to an Access Group +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% hint style="success" %} diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index db96671f7..f06f3f1ad 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -1,5 +1,9 @@ # List ACS Users in an Access Group +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% hint style="success" %} diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 52147bfb3..f77f10e03 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -1,5 +1,9 @@ # Remove an ACS User from an Access Group +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% hint style="success" %} diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 5dd241a56..8e9c4cc27 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -2,11 +2,11 @@ ## The acs_credential Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). The `acs_credential` object represents a [credential](../../../capability-guides/access-systems/managing-credentials.md) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 7c5fc33ab..dc48f0201 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -1,5 +1,9 @@ # Assign a Credential to an ACS User +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% hint style="success" %} diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 26cfbd107..3ca683d70 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -1,5 +1,9 @@ # Create a Credential for an ACS User +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% hint style="success" %} diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index ce83a8a9f..dcc815976 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -1,5 +1,9 @@ # Delete a Credential +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). {% hint style="success" %} diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 953030990..a3c6713db 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -1,5 +1,9 @@ # Get a Credential +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). {% hint style="success" %} diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index f7d658096..41a9f3ced 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -1,5 +1,9 @@ # List Credentials +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). {% hint style="success" %} diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 8db8b9f7e..977ef4c07 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -1,5 +1,9 @@ # List Accessible Entrances +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. {% hint style="success" %} diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 54a4ce823..286bc9663 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -1,5 +1,9 @@ # Unassign a Credential from an ACS User +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% hint style="success" %} diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index cd788451a..02d4a3b48 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -1,5 +1,9 @@ # Update a Credential +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). {% hint style="success" %} diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index eaac7cff0..04e45bbc1 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -2,11 +2,11 @@ ## The acs_encoder Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents a hardware device that encodes [credential](../../../capability-guides/access-systems/managing-credentials.md) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 84e4203c5..0e90df8fe 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -1,5 +1,9 @@ # Encode a Credential +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). {% hint style="success" %} diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index e1ca8784b..cd4f4feeb 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -1,5 +1,9 @@ # List Encoders +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). {% hint style="success" %} diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 6b6056852..5937dce6d 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -1,5 +1,9 @@ # Scan a Credential +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). {% hint style="success" %} diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 18890afb8..abe2f24f5 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -1,5 +1,9 @@ # Simulate that the Next Credential Encoding Will Fail +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). {% hint style="success" %} diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index ffc0e0c25..27de96339 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -1,5 +1,9 @@ # Simulate that the Next Credential Encoding Will Succeed +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). {% hint style="success" %} diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 39744681b..dc990dac8 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -1,5 +1,9 @@ # Simulate that the Next Credential Scan Will Fail +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). {% hint style="success" %} diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index a2c1b37d5..a7730580f 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -1,5 +1,9 @@ # Simulate that the Next Credential Scan Will Succeed +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). {% hint style="success" %} diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index b40939df5..61dab062b 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -2,11 +2,11 @@ ## The acs_entrance Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents an [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 48fe31326..afd887ccc 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -1,5 +1,9 @@ # Get an Entrance +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% hint style="success" %} diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index f8a80107f..9055e72a4 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -1,5 +1,9 @@ # Grant an ACS User Access to an Entrance +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + {% hint style="success" %} diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 4497c499a..cacb8641e 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -1,5 +1,9 @@ # List Entrances +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% hint style="success" %} diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index e504d3f9c..f6883c876 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -1,5 +1,9 @@ # List Credentials with Access to an Entrance +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). {% hint style="success" %} diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index ab0587557..bce9c2a0e 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -2,11 +2,11 @@ ## The acs_system Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 95a292438..bfa5678ed 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -1,5 +1,9 @@ # Get an ACS System +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). Specify the desired access control system by including the corresponding `acs_system_id` in the request body. diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 6b61b8adf..428cfc369 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -1,5 +1,9 @@ # List ACS Systems +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). To filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index b83d3e20a..77370833d 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -1,5 +1,9 @@ # List Compatible Credential Manager ACS Systems +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 9da26a0f4..8c7c5cc6b 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -2,11 +2,11 @@ ## The acs_user Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index b5b79ab7a..4fa4640a0 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -1,5 +1,9 @@ # Add an ACS User to an Access Group +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% hint style="success" %} diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 481953393..cbda5546b 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -1,5 +1,9 @@ # Create an ACS User +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% hint style="success" %} diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 88298d791..4adc345ef 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -1,5 +1,9 @@ # Delete an ACS User +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). {% hint style="success" %} diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 120975ea1..b2b935ce4 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -1,5 +1,9 @@ # Get an ACS User +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% hint style="success" %} diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 87dd3803a..67ed974f9 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -1,5 +1,9 @@ # List ACS Users +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% hint style="success" %} diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 331ed6f0e..6e10144e7 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -1,5 +1,9 @@ # List ACS User-Accessible Entrances +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. {% hint style="success" %} diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 5dd8cb406..8d3f7b221 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -1,5 +1,9 @@ # Remove an ACS User from an Access Group +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). {% hint style="success" %} diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 72e45d0ac..230c79d1d 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -1,5 +1,9 @@ # Revoke ACS User Access to All Entrances +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% hint style="success" %} diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 4d3a0b1b5..647940a7f 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -1,5 +1,9 @@ # Suspend an ACS User +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. {% hint style="success" %} diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 0aae7e499..7d84c1b1e 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -1,5 +1,9 @@ # Unsuspend an ACS User +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. {% hint style="success" %} diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index fc86716f3..61b92786b 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -1,5 +1,9 @@ # Update an ACS User +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). {% hint style="success" %} diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 7d3d20318..dddb2f04d 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -2,11 +2,11 @@ ## The phone Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents an app user's mobile phone. diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index a70562412..fe1d63784 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -1,5 +1,9 @@ # Deactivate a Phone +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). {% hint style="success" %} diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 91af66588..4d24484fa 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -1,5 +1,9 @@ # Get Phone +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a single phone entry matching the provided `device_id`. {% hint style="success" %} diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 7d0d910ce..9f162ab56 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -1,5 +1,9 @@ # List Phones +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. {% hint style="success" %} diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 373111019..81d34168c 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -1,5 +1,9 @@ # Create a Sandbox Phone +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). {% hint style="success" %} diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 4e88b8d7d..54436d3ea 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -1,5 +1,9 @@ # Activate a Climate Preset +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 4ea321103..83559ff2e 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -1,5 +1,9 @@ # Set to Cool Mode +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% hint style="success" %} diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 478ba4cdd..224701358 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -1,5 +1,9 @@ # Create a Climate Preset +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index ac0bd0551..53591113c 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -1,5 +1,9 @@ # Delete a Climate Preset +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 5ef09c8b0..de7b5ba2e 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -1,5 +1,9 @@ # Set to Heat Mode +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% hint style="success" %} diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index ead85e94b..fa95ea143 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -1,5 +1,9 @@ # Set to Heat-Cool (Auto) Mode +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% hint style="success" %} diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 85d1965ab..28e58c68b 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -1,5 +1,9 @@ # List Thermostats +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 9f9a965c0..58e1c47a4 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -1,5 +1,9 @@ # Set to Off Mode +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). {% hint style="success" %} diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index c9138a0df..2a4eecb28 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -2,11 +2,11 @@ ## The thermostat_schedule Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) 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. diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 68df8dcd5..b7b640322 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -1,5 +1,9 @@ # Create a Thermostat Schedule +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 246ff49da..bfb5793f0 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -1,5 +1,9 @@ # Delete a Thermostat Schedule +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 87a8feace..68fbd4c19 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -1,5 +1,9 @@ # Get a Thermostat Schedule +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). {% hint style="success" %} diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index f40cba246..c1e31a047 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -1,5 +1,9 @@ # List Thermostat Schedules +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index e3346e4f6..2735b2738 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -1,5 +1,9 @@ # Update a Thermostat Schedule +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). {% hint style="success" %} diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 71e7be444..4a5081642 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -1,5 +1,9 @@ # Set the Fallback Climate Preset +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index c93a0f8e6..fe8803fbe 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -1,5 +1,9 @@ # Set the Fan Mode Setting +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 7168d105e..630be5ed9 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -1,5 +1,9 @@ # Set the HVAC Mode +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 6bdf19953..1ab12b9eb 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -1,5 +1,9 @@ # Set a Temperature Threshold +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. {% hint style="success" %} diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index f5ac112d1..2dbaf3294 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -1,5 +1,9 @@ # HVAC Mode Adjusted +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). {% hint style="success" %} diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 8b85f7ae4..836485951 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -1,5 +1,9 @@ # Temperature Reached +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). {% hint style="success" %} diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 8c932862b..f953e475c 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -1,5 +1,9 @@ # Update a Climate Preset +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). {% hint style="success" %} diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 808777071..5a0d66066 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -2,11 +2,11 @@ ## The user_identity Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index c7d00df74..32814cd90 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -1,5 +1,9 @@ # Add an ACS User to a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index c6c2e5877..45fd57f01 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -1,5 +1,9 @@ # Create a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 7e7853661..9034d628e 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -1,5 +1,9 @@ # Delete a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. {% hint style="success" %} diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 088cc75a6..e5a419788 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -2,11 +2,11 @@ ## The enrollment_automation Object -- [Properties](./#Properties) -- [Errors](./#Errors) -- [Warnings](./#Warnings) -- [Events](./#Events) -- [Endpoints](./#Endpoints) +- [Properties](./#properties) +- [Errors](./#errors) +- [Warnings](./#warnings) +- [Events](./#events) +- [Endpoints](./#endpoints) Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 8dbc6e677..d05652ca1 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -1,5 +1,9 @@ # Delete an Enrollment Automation +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). {% hint style="success" %} diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index b5baf4397..9cebf0c6f 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -1,5 +1,9 @@ # Get an Enrollment Automation +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). {% hint style="success" %} diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 2e02b3143..fbdf02dfb 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -1,5 +1,9 @@ # Launch an Enrollment Automation +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). {% hint style="success" %} diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index ad31295cc..c21d728ef 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -1,5 +1,9 @@ # List Enrollment Automations +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index bca89650b..b6f620270 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -1,5 +1,9 @@ # Get a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index f5f8692d8..c2ceadaaa 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -1,5 +1,9 @@ # Grant a User Identity Access to a Device +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). {% hint style="success" %} diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index c132c6d13..4c7115871 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -1,5 +1,9 @@ # List User Identities +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 61553ab7a..e18661c69 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -1,5 +1,9 @@ # List Accessible Devices for a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index f17c19c9e..6a920e907 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -1,5 +1,9 @@ # List ACS Systems Associated with a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 987fd3c16..9081b2aa4 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -1,5 +1,9 @@ # List ACS Users Associated with a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 7fa26db2e..b4d1f7376 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -1,5 +1,9 @@ # Remove an ACS User from a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 5a68d654a..96fb7471f 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -1,5 +1,9 @@ # Revoke Access to a Device from a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). {% hint style="success" %} diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 5608497f0..b0ea1049d 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -1,5 +1,9 @@ # Update a User Identity +- [Request Parameters](./#request-parameters) +- [Response](./#response) +- [Examples](./#examples) + {% hint style="success" %} From 96a00f02783217d6da663967f4c9baebbc671f40 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 22:21:35 -0400 Subject: [PATCH 200/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index e452d335d..a71d7a2e1 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -6,11 +6,13 @@ {{{description}}} -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` {{request.preferredMethod}} {{path}} ⇒ {{#if response.responseKey}}{{#if (eq response.responseType "resource_list")}}{ {{response.responseKey}}: [{{response.resourceType}}, …] }{{else}}{ {{response.responseKey}} }{{/if}}{{else}}void{{/if}} ``` -{% endhint %} +{% endtab %} +{% endtabs %} {{#if authMethods}}
From 10795980048da98167a2c7c7931a92f5c623c226 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 02:22:35 +0000 Subject: [PATCH 201/233] ci: Generate docs --- docs/api/access_codes/create.md | 6 ++++-- docs/api/access_codes/create_multiple.md | 6 ++++-- docs/api/access_codes/delete.md | 6 ++++-- docs/api/access_codes/get.md | 6 ++++-- docs/api/access_codes/list.md | 6 ++++-- docs/api/access_codes/pull_backup_access_code.md | 6 ++++-- .../access_codes/simulate/create_unmanaged_access_code.md | 6 ++++-- docs/api/access_codes/unmanaged/convert_to_managed.md | 6 ++++-- docs/api/access_codes/unmanaged/delete.md | 6 ++++-- docs/api/access_codes/unmanaged/get.md | 6 ++++-- docs/api/access_codes/unmanaged/list.md | 6 ++++-- docs/api/access_codes/unmanaged/update.md | 6 ++++-- docs/api/access_codes/update.md | 6 ++++-- docs/api/access_codes/update_multiple.md | 6 ++++-- docs/api/acs/access_groups/add_user.md | 6 ++++-- docs/api/acs/access_groups/get.md | 6 ++++-- docs/api/acs/access_groups/list.md | 6 ++++-- docs/api/acs/access_groups/list_accessible_entrances.md | 6 ++++-- docs/api/acs/access_groups/list_users.md | 6 ++++-- docs/api/acs/access_groups/remove_user.md | 6 ++++-- docs/api/acs/credentials/assign.md | 6 ++++-- docs/api/acs/credentials/create.md | 6 ++++-- docs/api/acs/credentials/delete.md | 6 ++++-- docs/api/acs/credentials/get.md | 6 ++++-- docs/api/acs/credentials/list.md | 6 ++++-- docs/api/acs/credentials/list_accessible_entrances.md | 6 ++++-- docs/api/acs/credentials/unassign.md | 6 ++++-- docs/api/acs/credentials/update.md | 6 ++++-- docs/api/acs/encoders/encode_credential.md | 6 ++++-- docs/api/acs/encoders/list.md | 6 ++++-- docs/api/acs/encoders/scan_credential.md | 6 ++++-- .../encoders/simulate/next_credential_encode_will_fail.md | 6 ++++-- .../simulate/next_credential_encode_will_succeed.md | 6 ++++-- .../acs/encoders/simulate/next_credential_scan_will_fail.md | 6 ++++-- .../encoders/simulate/next_credential_scan_will_succeed.md | 6 ++++-- docs/api/acs/entrances/get.md | 6 ++++-- docs/api/acs/entrances/grant_access.md | 6 ++++-- docs/api/acs/entrances/list.md | 6 ++++-- docs/api/acs/entrances/list_credentials_with_access.md | 6 ++++-- docs/api/acs/systems/get.md | 6 ++++-- docs/api/acs/systems/list.md | 6 ++++-- .../list_compatible_credential_manager_acs_systems.md | 6 ++++-- docs/api/acs/users/add_to_access_group.md | 6 ++++-- docs/api/acs/users/create.md | 6 ++++-- docs/api/acs/users/delete.md | 6 ++++-- docs/api/acs/users/get.md | 6 ++++-- docs/api/acs/users/list.md | 6 ++++-- docs/api/acs/users/list_accessible_entrances.md | 6 ++++-- docs/api/acs/users/remove_from_access_group.md | 6 ++++-- docs/api/acs/users/revoke_access_to_all_entrances.md | 6 ++++-- docs/api/acs/users/suspend.md | 6 ++++-- docs/api/acs/users/unsuspend.md | 6 ++++-- docs/api/acs/users/update.md | 6 ++++-- docs/api/phones/deactivate.md | 6 ++++-- docs/api/phones/get.md | 6 ++++-- docs/api/phones/list.md | 6 ++++-- docs/api/phones/simulate/create_sandbox_phone.md | 6 ++++-- docs/api/thermostats/activate_climate_preset.md | 6 ++++-- docs/api/thermostats/cool.md | 6 ++++-- docs/api/thermostats/create_climate_preset.md | 6 ++++-- docs/api/thermostats/delete_climate_preset.md | 6 ++++-- docs/api/thermostats/heat.md | 6 ++++-- docs/api/thermostats/heat_cool.md | 6 ++++-- docs/api/thermostats/list.md | 6 ++++-- docs/api/thermostats/off.md | 6 ++++-- docs/api/thermostats/schedules/create.md | 6 ++++-- docs/api/thermostats/schedules/delete.md | 6 ++++-- docs/api/thermostats/schedules/get.md | 6 ++++-- docs/api/thermostats/schedules/list.md | 6 ++++-- docs/api/thermostats/schedules/update.md | 6 ++++-- docs/api/thermostats/set_fallback_climate_preset.md | 6 ++++-- docs/api/thermostats/set_fan_mode.md | 6 ++++-- docs/api/thermostats/set_hvac_mode.md | 6 ++++-- docs/api/thermostats/set_temperature_threshold.md | 6 ++++-- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 6 ++++-- docs/api/thermostats/simulate/temperature_reached.md | 6 ++++-- docs/api/thermostats/update_climate_preset.md | 6 ++++-- docs/api/user_identities/add_acs_user.md | 6 ++++-- docs/api/user_identities/create.md | 6 ++++-- docs/api/user_identities/delete.md | 6 ++++-- docs/api/user_identities/enrollment_automations/delete.md | 6 ++++-- docs/api/user_identities/enrollment_automations/get.md | 6 ++++-- docs/api/user_identities/enrollment_automations/launch.md | 6 ++++-- docs/api/user_identities/enrollment_automations/list.md | 6 ++++-- docs/api/user_identities/get.md | 6 ++++-- docs/api/user_identities/grant_access_to_device.md | 6 ++++-- docs/api/user_identities/list.md | 6 ++++-- docs/api/user_identities/list_accessible_devices.md | 6 ++++-- docs/api/user_identities/list_acs_systems.md | 6 ++++-- docs/api/user_identities/list_acs_users.md | 6 ++++-- docs/api/user_identities/remove_acs_user.md | 6 ++++-- docs/api/user_identities/revoke_access_to_device.md | 6 ++++-- docs/api/user_identities/update.md | 6 ++++-- 93 files changed, 372 insertions(+), 186 deletions(-) diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index 75c968089..99a95810f 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -6,11 +6,13 @@ Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /access_codes/create ⇒ { access_code } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index b17be2cdd..24ccd57b6 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -14,11 +14,13 @@ If you want to change these access codes that are not linked by a `common_code_k See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PUT /access_codes/create_multiple ⇒ { access_codes: [access_code, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index 91a8afa99..42e681dbb 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -6,11 +6,13 @@ Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /access_codes/delete ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 9f8a8bc4e..4df116efd 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -8,11 +8,13 @@ Returns a specified [access code](https://docs.seam.co/latest/capability-guides/ You must specify either `access_code_id` or both `device_id` and `code`. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /access_codes/get ⇒ { access_code } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 63cceafbf..08f5d4c67 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -8,11 +8,13 @@ Returns a list of all [access codes](https://docs.seam.co/latest/capability-guid Specify either `device_id` or `access_code_ids`. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /access_codes/list ⇒ { access_codes: [access_code, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 7e893471f..d591f8acd 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -14,11 +14,13 @@ You can only pull backup access codes for time-bound access codes. Before pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /access_codes/pull_backup_access_code ⇒ { access_code } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index cfb381334..2a6462072 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -6,11 +6,13 @@ Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /access_codes/simulate/create_unmanaged_access_code ⇒ { access_code } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index d2cbadc19..6059a2840 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -10,11 +10,13 @@ An unmanaged access code has a limited set of operations that you can perform on Note that not all device providers support converting an unmanaged access code to a managed access code. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /access_codes/unmanaged/convert_to_managed ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index 76fc64bd0..a00d19d0d 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -6,11 +6,13 @@ Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /access_codes/unmanaged/delete ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index d7e4340bc..937aa7548 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -8,11 +8,13 @@ Returns a specified [unmanaged access code](https://docs.seam.co/latest/capabili You must specify either `access_code_id` or both `device_id` and `code`. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /access_codes/unmanaged/get ⇒ { access_code } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index 24579999c..20555d1e2 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -6,11 +6,13 @@ Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /access_codes/unmanaged/list ⇒ { access_codes: [unmanaged_access_code, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index f77ab5ecc..e791d3eb0 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -6,11 +6,13 @@ Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /access_codes/unmanaged/update ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index c28cbb96d..7275f5bae 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -8,11 +8,13 @@ Updates a specified active or upcoming [access code](https://docs.seam.co/latest See also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PUT /access_codes/update ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index 2c445aa34..71661dc55 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -10,11 +10,13 @@ Specify the `common_code_key` to identify the set of access codes that you want See also [Update Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md#update-linked-access-codes). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /access_codes/update_multiple ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index bfef2cb81..f04abb1b5 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -6,11 +6,13 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PUT /acs/access_groups/add_user ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 1ee1cd8d8..0c2634f01 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -6,11 +6,13 @@ Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/get ⇒ { acs_access_group } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index a003e034d..5caec58f1 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -6,11 +6,13 @@ Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 4f7fafe9a..4e284a7b1 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -6,11 +6,13 @@ Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index f06f3f1ad..293467362 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -6,11 +6,13 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index f77f10e03..0103e1d47 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -6,11 +6,13 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/access_groups/remove_user ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index dc48f0201..8085593de 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -6,11 +6,13 @@ Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/credentials/assign ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 3ca683d70..db755709d 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -6,11 +6,13 @@ Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/create ⇒ { acs_credential } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index dcc815976..f28a435e8 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -6,11 +6,13 @@ Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/delete ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index a3c6713db..43d2576e6 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -6,11 +6,13 @@ Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/get ⇒ { acs_credential } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 41a9f3ced..e89fbbb2c 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -6,11 +6,13 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 977ef4c07..61ca453d1 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -6,11 +6,13 @@ Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 286bc9663..ad621d0db 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -6,11 +6,13 @@ Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/credentials/unassign ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 02d4a3b48..56a7a1999 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -6,11 +6,13 @@ Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/credentials/update ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 0e90df8fe..febe43f7b 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -6,11 +6,13 @@ Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/encode_credential ⇒ { action_attempt } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index cd4f4feeb..367f0dc66 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -6,11 +6,13 @@ Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 5937dce6d..550fa1d6b 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -6,11 +6,13 @@ Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/scan_credential ⇒ { action_attempt } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index abe2f24f5..7f7f73bff 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -6,11 +6,13 @@ Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 27de96339..62f02e6c5 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -6,11 +6,13 @@ Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index dc990dac8..c78edccb5 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -6,11 +6,13 @@ Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index a7730580f..34e66a5db 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -6,11 +6,13 @@ Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index afd887ccc..fd3a2ebd8 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -6,11 +6,13 @@ Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/get ⇒ { acs_entrance } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 9055e72a4..8afb4d739 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -6,11 +6,13 @@ -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/grant_access ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index cacb8641e..938a4d88b 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -6,11 +6,13 @@ Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index f6883c876..f4c76b06f 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -6,11 +6,13 @@ Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_credential, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index bfa5678ed..fab3ed3fb 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -8,11 +8,13 @@ Returns a specified [access control system](https://docs.seam.co/latest/capabili Specify the desired access control system by including the corresponding `acs_system_id` in the request body. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/systems/get ⇒ { acs_system } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 428cfc369..70d2328a8 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -8,11 +8,13 @@ Returns a list of all [access control systems](https://docs.seam.co/latest/capab To filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 77370833d..1e7620562 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -8,11 +8,13 @@ Returns a list of all credential manager ACS systems that are compatible with a Specify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 4fa4640a0..5e8d89d7b 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -6,11 +6,13 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PUT /acs/users/add_to_access_group ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index cbda5546b..f822f32c3 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -6,11 +6,13 @@ Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/create ⇒ { acs_user } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 4adc345ef..c38ac12b3 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -6,11 +6,13 @@ Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/delete ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index b2b935ce4..5df6c7cc1 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -6,11 +6,13 @@ Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/get ⇒ { acs_user } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 67ed974f9..363ac9749 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -6,11 +6,13 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/list ⇒ { acs_users: [acs_user, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 6e10144e7..fe10bd883 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -6,11 +6,13 @@ Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 8d3f7b221..05b285d02 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -6,11 +6,13 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/remove_from_access_group ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 230c79d1d..1177b6da5 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -6,11 +6,13 @@ Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/revoke_access_to_all_entrances ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 647940a7f..1338c53d8 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -6,11 +6,13 @@ [Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/suspend ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 7d84c1b1e..a4405d93e 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -6,11 +6,13 @@ [Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /acs/users/unsuspend ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 61b92786b..a2747f546 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -6,11 +6,13 @@ Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /acs/users/update ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index fe1d63784..52061c06e 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -6,11 +6,13 @@ Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/deactivate ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 4d24484fa..10b4e534f 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -6,11 +6,13 @@ Returns a single phone entry matching the provided `device_id`. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/get ⇒ { phone } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 9f162ab56..f9049e278 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -6,11 +6,13 @@ Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/list ⇒ { phones: [phone, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 81d34168c..bd31e4231 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -6,11 +6,13 @@ Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /phones/simulate/create_sandbox_phone ⇒ { phone } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 54436d3ea..6026610f0 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -6,11 +6,13 @@ Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/activate_climate_preset ⇒ { action_attempt } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 83559ff2e..5c45962da 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -6,11 +6,13 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/cool ⇒ { action_attempt } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 224701358..445063a26 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -6,11 +6,13 @@ Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/create_climate_preset ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 53591113c..7df020829 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -6,11 +6,13 @@ Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/delete_climate_preset ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index de7b5ba2e..4ebe4bf9f 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -6,11 +6,13 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/heat ⇒ { action_attempt } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index fa95ea143..b91f936e3 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -6,11 +6,13 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/heat_cool ⇒ { action_attempt } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 28e58c68b..e3487d522 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -6,11 +6,13 @@ Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/list ⇒ { devices: [device, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 58e1c47a4..1b80084fd 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -6,11 +6,13 @@ Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/off ⇒ { action_attempt } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index b7b640322..a1d8cf470 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -6,11 +6,13 @@ Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/create ⇒ { thermostat_schedule } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index bfb5793f0..c90a71f06 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -6,11 +6,13 @@ Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/delete ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 68fbd4c19..3bebf138d 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -6,11 +6,13 @@ Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/get ⇒ { thermostat_schedule } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index c1e31a047..e6021e16c 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -6,11 +6,13 @@ Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedule, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 2735b2738..f81f87963 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -6,11 +6,13 @@ Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /thermostats/schedules/update ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 4a5081642..940ea6076 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -6,11 +6,13 @@ Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/set_fallback_climate_preset ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index fe8803fbe..ae5c810a3 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -6,11 +6,13 @@ Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/set_fan_mode ⇒ { action_attempt } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 630be5ed9..0ef153c24 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -6,11 +6,13 @@ Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/set_hvac_mode ⇒ { action_attempt } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 1ab12b9eb..a3c480d23 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -6,11 +6,13 @@ Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /thermostats/set_temperature_threshold ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 2dbaf3294..b493e3704 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -6,11 +6,13 @@ Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/simulate/hvac_mode_adjusted ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 836485951..4fee38b7b 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -6,11 +6,13 @@ Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /thermostats/simulate/temperature_reached ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index f953e475c..41430ea29 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -6,11 +6,13 @@ Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /thermostats/update_climate_preset ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 32814cd90..2de975106 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -6,11 +6,13 @@ Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PUT /user_identities/add_acs_user ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 45fd57f01..1d5754cd8 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -6,11 +6,13 @@ Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/create ⇒ { user_identity } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 9034d628e..93e37045e 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -6,11 +6,13 @@ Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/delete ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index d05652ca1..fb6f6d5d7 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -6,11 +6,13 @@ Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/delete ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 9cebf0c6f..8bba7473a 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -6,11 +6,13 @@ Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index fbdf02dfb..1a7c45e32 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -6,11 +6,13 @@ Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index c21d728ef..dc3471b84 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -6,11 +6,13 @@ Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations: [enrollment_automation, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index b6f620270..ab67457b3 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -6,11 +6,13 @@ Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/get ⇒ { user_identity } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index c2ceadaaa..62cc64808 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -6,11 +6,13 @@ Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PUT /user_identities/grant_access_to_device ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 4c7115871..25b8218f2 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -6,11 +6,13 @@ Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list ⇒ { user_identities: [user_identity, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index e18661c69..a695777f2 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -6,11 +6,13 @@ Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index 6a920e907..e1f8bce3a 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -6,11 +6,13 @@ Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 9081b2aa4..90f3ee5d5 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -6,11 +6,13 @@ Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] } ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index b4d1f7376..d07b2bdcf 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -6,11 +6,13 @@ Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/remove_acs_user ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 96fb7471f..e0569d766 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -6,11 +6,13 @@ Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` POST /user_identities/revoke_access_to_device ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index b0ea1049d..8957b1473 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -6,11 +6,13 @@ -{% hint style="success" %} +{% tabs %} +{% tab title="Signature" %} ``` PATCH /user_identities/update ⇒ void ``` -{% endhint %} +{% endtab %} +{% endtabs %}
From f813b26970261f2e4a531a770b1b87d721413e79 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 22:26:30 -0400 Subject: [PATCH 202/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index a71d7a2e1..5b01bfeb4 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -17,7 +17,7 @@ {{#if authMethods}}
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods {{#each authMethods}} - {{this}} @@ -25,6 +25,8 @@
{{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} {{/if}} {{/each}} + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
{{/if}} From a9067ed898f69163dd15cebb9ba537bf6d51106c Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 02:27:32 +0000 Subject: [PATCH 203/233] ci: Generate docs --- docs/api/access_codes/create.md | 4 +++- docs/api/access_codes/create_multiple.md | 4 +++- docs/api/access_codes/delete.md | 4 +++- docs/api/access_codes/get.md | 4 +++- docs/api/access_codes/list.md | 4 +++- docs/api/access_codes/pull_backup_access_code.md | 4 +++- .../api/access_codes/simulate/create_unmanaged_access_code.md | 4 +++- docs/api/access_codes/unmanaged/convert_to_managed.md | 4 +++- docs/api/access_codes/unmanaged/delete.md | 4 +++- docs/api/access_codes/unmanaged/get.md | 4 +++- docs/api/access_codes/unmanaged/list.md | 4 +++- docs/api/access_codes/unmanaged/update.md | 4 +++- docs/api/access_codes/update.md | 4 +++- docs/api/access_codes/update_multiple.md | 4 +++- docs/api/acs/access_groups/add_user.md | 4 +++- docs/api/acs/access_groups/get.md | 4 +++- docs/api/acs/access_groups/list.md | 4 +++- docs/api/acs/access_groups/list_accessible_entrances.md | 4 +++- docs/api/acs/access_groups/list_users.md | 4 +++- docs/api/acs/access_groups/remove_user.md | 4 +++- docs/api/acs/credentials/assign.md | 4 +++- docs/api/acs/credentials/create.md | 4 +++- docs/api/acs/credentials/delete.md | 4 +++- docs/api/acs/credentials/get.md | 4 +++- docs/api/acs/credentials/list.md | 4 +++- docs/api/acs/credentials/list_accessible_entrances.md | 4 +++- docs/api/acs/credentials/unassign.md | 4 +++- docs/api/acs/credentials/update.md | 4 +++- docs/api/acs/encoders/encode_credential.md | 4 +++- docs/api/acs/encoders/list.md | 4 +++- docs/api/acs/encoders/scan_credential.md | 4 +++- .../acs/encoders/simulate/next_credential_encode_will_fail.md | 4 +++- .../encoders/simulate/next_credential_encode_will_succeed.md | 4 +++- .../acs/encoders/simulate/next_credential_scan_will_fail.md | 4 +++- .../encoders/simulate/next_credential_scan_will_succeed.md | 4 +++- docs/api/acs/entrances/get.md | 4 +++- docs/api/acs/entrances/grant_access.md | 4 +++- docs/api/acs/entrances/list.md | 4 +++- docs/api/acs/entrances/list_credentials_with_access.md | 4 +++- docs/api/acs/systems/get.md | 4 +++- docs/api/acs/systems/list.md | 4 +++- .../systems/list_compatible_credential_manager_acs_systems.md | 4 +++- docs/api/acs/users/add_to_access_group.md | 4 +++- docs/api/acs/users/create.md | 4 +++- docs/api/acs/users/delete.md | 4 +++- docs/api/acs/users/get.md | 4 +++- docs/api/acs/users/list.md | 4 +++- docs/api/acs/users/list_accessible_entrances.md | 4 +++- docs/api/acs/users/remove_from_access_group.md | 4 +++- docs/api/acs/users/revoke_access_to_all_entrances.md | 4 +++- docs/api/acs/users/suspend.md | 4 +++- docs/api/acs/users/unsuspend.md | 4 +++- docs/api/acs/users/update.md | 4 +++- docs/api/phones/deactivate.md | 4 +++- docs/api/phones/get.md | 4 +++- docs/api/phones/list.md | 4 +++- docs/api/phones/simulate/create_sandbox_phone.md | 4 +++- docs/api/thermostats/activate_climate_preset.md | 4 +++- docs/api/thermostats/cool.md | 4 +++- docs/api/thermostats/create_climate_preset.md | 4 +++- docs/api/thermostats/delete_climate_preset.md | 4 +++- docs/api/thermostats/heat.md | 4 +++- docs/api/thermostats/heat_cool.md | 4 +++- docs/api/thermostats/list.md | 4 +++- docs/api/thermostats/off.md | 4 +++- docs/api/thermostats/schedules/create.md | 4 +++- docs/api/thermostats/schedules/delete.md | 4 +++- docs/api/thermostats/schedules/get.md | 4 +++- docs/api/thermostats/schedules/list.md | 4 +++- docs/api/thermostats/schedules/update.md | 4 +++- docs/api/thermostats/set_fallback_climate_preset.md | 4 +++- docs/api/thermostats/set_fan_mode.md | 4 +++- docs/api/thermostats/set_hvac_mode.md | 4 +++- docs/api/thermostats/set_temperature_threshold.md | 4 +++- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 4 +++- docs/api/thermostats/simulate/temperature_reached.md | 4 +++- docs/api/thermostats/update_climate_preset.md | 4 +++- docs/api/user_identities/add_acs_user.md | 4 +++- docs/api/user_identities/create.md | 4 +++- docs/api/user_identities/delete.md | 4 +++- docs/api/user_identities/enrollment_automations/delete.md | 4 +++- docs/api/user_identities/enrollment_automations/get.md | 4 +++- docs/api/user_identities/enrollment_automations/launch.md | 4 +++- docs/api/user_identities/enrollment_automations/list.md | 4 +++- docs/api/user_identities/get.md | 4 +++- docs/api/user_identities/grant_access_to_device.md | 4 +++- docs/api/user_identities/list.md | 4 +++- docs/api/user_identities/list_accessible_devices.md | 4 +++- docs/api/user_identities/list_acs_systems.md | 4 +++- docs/api/user_identities/list_acs_users.md | 4 +++- docs/api/user_identities/remove_acs_user.md | 4 +++- docs/api/user_identities/revoke_access_to_device.md | 4 +++- docs/api/user_identities/update.md | 4 +++- 93 files changed, 279 insertions(+), 93 deletions(-) diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index 99a95810f..0432b6cd1 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -16,12 +16,14 @@ POST /access_codes/create ⇒ { access_code }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 24ccd57b6..fabe8e6d9 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -24,12 +24,14 @@ PUT /access_codes/create_multiple ⇒ { access_codes: [access_code, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index 42e681dbb..06edcd71a 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -16,12 +16,14 @@ POST /access_codes/delete ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 4df116efd..8e714f7c0 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -18,10 +18,12 @@ POST /access_codes/get ⇒ { access_code }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 08f5d4c67..02fecad2e 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -18,12 +18,14 @@ POST /access_codes/list ⇒ { access_codes: [access_code, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index d591f8acd..4589a1b63 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -24,12 +24,14 @@ POST /access_codes/pull_backup_access_code ⇒ { access_code }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index 2a6462072..5a3955f75 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -16,12 +16,14 @@ POST /access_codes/simulate/create_unmanaged_access_code ⇒ { access_code }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 6059a2840..8a4c878c7 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -20,12 +20,14 @@ PATCH /access_codes/unmanaged/convert_to_managed ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index a00d19d0d..1d4e9fbd0 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -16,12 +16,14 @@ POST /access_codes/unmanaged/delete ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index 937aa7548..0ba83dfc7 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -18,12 +18,14 @@ POST /access_codes/unmanaged/get ⇒ { access_code }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index 20555d1e2..521324216 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -16,12 +16,14 @@ POST /access_codes/unmanaged/list ⇒ { access_codes: [unmanaged_access_code,
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index e791d3eb0..3db1bbc5f 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -16,12 +16,14 @@ PATCH /access_codes/unmanaged/update ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index 7275f5bae..97dccd3f6 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -18,12 +18,14 @@ PUT /access_codes/update ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index 71661dc55..29d3e1ae4 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -20,12 +20,14 @@ PATCH /access_codes/update_multiple ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index f04abb1b5..84f2fe7d3 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -16,11 +16,13 @@ PUT /acs/access_groups/add_user ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index 0c2634f01..dd9784414 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -16,11 +16,13 @@ POST /acs/access_groups/get ⇒ { acs_access_group }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 5caec58f1..6594896c0 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -16,11 +16,13 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 4e284a7b1..e954b77bb 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -16,11 +16,13 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 293467362..1dcbbeee1 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -16,11 +16,13 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 0103e1d47..7b080a649 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -16,11 +16,13 @@ POST /acs/access_groups/remove_user ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 8085593de..d21666edb 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -16,11 +16,13 @@ PATCH /acs/credentials/assign ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index db755709d..dca480120 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -16,11 +16,13 @@ POST /acs/credentials/create ⇒ { acs_credential }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index f28a435e8..613ba13e4 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -16,11 +16,13 @@ POST /acs/credentials/delete ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 43d2576e6..6c005bad2 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -16,11 +16,13 @@ POST /acs/credentials/get ⇒ { acs_credential }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index e89fbbb2c..8e21e411b 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -16,12 +16,14 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 61ca453d1..ebd6f3a76 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -16,11 +16,13 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index ad621d0db..232e61319 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -16,11 +16,13 @@ PATCH /acs/credentials/unassign ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 56a7a1999..6cb309303 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -16,11 +16,13 @@ PATCH /acs/credentials/update ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index febe43f7b..2bdbf254d 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -16,11 +16,13 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 367f0dc66..a893ed9d5 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -16,11 +16,13 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 550fa1d6b..14489749d 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -16,11 +16,13 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 7f7f73bff..f716d6875 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -16,11 +16,13 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 62f02e6c5..78083d80b 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -16,11 +16,13 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index c78edccb5..0e6fe9773 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -16,11 +16,13 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 34e66a5db..85559210b 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -16,11 +16,13 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index fd3a2ebd8..a89d035a2 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -16,10 +16,12 @@ POST /acs/entrances/get ⇒ { acs_entrance }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 8afb4d739..9a883b840 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -16,11 +16,13 @@ POST /acs/entrances/grant_access ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 938a4d88b..8ddeeca8f 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -16,12 +16,14 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index f4c76b06f..b5e559de2 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -16,12 +16,14 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index fab3ed3fb..6d494899b 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -18,11 +18,13 @@ POST /acs/systems/get ⇒ { acs_system }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 70d2328a8..abdf608f0 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -18,12 +18,14 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 1e7620562..2011f08fa 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -18,11 +18,13 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 5e8d89d7b..01ac90f6e 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -16,11 +16,13 @@ PUT /acs/users/add_to_access_group ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index f822f32c3..54cd0c12f 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -16,11 +16,13 @@ POST /acs/users/create ⇒ { acs_user }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index c38ac12b3..21710c68a 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -16,11 +16,13 @@ POST /acs/users/delete ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 5df6c7cc1..6a9674a31 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -16,11 +16,13 @@ POST /acs/users/get ⇒ { acs_user }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 363ac9749..2d0873596 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -16,12 +16,14 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index fe10bd883..4628c6312 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -16,12 +16,14 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance,
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 05b285d02..b1b001a49 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -16,11 +16,13 @@ POST /acs/users/remove_from_access_group ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 1177b6da5..783638a6c 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -16,11 +16,13 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 1338c53d8..90ea60928 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -16,11 +16,13 @@ POST /acs/users/suspend ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index a4405d93e..833d5200a 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -16,11 +16,13 @@ POST /acs/users/unsuspend ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index a2747f546..2e06e0c0d 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -16,11 +16,13 @@ PATCH /acs/users/update ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 52061c06e..a1c740e06 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -16,12 +16,14 @@ POST /phones/deactivate ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 10b4e534f..3ff4e2172 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -16,11 +16,13 @@ POST /phones/get ⇒ { phone }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index f9049e278..4109ea0e4 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -16,11 +16,13 @@ POST /phones/list ⇒ { phones: [phone, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index bd31e4231..44b5453dd 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -16,11 +16,13 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 6026610f0..40d62c12f 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -16,11 +16,13 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 5c45962da..d5b71cc26 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -16,12 +16,14 @@ POST /thermostats/cool ⇒ { action_attempt }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 445063a26..e940c9f71 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -16,12 +16,14 @@ POST /thermostats/create_climate_preset ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 7df020829..d3fd89405 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -16,12 +16,14 @@ POST /thermostats/delete_climate_preset ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 4ebe4bf9f..144c757ab 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -16,12 +16,14 @@ POST /thermostats/heat ⇒ { action_attempt }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index b91f936e3..6b578faca 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -16,12 +16,14 @@ POST /thermostats/heat_cool ⇒ { action_attempt }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index e3487d522..79dc93a5a 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -16,12 +16,14 @@ POST /thermostats/list ⇒ { devices: [device, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 1b80084fd..07c8fb232 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -16,12 +16,14 @@ POST /thermostats/off ⇒ { action_attempt }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index a1d8cf470..8f3e74be3 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -16,12 +16,14 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index c90a71f06..e4c19fb98 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -16,12 +16,14 @@ POST /thermostats/schedules/delete ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 3bebf138d..5dced04fe 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -16,12 +16,14 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index e6021e16c..6c6cfea79 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -16,12 +16,14 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index f81f87963..7ec5eac59 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -16,12 +16,14 @@ PATCH /thermostats/schedules/update ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 940ea6076..c63053677 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -16,11 +16,13 @@ POST /thermostats/set_fallback_climate_preset ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index ae5c810a3..3bbd22980 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -16,12 +16,14 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 0ef153c24..55b896d2d 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -16,12 +16,14 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index a3c480d23..58ba13573 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -16,11 +16,13 @@ PATCH /thermostats/set_temperature_threshold ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index b493e3704..f4ab0f766 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -16,11 +16,13 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 4fee38b7b..179fa7a22 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -16,11 +16,13 @@ POST /thermostats/simulate/temperature_reached ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 41430ea29..4d20bf4ec 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -16,12 +16,14 @@ PATCH /thermostats/update_climate_preset ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 2de975106..0e736e9d5 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -16,11 +16,13 @@ PUT /user_identities/add_acs_user ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 1d5754cd8..b265d96cd 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -16,11 +16,13 @@ POST /user_identities/create ⇒ { user_identity }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 93e37045e..9e0ee45e5 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -16,11 +16,13 @@ POST /user_identities/delete ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index fb6f6d5d7..a848616f6 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -16,11 +16,13 @@ POST /user_identities/enrollment_automations/delete ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 8bba7473a..cfa601bc3 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -16,12 +16,14 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 1a7c45e32..1aceeccd7 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -16,11 +16,13 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index dc3471b84..4d433f027 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -16,12 +16,14 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations:
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index ab67457b3..906e92ab1 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -16,11 +16,13 @@ POST /user_identities/get ⇒ { user_identity }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 62cc64808..f34a8324e 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -16,11 +16,13 @@ PUT /user_identities/grant_access_to_device ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 25b8218f2..ebc607059 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -16,12 +16,14 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index a695777f2..a2a409a23 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -16,11 +16,13 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index e1f8bce3a..a71ab7408 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -16,12 +16,14 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 90f3ee5d5..58cdd93f7 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -16,11 +16,13 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] }
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index d07b2bdcf..ab167cbd3 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -16,11 +16,13 @@ POST /user_identities/remove_acs_user ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index e0569d766..82d2c2bec 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -16,11 +16,13 @@ POST /user_identities/revoke_access_to_device ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 8957b1473..aa35d1057 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -16,11 +16,13 @@ PATCH /user_identities/update ⇒ void
-[Authentication Methods]{https://docs.seam.co/latest/api/authentication} +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters From ab744e73e2e818c09b4daca68610df4faa0cc7c7 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 22:59:40 -0400 Subject: [PATCH 204/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 5b01bfeb4..924cbe691 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -17,7 +17,7 @@ {{#if authMethods}}
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) {{#each authMethods}} - {{this}} @@ -25,8 +25,6 @@
{{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} {{/if}} {{/each}} - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
{{/if}} From f7eed8c898ef62db093b09e51bcc6789f5dc8408 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 03:00:35 +0000 Subject: [PATCH 205/233] ci: Generate docs --- docs/api/access_codes/create.md | 4 +--- docs/api/access_codes/create_multiple.md | 4 +--- docs/api/access_codes/delete.md | 4 +--- docs/api/access_codes/get.md | 4 +--- docs/api/access_codes/list.md | 4 +--- docs/api/access_codes/pull_backup_access_code.md | 4 +--- .../access_codes/simulate/create_unmanaged_access_code.md | 4 +--- docs/api/access_codes/unmanaged/convert_to_managed.md | 4 +--- docs/api/access_codes/unmanaged/delete.md | 4 +--- docs/api/access_codes/unmanaged/get.md | 4 +--- docs/api/access_codes/unmanaged/list.md | 4 +--- docs/api/access_codes/unmanaged/update.md | 4 +--- docs/api/access_codes/update.md | 4 +--- docs/api/access_codes/update_multiple.md | 4 +--- docs/api/acs/access_groups/add_user.md | 4 +--- docs/api/acs/access_groups/get.md | 4 +--- docs/api/acs/access_groups/list.md | 4 +--- docs/api/acs/access_groups/list_accessible_entrances.md | 4 +--- docs/api/acs/access_groups/list_users.md | 4 +--- docs/api/acs/access_groups/remove_user.md | 4 +--- docs/api/acs/credentials/assign.md | 4 +--- docs/api/acs/credentials/create.md | 4 +--- docs/api/acs/credentials/delete.md | 4 +--- docs/api/acs/credentials/get.md | 4 +--- docs/api/acs/credentials/list.md | 4 +--- docs/api/acs/credentials/list_accessible_entrances.md | 4 +--- docs/api/acs/credentials/unassign.md | 4 +--- docs/api/acs/credentials/update.md | 4 +--- docs/api/acs/encoders/encode_credential.md | 4 +--- docs/api/acs/encoders/list.md | 4 +--- docs/api/acs/encoders/scan_credential.md | 4 +--- .../encoders/simulate/next_credential_encode_will_fail.md | 4 +--- .../simulate/next_credential_encode_will_succeed.md | 4 +--- .../acs/encoders/simulate/next_credential_scan_will_fail.md | 4 +--- .../encoders/simulate/next_credential_scan_will_succeed.md | 4 +--- docs/api/acs/entrances/get.md | 4 +--- docs/api/acs/entrances/grant_access.md | 4 +--- docs/api/acs/entrances/list.md | 4 +--- docs/api/acs/entrances/list_credentials_with_access.md | 4 +--- docs/api/acs/systems/get.md | 4 +--- docs/api/acs/systems/list.md | 4 +--- .../list_compatible_credential_manager_acs_systems.md | 4 +--- docs/api/acs/users/add_to_access_group.md | 4 +--- docs/api/acs/users/create.md | 4 +--- docs/api/acs/users/delete.md | 4 +--- docs/api/acs/users/get.md | 4 +--- docs/api/acs/users/list.md | 4 +--- docs/api/acs/users/list_accessible_entrances.md | 4 +--- docs/api/acs/users/remove_from_access_group.md | 4 +--- docs/api/acs/users/revoke_access_to_all_entrances.md | 4 +--- docs/api/acs/users/suspend.md | 4 +--- docs/api/acs/users/unsuspend.md | 4 +--- docs/api/acs/users/update.md | 4 +--- docs/api/phones/deactivate.md | 4 +--- docs/api/phones/get.md | 4 +--- docs/api/phones/list.md | 6 ++---- docs/api/phones/simulate/create_sandbox_phone.md | 4 +--- docs/api/thermostats/activate_climate_preset.md | 4 +--- docs/api/thermostats/cool.md | 4 +--- docs/api/thermostats/create_climate_preset.md | 4 +--- docs/api/thermostats/delete_climate_preset.md | 4 +--- docs/api/thermostats/heat.md | 4 +--- docs/api/thermostats/heat_cool.md | 4 +--- docs/api/thermostats/list.md | 6 ++---- docs/api/thermostats/off.md | 4 +--- docs/api/thermostats/schedules/create.md | 4 +--- docs/api/thermostats/schedules/delete.md | 4 +--- docs/api/thermostats/schedules/get.md | 4 +--- docs/api/thermostats/schedules/list.md | 4 +--- docs/api/thermostats/schedules/update.md | 4 +--- docs/api/thermostats/set_fallback_climate_preset.md | 4 +--- docs/api/thermostats/set_fan_mode.md | 4 +--- docs/api/thermostats/set_hvac_mode.md | 4 +--- docs/api/thermostats/set_temperature_threshold.md | 4 +--- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 4 +--- docs/api/thermostats/simulate/temperature_reached.md | 4 +--- docs/api/thermostats/update_climate_preset.md | 4 +--- docs/api/user_identities/add_acs_user.md | 4 +--- docs/api/user_identities/create.md | 4 +--- docs/api/user_identities/delete.md | 4 +--- docs/api/user_identities/enrollment_automations/delete.md | 4 +--- docs/api/user_identities/enrollment_automations/get.md | 4 +--- docs/api/user_identities/enrollment_automations/launch.md | 4 +--- docs/api/user_identities/enrollment_automations/list.md | 4 +--- docs/api/user_identities/get.md | 4 +--- docs/api/user_identities/grant_access_to_device.md | 4 +--- docs/api/user_identities/list.md | 4 +--- docs/api/user_identities/list_accessible_devices.md | 4 +--- docs/api/user_identities/list_acs_systems.md | 4 +--- docs/api/user_identities/list_acs_users.md | 4 +--- docs/api/user_identities/remove_acs_user.md | 4 +--- docs/api/user_identities/revoke_access_to_device.md | 4 +--- docs/api/user_identities/update.md | 4 +--- 93 files changed, 95 insertions(+), 281 deletions(-) diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index 0432b6cd1..d07f74653 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -16,14 +16,12 @@ POST /access_codes/create ⇒ { access_code }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index fabe8e6d9..7b80ee578 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -24,14 +24,12 @@ PUT /access_codes/create_multiple ⇒ { access_codes: [access_code, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index 06edcd71a..beaf3fd48 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -16,14 +16,12 @@ POST /access_codes/delete ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 8e714f7c0..2c2198d83 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -18,12 +18,10 @@ POST /access_codes/get ⇒ { access_code }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 02fecad2e..69cc6b65b 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -18,14 +18,12 @@ POST /access_codes/list ⇒ { access_codes: [access_code, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 4589a1b63..7c4f0eda9 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -24,14 +24,12 @@ POST /access_codes/pull_backup_access_code ⇒ { access_code }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index 5a3955f75..2745b9164 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -16,14 +16,12 @@ POST /access_codes/simulate/create_unmanaged_access_code ⇒ { access_code }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 8a4c878c7..34efe9b98 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -20,14 +20,12 @@ PATCH /access_codes/unmanaged/convert_to_managed ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index 1d4e9fbd0..a840dc6cc 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -16,14 +16,12 @@ POST /access_codes/unmanaged/delete ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index 0ba83dfc7..d25a44588 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -18,14 +18,12 @@ POST /access_codes/unmanaged/get ⇒ { access_code }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index 521324216..c93335e9e 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -16,14 +16,12 @@ POST /access_codes/unmanaged/list ⇒ { access_codes: [unmanaged_access_code,
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index 3db1bbc5f..3d8d90501 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -16,14 +16,12 @@ PATCH /access_codes/unmanaged/update ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index 97dccd3f6..8c61a1ae8 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -18,14 +18,12 @@ PUT /access_codes/update ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index 29d3e1ae4..b1a4ac8cd 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -20,14 +20,12 @@ PATCH /access_codes/update_multiple ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 84f2fe7d3..acdac2a28 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -16,13 +16,11 @@ PUT /acs/access_groups/add_user ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index dd9784414..e1cfff542 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -16,13 +16,11 @@ POST /acs/access_groups/get ⇒ { acs_access_group }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index 6594896c0..eba22b07b 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -16,13 +16,11 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index e954b77bb..f06b38328 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -16,13 +16,11 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 1dcbbeee1..9716442ab 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -16,13 +16,11 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 7b080a649..c317315da 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -16,13 +16,11 @@ POST /acs/access_groups/remove_user ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index d21666edb..0ba2566b1 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -16,13 +16,11 @@ PATCH /acs/credentials/assign ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index dca480120..6d6e35631 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -16,13 +16,11 @@ POST /acs/credentials/create ⇒ { acs_credential }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 613ba13e4..45a73304c 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -16,13 +16,11 @@ POST /acs/credentials/delete ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 6c005bad2..1a7ee6681 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -16,13 +16,11 @@ POST /acs/credentials/get ⇒ { acs_credential }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 8e21e411b..4b704a963 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -16,14 +16,12 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index ebd6f3a76..4b1b5ddaf 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -16,13 +16,11 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 232e61319..690d076de 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -16,13 +16,11 @@ PATCH /acs/credentials/unassign ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 6cb309303..144edd1c3 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -16,13 +16,11 @@ PATCH /acs/credentials/update ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 2bdbf254d..86f277ed9 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -16,13 +16,11 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index a893ed9d5..919c6bdfb 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -16,13 +16,11 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 14489749d..3dac902fe 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -16,13 +16,11 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index f716d6875..392a4bf94 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -16,13 +16,11 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 78083d80b..c31c357e6 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -16,13 +16,11 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 0e6fe9773..b9b301754 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -16,13 +16,11 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 85559210b..329bc669f 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -16,13 +16,11 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index a89d035a2..dd6ba6b5e 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -16,12 +16,10 @@ POST /acs/entrances/get ⇒ { acs_entrance }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 9a883b840..7c3a1c3cd 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -16,13 +16,11 @@ POST /acs/entrances/grant_access ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 8ddeeca8f..8205b2b8a 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -16,14 +16,12 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index b5e559de2..17c454eee 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -16,14 +16,12 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 6d494899b..b1005de5b 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -18,13 +18,11 @@ POST /acs/systems/get ⇒ { acs_system }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index abdf608f0..485db704a 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -18,14 +18,12 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 2011f08fa..aa1ede315 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -18,13 +18,11 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 01ac90f6e..09800d0d0 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -16,13 +16,11 @@ PUT /acs/users/add_to_access_group ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 54cd0c12f..cbb220ca6 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -16,13 +16,11 @@ POST /acs/users/create ⇒ { acs_user }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 21710c68a..2b9a35a33 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -16,13 +16,11 @@ POST /acs/users/delete ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 6a9674a31..2167f7c0a 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -16,13 +16,11 @@ POST /acs/users/get ⇒ { acs_user }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 2d0873596..a626fd3c0 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -16,14 +16,12 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 4628c6312..546652e3a 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -16,14 +16,12 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance,
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index b1b001a49..4b9c0bc04 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -16,13 +16,11 @@ POST /acs/users/remove_from_access_group ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 783638a6c..2f48ff272 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -16,13 +16,11 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 90ea60928..fbcb1e1ef 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -16,13 +16,11 @@ POST /acs/users/suspend ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 833d5200a..f4a5ab2c8 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -16,13 +16,11 @@ POST /acs/users/unsuspend ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 2e06e0c0d..5b7eec9de 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -16,13 +16,11 @@ PATCH /acs/users/update ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index a1c740e06..a8dc05d82 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -16,14 +16,12 @@ POST /phones/deactivate ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 3ff4e2172..03861b76e 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -16,13 +16,11 @@ POST /phones/get ⇒ { phone }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 4109ea0e4..46c91c938 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -16,20 +16,18 @@ POST /phones/list ⇒ { phones: [phone, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters **`acs_credential_id`** *String* -ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones. +ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. --- diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 44b5453dd..aef08afa5 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -16,13 +16,11 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 40d62c12f..55c38555d 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -16,13 +16,11 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index d5b71cc26..1f0b23aed 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -16,14 +16,12 @@ POST /thermostats/cool ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index e940c9f71..5a7bec7d4 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -16,14 +16,12 @@ POST /thermostats/create_climate_preset ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index d3fd89405..91eb1a0a1 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -16,14 +16,12 @@ POST /thermostats/delete_climate_preset ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 144c757ab..ae4c0f75e 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -16,14 +16,12 @@ POST /thermostats/heat ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 6b578faca..292b622e6 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -16,14 +16,12 @@ POST /thermostats/heat_cool ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 79dc93a5a..ef4a8a895 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -16,14 +16,12 @@ POST /thermostats/list ⇒ { devices: [device, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters @@ -54,7 +52,7 @@ Date threshold for devices to return. If specified, returns only devices created **`custom_metadata_has`** *Object* -Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. +Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. --- diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 07c8fb232..5e30716c8 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -16,14 +16,12 @@ POST /thermostats/off ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 8f3e74be3..802678f69 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -16,14 +16,12 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index e4c19fb98..128bbab60 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -16,14 +16,12 @@ POST /thermostats/schedules/delete ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 5dced04fe..f60e445d9 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -16,14 +16,12 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 6c6cfea79..4c1595f0d 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -16,14 +16,12 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index 7ec5eac59..b76eecb73 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -16,14 +16,12 @@ PATCH /thermostats/schedules/update ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index c63053677..fff3431fe 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -16,13 +16,11 @@ POST /thermostats/set_fallback_climate_preset ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 3bbd22980..f665e2b87 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -16,14 +16,12 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 55b896d2d..c92c9ceb4 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -16,14 +16,12 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 58ba13573..a54c2774c 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -16,13 +16,11 @@ PATCH /thermostats/set_temperature_threshold ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index f4ab0f766..87d878486 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -16,13 +16,11 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 179fa7a22..7cb6819dd 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -16,13 +16,11 @@ POST /thermostats/simulate/temperature_reached ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 4d20bf4ec..27c49cca8 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -16,14 +16,12 @@ PATCH /thermostats/update_climate_preset ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 0e736e9d5..1d81f9cf2 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -16,13 +16,11 @@ PUT /user_identities/add_acs_user ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index b265d96cd..b130e3044 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -16,13 +16,11 @@ POST /user_identities/create ⇒ { user_identity }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 9e0ee45e5..a6b23c642 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -16,13 +16,11 @@ POST /user_identities/delete ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index a848616f6..59e6524c9 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -16,13 +16,11 @@ POST /user_identities/enrollment_automations/delete ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index cfa601bc3..eae687765 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -16,14 +16,12 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index 1aceeccd7..afe7e5890 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -16,13 +16,11 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 4d433f027..e530aaf16 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -16,14 +16,12 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations:
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 906e92ab1..cce952270 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -16,13 +16,11 @@ POST /user_identities/get ⇒ { user_identity }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index f34a8324e..2f5cb6251 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -16,13 +16,11 @@ PUT /user_identities/grant_access_to_device ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index ebc607059..72d93c4be 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -16,14 +16,12 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index a2a409a23..4293bb5f0 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -16,13 +16,11 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index a71ab7408..fc05115de 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -16,14 +16,12 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 58cdd93f7..42b99a998 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -16,13 +16,11 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] }
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index ab167cbd3..3239040a0 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -16,13 +16,11 @@ POST /user_identities/remove_acs_user ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 82d2c2bec..7f2ef5e5d 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -16,13 +16,11 @@ POST /user_identities/revoke_access_to_device ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index aa35d1057..41236bf2e 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -16,13 +16,11 @@ PATCH /user_identities/update ⇒ void
-Authentication Methods +[Authentication Methods](https://docs.seam.co/latest/api/authentication) - API key - Personal access token
Must also include the `seam-workspace` header in the request. - -To learn more, see [Authentication]{https://docs.seam.co/latest/api/authentication}.
## Request Parameters From 88ce4ca5933da1d113af64e67584447e68b844b3 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 23:17:08 -0400 Subject: [PATCH 206/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 43e4b63dc..5aff03f9a 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -40,7 +40,7 @@ {{/if}} {{#each properties}} -{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} +{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} {{#if description}} {{description}} From 5e18f7e14df500acbf60a14e3d1c815fdcc9d6eb Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 03:18:04 +0000 Subject: [PATCH 207/233] ci: Generate docs --- docs/api/access_codes/README.md | 42 +++++++-------- docs/api/access_codes/unmanaged/README.md | 24 ++++----- docs/api/acs/access_groups/README.md | 24 ++++----- docs/api/acs/credentials/README.md | 52 +++++++++---------- docs/api/acs/encoders/README.md | 12 ++--- docs/api/acs/entrances/README.md | 22 ++++---- docs/api/acs/systems/README.md | 48 ++++++++--------- docs/api/acs/users/README.md | 42 +++++++-------- docs/api/phones/README.md | 20 +++---- docs/api/thermostats/schedules/README.md | 18 +++---- docs/api/user_identities/README.md | 16 +++--- .../enrollment_automations/README.md | 10 ++-- 12 files changed, 165 insertions(+), 165 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 9bfc9a9a8..b1c6af0c1 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -51,133 +51,133 @@ In addition, for certain devices, Seam also supports [offline access codes](http ## Properties -**`access_code_id`** *UUID* +**`access_code_id`** *UUID* Unique identifier for the access code. --- -**`code`** *String* +**`code`** *String* Code used for access. Typically, a numeric or alphanumeric string. --- -**`common_code_key`** *String* +**`common_code_key`** *String* Unique identifier for a group of access codes that share the same code. --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the access code was created. --- -**`device_id`** *UUID* +**`device_id`** *UUID* Unique identifier for the device associated with the access code. --- -**`ends_at`** *Datetime* +**`ends_at`** *Datetime* Date and time after which the time-bound access code becomes inactive. --- -[**`errors`**](./#errors) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). --- -**`is_backup`** *Boolean* +**`is_backup`** *Boolean* Indicates whether the access code is a backup code. --- -**`is_backup_access_code_available`** *Boolean* +**`is_backup_access_code_available`** *Boolean* Indicates whether a backup access code is available for use if the primary access code is lost or compromised. --- -**`is_external_modification_allowed`** *Boolean* +**`is_external_modification_allowed`** *Boolean* Indicates whether changes to the access code from external sources are permitted. --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* Indicates whether Seam manages the access code. --- -**`is_offline_access_code`** *Boolean* +**`is_offline_access_code`** *Boolean* Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. --- -**`is_one_time_use`** *Boolean* +**`is_one_time_use`** *Boolean* Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. --- -**`is_scheduled_on_device`** *Boolean* +**`is_scheduled_on_device`** *Boolean* Indicates whether the code is set on the device according to a preconfigured schedule. --- -**`is_waiting_for_code_assignment`** *Boolean* +**`is_waiting_for_code_assignment`** *Boolean* Indicates whether the access code is waiting for a code assignment. --- -**`name`** *String* +**`name`** *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. --- -**`pulled_backup_access_code_id`** *UUID* +**`pulled_backup_access_code_id`** *UUID* Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. --- -**`starts_at`** *Datetime* +**`starts_at`** *Datetime* Date and time at which the time-bound access code becomes active. --- -**`status`** *Enum* +**`status`** *Enum* 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. @@ -195,7 +195,7 @@ Current status of the access code within the operational lifecycle. Values are ` --- -**`type`** *Enum* +**`type`** *Enum* Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. @@ -210,7 +210,7 @@ Nature of the access code. Values are `ongoing` for access codes that are active --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 5a0b3c009..5780a379c 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -42,77 +42,77 @@ Prior to using Seam to manage your devices, you may have used another lock manag ## Properties -**`access_code_id`** *UUID* +**`access_code_id`** *UUID* Unique identifier for the access code. --- -**`code`** *String* +**`code`** *String* Code used for access. Typically, a numeric or alphanumeric string. --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the access code was created. --- -**`device_id`** *UUID* +**`device_id`** *UUID* Unique identifier for the device associated with the access code. --- -**`ends_at`** *Datetime* +**`ends_at`** *Datetime* Date and time after which the time-bound access code becomes inactive. --- -[**`errors`**](./#errors) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* Indicates that Seam does not manage the access code. --- -**`name`** *String* +**`name`** *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. --- -**`starts_at`** *Datetime* +**`starts_at`** *Datetime* Date and time at which the time-bound access code becomes active. --- -**`status`** *String* +**`status`** *String* Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. --- -**`type`** *Enum* +**`type`** *Enum* Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. @@ -127,7 +127,7 @@ Nature of the access code. Values are `ongoing` for access codes that are active --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 5577680b8..8a8ca6383 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -40,7 +40,7 @@ To learn whether your access control system supports access groups, see the corr ## Properties -**`access_group_type`** *Enum* +**`access_group_type`** *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -61,7 +61,7 @@ To learn whether your access control system supports access groups, see the corr --- -**`access_group_type_display_name`** *String* +**`access_group_type_display_name`** *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -70,33 +70,33 @@ To learn whether your access control system supports access groups, see the corr --- -**`acs_access_group_id`** *UUID* +**`acs_access_group_id`** *UUID* ID of the access group. --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the access control system that contains the access group. --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the access group was created. --- -**`display_name`** *String* +**`display_name`** *String* --- -**`external_type`** *Enum* +**`external_type`** *Enum* Brand-specific terminology for the access group type. @@ -115,26 +115,26 @@ Brand-specific terminology for the access group type. --- -**`external_type_display_name`** *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the access group type. --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* --- -**`name`** *String* +**`name`** *String* Name of the access group. --- -**`warnings`** *List* *of Objects* +**`warnings`** *List* *of Objects* Warnings associated with the `acs_access_group`. @@ -164,7 +164,7 @@ Warnings associated with the `acs_access_group`. --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 8e9c4cc27..afa56b7de 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -54,7 +54,7 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties -**`access_method`** *Enum* +**`access_method`** *Enum* Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. @@ -70,33 +70,33 @@ Access method for the [credential](../../../capability-guides/access-systems/man --- -**`acs_credential_id`** *UUID* +**`acs_credential_id`** *UUID* ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`acs_credential_pool_id`** *UUID* +**`acs_credential_pool_id`** *UUID* --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`acs_user_id`** *UUID* +**`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. --- -**`assa_abloy_vostio_metadata`** *Object* +**`assa_abloy_vostio_metadata`** *Object* Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -128,42 +128,42 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- --- -**`card_number`** *String* +**`card_number`** *String* Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`code`** *String* +**`code`** *String* Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. --- -**`display_name`** *String* +**`display_name`** *String* Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -**`ends_at`** *String* +**`ends_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -183,7 +183,7 @@ Errors associated with the [credential](../../../capability-guides/access-system --- -**`external_type`** *Enum* +**`external_type`** *Enum* Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. @@ -203,75 +203,75 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces --- -**`external_type_display_name`** *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -**`is_issued`** *Boolean* +**`is_issued`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. --- -**`is_latest_desired_state_synced_with_provider`** *Boolean* +**`is_latest_desired_state_synced_with_provider`** *Boolean* Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* --- -**`is_multi_phone_sync_credential`** *Boolean* +**`is_multi_phone_sync_credential`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- -**`is_one_time_use`** *Boolean* +**`is_one_time_use`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. --- -**`issued_at`** *Datetime* +**`issued_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. --- -**`latest_desired_state_synced_with_provider_at`** *Datetime* +**`latest_desired_state_synced_with_provider_at`** *Datetime* Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. --- -**`parent_acs_credential_id`** *UUID* +**`parent_acs_credential_id`** *UUID* ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`starts_at`** *String* +**`starts_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`visionline_metadata`** *Object* +**`visionline_metadata`** *Object* Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -324,14 +324,14 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 04e45bbc1..5d353b6e8 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -43,35 +43,35 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties -**`acs_encoder_id`** *UUID* +**`acs_encoder_id`** *UUID* ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. --- -**`display_name`** *String* +**`display_name`** *String* Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -**`errors`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). @@ -101,7 +101,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 61dab062b..50dd5b02f 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -37,21 +37,21 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties -**`acs_entrance_id`** *UUID* +**`acs_entrance_id`** *UUID* ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -**`assa_abloy_vostio_metadata`** *Object* +**`assa_abloy_vostio_metadata`** *Object* ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -94,21 +94,21 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. --- -**`display_name`** *String* +**`display_name`** *String* Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -**`dormakaba_community_metadata`** *Object* +**`dormakaba_community_metadata`** *Object* dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -124,7 +124,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca --- -**`errors`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -148,7 +148,7 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/ --- -**`latch_metadata`** *Object* +**`latch_metadata`** *Object* Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -176,7 +176,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide --- -**`salto_ks_metadata`** *Object* +**`salto_ks_metadata`** *Object* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -220,7 +220,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu --- -**`salto_space_metadata`** *Object* +**`salto_space_metadata`** *Object* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -244,7 +244,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability --- -**`visionline_metadata`** *Object* +**`visionline_metadata`** *Object* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index bce9c2a0e..cfdb42eae 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -52,59 +52,59 @@ For details about the resources associated with an access control system, see th ## Properties -**`acs_access_group_count`** *Number* +**`acs_access_group_count`** *Number* --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`acs_user_count`** *Number* +**`acs_user_count`** *Number* --- -**`can_add_acs_users_to_acs_access_groups`** *Boolean* +**`can_add_acs_users_to_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -**`can_automate_enrollment`** *Boolean* +**`can_automate_enrollment`** *Boolean* Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`can_create_acs_access_groups`** *Boolean* +**`can_create_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -**`can_remove_acs_users_from_acs_access_groups`** *Boolean* +**`can_remove_acs_users_from_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -**`connected_account_id`** *UUID* +**`connected_account_id`** *UUID* ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`connected_account_ids`** *List* *of UUIDs* +**`connected_account_ids`** *List* *of UUIDs* IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -115,28 +115,28 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. --- -**`default_credential_manager_acs_system_id`** *UUID* +**`default_credential_manager_acs_system_id`** *UUID* ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -[**`errors`**](./#errors) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`external_type`** *Enum* +**`external_type`** *Enum* Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. @@ -162,35 +162,35 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/ --- -**`external_type_display_name`** *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. --- -**`image_alt_text`** *String* +**`image_alt_text`** *String* Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. --- -**`image_url`** *String* +**`image_url`** *String* URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`is_credential_manager`** *Boolean* +**`is_credential_manager`** *Boolean* Indicates whether the `acs_system` is a credential manager. --- -**`location`** *Object* +**`location`** *Object*
@@ -206,14 +206,14 @@ Indicates whether the `acs_system` is a credential manager. --- -**`name`** *String* +**`name`** *String* Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`system_type`** *Enum* +**`system_type`** *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -241,7 +241,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -**`system_type_display_name`** *String* +**`system_type_display_name`** *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -250,7 +250,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -**`visionline_metadata`** *Object* +**`visionline_metadata`** *Object*
@@ -278,14 +278,14 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 8c7c5cc6b..542975d93 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -49,7 +49,7 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties -**`access_schedule`** *Object* +**`access_schedule`** *Object* `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. @@ -73,35 +73,35 @@ For details about how to configure `acs_user`s in your access control system, se --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`acs_user_id`** *UUID* +**`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. --- -**`display_name`** *String* +**`display_name`** *String* Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`email`** *String* +**`email`** *String* {% hint style="warning" %} **Deprecated**. use email_address. @@ -110,21 +110,21 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -**`email_address`** *String* +**`email_address`** *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -[**`errors`**](./#errors) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`external_type`** *Enum* +**`external_type`** *Enum* Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. @@ -144,80 +144,80 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi --- -**`external_type_display_name`** *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. --- -**`full_name`** *String* +**`full_name`** *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`hid_acs_system_id`** *UUID* +**`hid_acs_system_id`** *UUID* --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* --- -**`is_suspended`** *Boolean* +**`is_suspended`** *Boolean* Indicates whether the [ACS 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). --- -**`phone_number`** *String* +**`phone_number`** *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -**`user_identity_email_address`** *String* +**`user_identity_email_address`** *String* Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`user_identity_full_name`** *String* +**`user_identity_full_name`** *String* Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`user_identity_id`** *String* +**`user_identity_id`** *String* ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`user_identity_phone_number`** *String* +**`user_identity_phone_number`** *String* Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index dddb2f04d..23bfd45a3 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -34,28 +34,28 @@ Represents an app user's mobile phone. ## Properties -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the `phone` was created. --- -**`custom_metadata`** *Record* +**`custom_metadata`** *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. --- -**`device_id`** *UUID* +**`device_id`** *UUID* ID of the `phone`. --- -**`device_type`** *Enum* +**`device_type`** *Enum* Type of phone. @@ -70,14 +70,14 @@ Type of phone. --- -**`display_name`** *String* +**`display_name`** *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. --- -**`errors`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the `phone`. @@ -97,14 +97,14 @@ Errors associated with the `phone`. --- -**`nickname`** *String* +**`nickname`** *String* Optional nickname to describe the phone, settable through Seam. --- -**`properties`** *Object* +**`properties`** *Object* Properties of the phone. @@ -158,7 +158,7 @@ Properties of the phone. --- -**`warnings`** *List* *of Objects* +**`warnings`** *List* *of Objects* Warnings associated with the `phone`. @@ -178,7 +178,7 @@ Warnings associated with the `phone`. --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 2a4eecb28..13625c628 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -33,35 +33,35 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties -**`climate_preset_key`** *String* +**`climate_preset_key`** *String* Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. --- -**`device_id`** *UUID* +**`device_id`** *UUID* ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. --- -**`ends_at`** *Datetime* +**`ends_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`errors`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). @@ -85,28 +85,28 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther --- -**`max_override_period_minutes`** *Number* +**`max_override_period_minutes`** *Number* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`name`** *String* +**`name`** *String* User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -**`starts_at`** *Datetime* +**`starts_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`thermostat_schedule_id`** *UUID* +**`thermostat_schedule_id`** *UUID* ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 5a0d66066..01979a55f 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -32,52 +32,52 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the user identity was created. --- -**`display_name`** *String* +**`display_name`** *String* --- -**`email_address`** *String* +**`email_address`** *String* Unique email address for the user identity. --- -**`full_name`** *String* +**`full_name`** *String* --- -**`phone_number`** *String* +**`phone_number`** *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- -**`user_identity_id`** *UUID* +**`user_identity_id`** *UUID* ID of the user identity. --- -**`user_identity_key`** *String* +**`user_identity_key`** *String* Unique key for the user identity. --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index e5a419788..07f4cfaa4 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -29,35 +29,35 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the enrollment automation was created. --- -**`credential_manager_acs_system_id`** *UUID* +**`credential_manager_acs_system_id`** *UUID* ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. --- -**`enrollment_automation_id`** *UUID* +**`enrollment_automation_id`** *UUID* ID of the enrollment automation. --- -**`user_identity_id`** *UUID* +**`user_identity_id`** *UUID* ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. From 99dde1c2566951aae3c0a570cd4bf7a74cf11a29 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 23:18:26 -0400 Subject: [PATCH 208/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 924cbe691..2f3d2f4df 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -32,7 +32,7 @@ {{#if request.parameters.length}} {{#each request.parameters}} -**`{{this.name}}`** *{{this.jsonType}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}}{{#if this.required}} (Required){{/if}} +**`{{this.name}}`** *{{this.jsonType}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}}{{#if this.required}} (Required){{/if}}{#{{this.name}}} {{#if this.description}} {{this.description}} From 24105d42c4563b8d16839a3a0d45f23fc8162670 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 23:21:40 -0400 Subject: [PATCH 209/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 2f3d2f4df..924cbe691 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -32,7 +32,7 @@ {{#if request.parameters.length}} {{#each request.parameters}} -**`{{this.name}}`** *{{this.jsonType}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}}{{#if this.required}} (Required){{/if}}{#{{this.name}}} +**`{{this.name}}`** *{{this.jsonType}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}}{{#if this.required}} (Required){{/if}} {{#if this.description}} {{this.description}} From f09b6019fd439558ccb3bf1890d31dd1b444582c Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 23:23:25 -0400 Subject: [PATCH 210/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 5aff03f9a..43e4b63dc 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -40,7 +40,7 @@ {{/if}} {{#each properties}} -{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} +{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} {{#if description}} {{description}} From 7ca39cc5dfe2a1b9bdc8f5665c6fbe5675bdff7c Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 03:24:23 +0000 Subject: [PATCH 211/233] ci: Generate docs --- docs/api/access_codes/README.md | 42 +++++++-------- docs/api/access_codes/unmanaged/README.md | 24 ++++----- docs/api/acs/access_groups/README.md | 24 ++++----- docs/api/acs/credentials/README.md | 52 +++++++++---------- docs/api/acs/encoders/README.md | 12 ++--- docs/api/acs/entrances/README.md | 22 ++++---- docs/api/acs/systems/README.md | 48 ++++++++--------- docs/api/acs/users/README.md | 42 +++++++-------- docs/api/phones/README.md | 20 +++---- docs/api/thermostats/schedules/README.md | 18 +++---- docs/api/user_identities/README.md | 16 +++--- .../enrollment_automations/README.md | 10 ++-- 12 files changed, 165 insertions(+), 165 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index b1c6af0c1..9bfc9a9a8 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -51,133 +51,133 @@ In addition, for certain devices, Seam also supports [offline access codes](http ## Properties -**`access_code_id`** *UUID* +**`access_code_id`** *UUID* Unique identifier for the access code. --- -**`code`** *String* +**`code`** *String* Code used for access. Typically, a numeric or alphanumeric string. --- -**`common_code_key`** *String* +**`common_code_key`** *String* Unique identifier for a group of access codes that share the same code. --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the access code was created. --- -**`device_id`** *UUID* +**`device_id`** *UUID* Unique identifier for the device associated with the access code. --- -**`ends_at`** *Datetime* +**`ends_at`** *Datetime* Date and time after which the time-bound access code becomes inactive. --- -[**`errors`**](./#errors) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). --- -**`is_backup`** *Boolean* +**`is_backup`** *Boolean* Indicates whether the access code is a backup code. --- -**`is_backup_access_code_available`** *Boolean* +**`is_backup_access_code_available`** *Boolean* Indicates whether a backup access code is available for use if the primary access code is lost or compromised. --- -**`is_external_modification_allowed`** *Boolean* +**`is_external_modification_allowed`** *Boolean* Indicates whether changes to the access code from external sources are permitted. --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* Indicates whether Seam manages the access code. --- -**`is_offline_access_code`** *Boolean* +**`is_offline_access_code`** *Boolean* Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. --- -**`is_one_time_use`** *Boolean* +**`is_one_time_use`** *Boolean* Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. --- -**`is_scheduled_on_device`** *Boolean* +**`is_scheduled_on_device`** *Boolean* Indicates whether the code is set on the device according to a preconfigured schedule. --- -**`is_waiting_for_code_assignment`** *Boolean* +**`is_waiting_for_code_assignment`** *Boolean* Indicates whether the access code is waiting for a code assignment. --- -**`name`** *String* +**`name`** *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. --- -**`pulled_backup_access_code_id`** *UUID* +**`pulled_backup_access_code_id`** *UUID* Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. --- -**`starts_at`** *Datetime* +**`starts_at`** *Datetime* Date and time at which the time-bound access code becomes active. --- -**`status`** *Enum* +**`status`** *Enum* 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. @@ -195,7 +195,7 @@ Current status of the access code within the operational lifecycle. Values are ` --- -**`type`** *Enum* +**`type`** *Enum* Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. @@ -210,7 +210,7 @@ Nature of the access code. Values are `ongoing` for access codes that are active --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 5780a379c..5a0b3c009 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -42,77 +42,77 @@ Prior to using Seam to manage your devices, you may have used another lock manag ## Properties -**`access_code_id`** *UUID* +**`access_code_id`** *UUID* Unique identifier for the access code. --- -**`code`** *String* +**`code`** *String* Code used for access. Typically, a numeric or alphanumeric string. --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the access code was created. --- -**`device_id`** *UUID* +**`device_id`** *UUID* Unique identifier for the device associated with the access code. --- -**`ends_at`** *Datetime* +**`ends_at`** *Datetime* Date and time after which the time-bound access code becomes inactive. --- -[**`errors`**](./#errors) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* Indicates that Seam does not manage the access code. --- -**`name`** *String* +**`name`** *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. --- -**`starts_at`** *Datetime* +**`starts_at`** *Datetime* Date and time at which the time-bound access code becomes active. --- -**`status`** *String* +**`status`** *String* Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. --- -**`type`** *Enum* +**`type`** *Enum* Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. @@ -127,7 +127,7 @@ Nature of the access code. Values are `ongoing` for access codes that are active --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 8a8ca6383..5577680b8 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -40,7 +40,7 @@ To learn whether your access control system supports access groups, see the corr ## Properties -**`access_group_type`** *Enum* +**`access_group_type`** *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -61,7 +61,7 @@ To learn whether your access control system supports access groups, see the corr --- -**`access_group_type_display_name`** *String* +**`access_group_type_display_name`** *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -70,33 +70,33 @@ To learn whether your access control system supports access groups, see the corr --- -**`acs_access_group_id`** *UUID* +**`acs_access_group_id`** *UUID* ID of the access group. --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the access control system that contains the access group. --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the access group was created. --- -**`display_name`** *String* +**`display_name`** *String* --- -**`external_type`** *Enum* +**`external_type`** *Enum* Brand-specific terminology for the access group type. @@ -115,26 +115,26 @@ Brand-specific terminology for the access group type. --- -**`external_type_display_name`** *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the access group type. --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* --- -**`name`** *String* +**`name`** *String* Name of the access group. --- -**`warnings`** *List* *of Objects* +**`warnings`** *List* *of Objects* Warnings associated with the `acs_access_group`. @@ -164,7 +164,7 @@ Warnings associated with the `acs_access_group`. --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index afa56b7de..8e9c4cc27 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -54,7 +54,7 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties -**`access_method`** *Enum* +**`access_method`** *Enum* Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. @@ -70,33 +70,33 @@ Access method for the [credential](../../../capability-guides/access-systems/man --- -**`acs_credential_id`** *UUID* +**`acs_credential_id`** *UUID* ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`acs_credential_pool_id`** *UUID* +**`acs_credential_pool_id`** *UUID* --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`acs_user_id`** *UUID* +**`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. --- -**`assa_abloy_vostio_metadata`** *Object* +**`assa_abloy_vostio_metadata`** *Object* Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -128,42 +128,42 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access- --- -**`card_number`** *String* +**`card_number`** *String* Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`code`** *String* +**`code`** *String* Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. --- -**`display_name`** *String* +**`display_name`** *String* Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -**`ends_at`** *String* +**`ends_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -183,7 +183,7 @@ Errors associated with the [credential](../../../capability-guides/access-system --- -**`external_type`** *Enum* +**`external_type`** *Enum* Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. @@ -203,75 +203,75 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces --- -**`external_type_display_name`** *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. --- -**`is_issued`** *Boolean* +**`is_issued`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. --- -**`is_latest_desired_state_synced_with_provider`** *Boolean* +**`is_latest_desired_state_synced_with_provider`** *Boolean* Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* --- -**`is_multi_phone_sync_credential`** *Boolean* +**`is_multi_phone_sync_credential`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- -**`is_one_time_use`** *Boolean* +**`is_one_time_use`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. --- -**`issued_at`** *Datetime* +**`issued_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. --- -**`latest_desired_state_synced_with_provider_at`** *Datetime* +**`latest_desired_state_synced_with_provider_at`** *Datetime* Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. --- -**`parent_acs_credential_id`** *UUID* +**`parent_acs_credential_id`** *UUID* ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`starts_at`** *String* +**`starts_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`visionline_metadata`** *Object* +**`visionline_metadata`** *Object* Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -324,14 +324,14 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 5d353b6e8..04e45bbc1 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -43,35 +43,35 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties -**`acs_encoder_id`** *UUID* +**`acs_encoder_id`** *UUID* ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. --- -**`display_name`** *String* +**`display_name`** *String* Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). --- -**`errors`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). @@ -101,7 +101,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 50dd5b02f..61dab062b 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -37,21 +37,21 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties -**`acs_entrance_id`** *UUID* +**`acs_entrance_id`** *UUID* ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -**`assa_abloy_vostio_metadata`** *Object* +**`assa_abloy_vostio_metadata`** *Object* ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -94,21 +94,21 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. --- -**`display_name`** *String* +**`display_name`** *String* Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). --- -**`dormakaba_community_metadata`** *Object* +**`dormakaba_community_metadata`** *Object* dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -124,7 +124,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca --- -**`errors`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -148,7 +148,7 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/ --- -**`latch_metadata`** *Object* +**`latch_metadata`** *Object* Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -176,7 +176,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide --- -**`salto_ks_metadata`** *Object* +**`salto_ks_metadata`** *Object* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -220,7 +220,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu --- -**`salto_space_metadata`** *Object* +**`salto_space_metadata`** *Object* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -244,7 +244,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability --- -**`visionline_metadata`** *Object* +**`visionline_metadata`** *Object* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index cfdb42eae..bce9c2a0e 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -52,59 +52,59 @@ For details about the resources associated with an access control system, see th ## Properties -**`acs_access_group_count`** *Number* +**`acs_access_group_count`** *Number* --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`acs_user_count`** *Number* +**`acs_user_count`** *Number* --- -**`can_add_acs_users_to_acs_access_groups`** *Boolean* +**`can_add_acs_users_to_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -**`can_automate_enrollment`** *Boolean* +**`can_automate_enrollment`** *Boolean* Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`can_create_acs_access_groups`** *Boolean* +**`can_create_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -**`can_remove_acs_users_from_acs_access_groups`** *Boolean* +**`can_remove_acs_users_from_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). --- -**`connected_account_id`** *UUID* +**`connected_account_id`** *UUID* ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`connected_account_ids`** *List* *of UUIDs* +**`connected_account_ids`** *List* *of UUIDs* IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -115,28 +115,28 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. --- -**`default_credential_manager_acs_system_id`** *UUID* +**`default_credential_manager_acs_system_id`** *UUID* ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -[**`errors`**](./#errors) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`external_type`** *Enum* +**`external_type`** *Enum* Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. @@ -162,35 +162,35 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/ --- -**`external_type_display_name`** *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. --- -**`image_alt_text`** *String* +**`image_alt_text`** *String* Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. --- -**`image_url`** *String* +**`image_url`** *String* URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`is_credential_manager`** *Boolean* +**`is_credential_manager`** *Boolean* Indicates whether the `acs_system` is a credential manager. --- -**`location`** *Object* +**`location`** *Object*
@@ -206,14 +206,14 @@ Indicates whether the `acs_system` is a credential manager. --- -**`name`** *String* +**`name`** *String* Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`system_type`** *Enum* +**`system_type`** *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -241,7 +241,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -**`system_type_display_name`** *String* +**`system_type_display_name`** *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -250,7 +250,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -**`visionline_metadata`** *Object* +**`visionline_metadata`** *Object*
@@ -278,14 +278,14 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 542975d93..8c7c5cc6b 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -49,7 +49,7 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties -**`access_schedule`** *Object* +**`access_schedule`** *Object* `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. @@ -73,35 +73,35 @@ For details about how to configure `acs_user`s in your access control system, se --- -**`acs_system_id`** *UUID* +**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`acs_user_id`** *UUID* +**`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. --- -**`display_name`** *String* +**`display_name`** *String* Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`email`** *String* +**`email`** *String* {% hint style="warning" %} **Deprecated**. use email_address. @@ -110,21 +110,21 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac --- -**`email_address`** *String* +**`email_address`** *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -[**`errors`**](./#errors) *List* *of Objects* +[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`external_type`** *Enum* +**`external_type`** *Enum* Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. @@ -144,80 +144,80 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi --- -**`external_type_display_name`** *String* +**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. --- -**`full_name`** *String* +**`full_name`** *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`hid_acs_system_id`** *UUID* +**`hid_acs_system_id`** *UUID* --- -**`is_managed`** *Boolean* +**`is_managed`** *Boolean* --- -**`is_suspended`** *Boolean* +**`is_suspended`** *Boolean* Indicates whether the [ACS 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). --- -**`phone_number`** *String* +**`phone_number`** *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -**`user_identity_email_address`** *String* +**`user_identity_email_address`** *String* Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`user_identity_full_name`** *String* +**`user_identity_full_name`** *String* Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`user_identity_id`** *String* +**`user_identity_id`** *String* ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`user_identity_phone_number`** *String* +**`user_identity_phone_number`** *String* Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- -[**`warnings`**](./#warnings) *List* *of Objects* +[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 23bfd45a3..dddb2f04d 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -34,28 +34,28 @@ Represents an app user's mobile phone. ## Properties -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the `phone` was created. --- -**`custom_metadata`** *Record* +**`custom_metadata`** *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. --- -**`device_id`** *UUID* +**`device_id`** *UUID* ID of the `phone`. --- -**`device_type`** *Enum* +**`device_type`** *Enum* Type of phone. @@ -70,14 +70,14 @@ Type of phone. --- -**`display_name`** *String* +**`display_name`** *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. --- -**`errors`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the `phone`. @@ -97,14 +97,14 @@ Errors associated with the `phone`. --- -**`nickname`** *String* +**`nickname`** *String* Optional nickname to describe the phone, settable through Seam. --- -**`properties`** *Object* +**`properties`** *Object* Properties of the phone. @@ -158,7 +158,7 @@ Properties of the phone. --- -**`warnings`** *List* *of Objects* +**`warnings`** *List* *of Objects* Warnings associated with the `phone`. @@ -178,7 +178,7 @@ Warnings associated with the `phone`. --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 13625c628..2a4eecb28 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -33,35 +33,35 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties -**`climate_preset_key`** *String* +**`climate_preset_key`** *String* Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. --- -**`device_id`** *UUID* +**`device_id`** *UUID* ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. --- -**`ends_at`** *Datetime* +**`ends_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`errors`** *List* *of Objects* +**`errors`** *List* *of Objects* Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). @@ -85,28 +85,28 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther --- -**`max_override_period_minutes`** *Number* +**`max_override_period_minutes`** *Number* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- -**`name`** *String* +**`name`** *String* User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). --- -**`starts_at`** *Datetime* +**`starts_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- -**`thermostat_schedule_id`** *UUID* +**`thermostat_schedule_id`** *UUID* ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 01979a55f..5a0d66066 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -32,52 +32,52 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the user identity was created. --- -**`display_name`** *String* +**`display_name`** *String* --- -**`email_address`** *String* +**`email_address`** *String* Unique email address for the user identity. --- -**`full_name`** *String* +**`full_name`** *String* --- -**`phone_number`** *String* +**`phone_number`** *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- -**`user_identity_id`** *UUID* +**`user_identity_id`** *UUID* ID of the user identity. --- -**`user_identity_key`** *String* +**`user_identity_key`** *String* Unique key for the user identity. --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 07f4cfaa4..e5a419788 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -29,35 +29,35 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties -**`created_at`** *Datetime* +**`created_at`** *Datetime* Date and time at which the enrollment automation was created. --- -**`credential_manager_acs_system_id`** *UUID* +**`credential_manager_acs_system_id`** *UUID* ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. --- -**`enrollment_automation_id`** *UUID* +**`enrollment_automation_id`** *UUID* ID of the enrollment automation. --- -**`user_identity_id`** *UUID* +**`user_identity_id`** *UUID* ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). --- -**`workspace_id`** *UUID* +**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. From efa3f8c0c03eefd85270962965ae7e621a27e6fa Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 23:29:37 -0400 Subject: [PATCH 212/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 924cbe691..9c0e9502d 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -17,7 +17,7 @@ {{#if authMethods}}
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods {{#each authMethods}} - {{this}} @@ -25,6 +25,8 @@
{{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} {{/if}} {{/each}} + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
{{/if}} From 8a49a3fee60d8d32c3a77a2a0183ca13a7c08042 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 03:30:38 +0000 Subject: [PATCH 213/233] ci: Generate docs --- docs/api/access_codes/create.md | 4 +++- docs/api/access_codes/create_multiple.md | 4 +++- docs/api/access_codes/delete.md | 4 +++- docs/api/access_codes/get.md | 4 +++- docs/api/access_codes/list.md | 4 +++- docs/api/access_codes/pull_backup_access_code.md | 4 +++- .../api/access_codes/simulate/create_unmanaged_access_code.md | 4 +++- docs/api/access_codes/unmanaged/convert_to_managed.md | 4 +++- docs/api/access_codes/unmanaged/delete.md | 4 +++- docs/api/access_codes/unmanaged/get.md | 4 +++- docs/api/access_codes/unmanaged/list.md | 4 +++- docs/api/access_codes/unmanaged/update.md | 4 +++- docs/api/access_codes/update.md | 4 +++- docs/api/access_codes/update_multiple.md | 4 +++- docs/api/acs/access_groups/add_user.md | 4 +++- docs/api/acs/access_groups/get.md | 4 +++- docs/api/acs/access_groups/list.md | 4 +++- docs/api/acs/access_groups/list_accessible_entrances.md | 4 +++- docs/api/acs/access_groups/list_users.md | 4 +++- docs/api/acs/access_groups/remove_user.md | 4 +++- docs/api/acs/credentials/assign.md | 4 +++- docs/api/acs/credentials/create.md | 4 +++- docs/api/acs/credentials/delete.md | 4 +++- docs/api/acs/credentials/get.md | 4 +++- docs/api/acs/credentials/list.md | 4 +++- docs/api/acs/credentials/list_accessible_entrances.md | 4 +++- docs/api/acs/credentials/unassign.md | 4 +++- docs/api/acs/credentials/update.md | 4 +++- docs/api/acs/encoders/encode_credential.md | 4 +++- docs/api/acs/encoders/list.md | 4 +++- docs/api/acs/encoders/scan_credential.md | 4 +++- .../acs/encoders/simulate/next_credential_encode_will_fail.md | 4 +++- .../encoders/simulate/next_credential_encode_will_succeed.md | 4 +++- .../acs/encoders/simulate/next_credential_scan_will_fail.md | 4 +++- .../encoders/simulate/next_credential_scan_will_succeed.md | 4 +++- docs/api/acs/entrances/get.md | 4 +++- docs/api/acs/entrances/grant_access.md | 4 +++- docs/api/acs/entrances/list.md | 4 +++- docs/api/acs/entrances/list_credentials_with_access.md | 4 +++- docs/api/acs/systems/get.md | 4 +++- docs/api/acs/systems/list.md | 4 +++- .../systems/list_compatible_credential_manager_acs_systems.md | 4 +++- docs/api/acs/users/add_to_access_group.md | 4 +++- docs/api/acs/users/create.md | 4 +++- docs/api/acs/users/delete.md | 4 +++- docs/api/acs/users/get.md | 4 +++- docs/api/acs/users/list.md | 4 +++- docs/api/acs/users/list_accessible_entrances.md | 4 +++- docs/api/acs/users/remove_from_access_group.md | 4 +++- docs/api/acs/users/revoke_access_to_all_entrances.md | 4 +++- docs/api/acs/users/suspend.md | 4 +++- docs/api/acs/users/unsuspend.md | 4 +++- docs/api/acs/users/update.md | 4 +++- docs/api/phones/deactivate.md | 4 +++- docs/api/phones/get.md | 4 +++- docs/api/phones/list.md | 4 +++- docs/api/phones/simulate/create_sandbox_phone.md | 4 +++- docs/api/thermostats/activate_climate_preset.md | 4 +++- docs/api/thermostats/cool.md | 4 +++- docs/api/thermostats/create_climate_preset.md | 4 +++- docs/api/thermostats/delete_climate_preset.md | 4 +++- docs/api/thermostats/heat.md | 4 +++- docs/api/thermostats/heat_cool.md | 4 +++- docs/api/thermostats/list.md | 4 +++- docs/api/thermostats/off.md | 4 +++- docs/api/thermostats/schedules/create.md | 4 +++- docs/api/thermostats/schedules/delete.md | 4 +++- docs/api/thermostats/schedules/get.md | 4 +++- docs/api/thermostats/schedules/list.md | 4 +++- docs/api/thermostats/schedules/update.md | 4 +++- docs/api/thermostats/set_fallback_climate_preset.md | 4 +++- docs/api/thermostats/set_fan_mode.md | 4 +++- docs/api/thermostats/set_hvac_mode.md | 4 +++- docs/api/thermostats/set_temperature_threshold.md | 4 +++- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 4 +++- docs/api/thermostats/simulate/temperature_reached.md | 4 +++- docs/api/thermostats/update_climate_preset.md | 4 +++- docs/api/user_identities/add_acs_user.md | 4 +++- docs/api/user_identities/create.md | 4 +++- docs/api/user_identities/delete.md | 4 +++- docs/api/user_identities/enrollment_automations/delete.md | 4 +++- docs/api/user_identities/enrollment_automations/get.md | 4 +++- docs/api/user_identities/enrollment_automations/launch.md | 4 +++- docs/api/user_identities/enrollment_automations/list.md | 4 +++- docs/api/user_identities/get.md | 4 +++- docs/api/user_identities/grant_access_to_device.md | 4 +++- docs/api/user_identities/list.md | 4 +++- docs/api/user_identities/list_accessible_devices.md | 4 +++- docs/api/user_identities/list_acs_systems.md | 4 +++- docs/api/user_identities/list_acs_users.md | 4 +++- docs/api/user_identities/remove_acs_user.md | 4 +++- docs/api/user_identities/revoke_access_to_device.md | 4 +++- docs/api/user_identities/update.md | 4 +++- 93 files changed, 279 insertions(+), 93 deletions(-) diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index d07f74653..09590edc7 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -16,12 +16,14 @@ POST /access_codes/create ⇒ { access_code }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 7b80ee578..38c3807d4 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -24,12 +24,14 @@ PUT /access_codes/create_multiple ⇒ { access_codes: [access_code, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index beaf3fd48..b7465f2c9 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -16,12 +16,14 @@ POST /access_codes/delete ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 2c2198d83..878e2dd04 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -18,10 +18,12 @@ POST /access_codes/get ⇒ { access_code }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 69cc6b65b..771b44918 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -18,12 +18,14 @@ POST /access_codes/list ⇒ { access_codes: [access_code, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 7c4f0eda9..48ff7116c 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -24,12 +24,14 @@ POST /access_codes/pull_backup_access_code ⇒ { access_code }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index 2745b9164..9dea2b849 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -16,12 +16,14 @@ POST /access_codes/simulate/create_unmanaged_access_code ⇒ { access_code }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 34efe9b98..0bc7123cc 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -20,12 +20,14 @@ PATCH /access_codes/unmanaged/convert_to_managed ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index a840dc6cc..25eb0a93f 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -16,12 +16,14 @@ POST /access_codes/unmanaged/delete ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index d25a44588..53035d0fd 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -18,12 +18,14 @@ POST /access_codes/unmanaged/get ⇒ { access_code }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index c93335e9e..439b309ea 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -16,12 +16,14 @@ POST /access_codes/unmanaged/list ⇒ { access_codes: [unmanaged_access_code,
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index 3d8d90501..a7fd10c5c 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -16,12 +16,14 @@ PATCH /access_codes/unmanaged/update ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index 8c61a1ae8..92c7a07ee 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -18,12 +18,14 @@ PUT /access_codes/update ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index b1a4ac8cd..358f7d784 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -20,12 +20,14 @@ PATCH /access_codes/update_multiple ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index acdac2a28..069608143 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -16,11 +16,13 @@ PUT /acs/access_groups/add_user ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index e1cfff542..efb8009ca 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -16,11 +16,13 @@ POST /acs/access_groups/get ⇒ { acs_access_group }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index eba22b07b..a2092ee9a 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -16,11 +16,13 @@ POST /acs/access_groups/list ⇒ { acs_access_groups: [acs_access_group, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index f06b38328..19fa4e62d 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -16,11 +16,13 @@ POST /acs/access_groups/list_accessible_entrances ⇒ { acs_entrances: [acs_entr
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 9716442ab..9872c0bd6 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -16,11 +16,13 @@ POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index c317315da..6d1f38607 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -16,11 +16,13 @@ POST /acs/access_groups/remove_user ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 0ba2566b1..98b348863 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -16,11 +16,13 @@ PATCH /acs/credentials/assign ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 6d6e35631..c440f996d 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -16,11 +16,13 @@ POST /acs/credentials/create ⇒ { acs_credential }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 45a73304c..c177daf54 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -16,11 +16,13 @@ POST /acs/credentials/delete ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 1a7ee6681..99eb175a1 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -16,11 +16,13 @@ POST /acs/credentials/get ⇒ { acs_credential }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 4b704a963..5d0f8ac2b 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -16,12 +16,14 @@ POST /acs/credentials/list ⇒ { acs_credentials: [acs_credential, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 4b1b5ddaf..3551ec95a 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -16,11 +16,13 @@ POST /acs/credentials/list_accessible_entrances ⇒ { acs_entrances: [acs_entran
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 690d076de..a43b0dc0e 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -16,11 +16,13 @@ PATCH /acs/credentials/unassign ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 144edd1c3..48cd40220 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -16,11 +16,13 @@ PATCH /acs/credentials/update ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 86f277ed9..40d544be3 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -16,11 +16,13 @@ POST /acs/encoders/encode_credential ⇒ { action_attempt }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 919c6bdfb..71cdaa187 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -16,11 +16,13 @@ POST /acs/encoders/list ⇒ { acs_encoders: [acs_encoder, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 3dac902fe..101d17445 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -16,11 +16,13 @@ POST /acs/encoders/scan_credential ⇒ { action_attempt }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 392a4bf94..b14437d20 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -16,11 +16,13 @@ POST /acs/encoders/simulate/next_credential_encode_will_fail ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index c31c357e6..cf65a0918 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -16,11 +16,13 @@ POST /acs/encoders/simulate/next_credential_encode_will_succeed ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index b9b301754..308d70237 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -16,11 +16,13 @@ POST /acs/encoders/simulate/next_credential_scan_will_fail ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 329bc669f..f3802da18 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -16,11 +16,13 @@ POST /acs/encoders/simulate/next_credential_scan_will_succeed ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index dd6ba6b5e..ac234ca30 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -16,10 +16,12 @@ POST /acs/entrances/get ⇒ { acs_entrance }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 7c3a1c3cd..eac8bc075 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -16,11 +16,13 @@ POST /acs/entrances/grant_access ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 8205b2b8a..d876b0054 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -16,12 +16,14 @@ POST /acs/entrances/list ⇒ { acs_entrances: [acs_entrance, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 17c454eee..6925b7dd6 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -16,12 +16,14 @@ POST /acs/entrances/list_credentials_with_access ⇒ { acs_credentials: [acs_cre
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index b1005de5b..ff3d211c8 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -18,11 +18,13 @@ POST /acs/systems/get ⇒ { acs_system }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 485db704a..c63a7e005 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -18,12 +18,14 @@ POST /acs/systems/list ⇒ { acs_systems: [acs_system, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index aa1ede315..8e69f3bbd 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -18,11 +18,13 @@ POST /acs/systems/list_compatible_credential_manager_acs_systems ⇒ { acs_syste
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 09800d0d0..c4fc24a78 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -16,11 +16,13 @@ PUT /acs/users/add_to_access_group ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index cbb220ca6..e96b83539 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -16,11 +16,13 @@ POST /acs/users/create ⇒ { acs_user }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 2b9a35a33..59b00588b 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -16,11 +16,13 @@ POST /acs/users/delete ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 2167f7c0a..2ee20bba9 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -16,11 +16,13 @@ POST /acs/users/get ⇒ { acs_user }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index a626fd3c0..77ee3e652 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -16,12 +16,14 @@ POST /acs/users/list ⇒ { acs_users: [acs_user, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 546652e3a..acf996785 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -16,12 +16,14 @@ POST /acs/users/list_accessible_entrances ⇒ { acs_entrances: [acs_entrance,
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 4b9c0bc04..650eb9d90 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -16,11 +16,13 @@ POST /acs/users/remove_from_access_group ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 2f48ff272..62085c201 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -16,11 +16,13 @@ POST /acs/users/revoke_access_to_all_entrances ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index fbcb1e1ef..8e2617641 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -16,11 +16,13 @@ POST /acs/users/suspend ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index f4a5ab2c8..cb3dd3a14 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -16,11 +16,13 @@ POST /acs/users/unsuspend ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 5b7eec9de..f5c046d06 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -16,11 +16,13 @@ PATCH /acs/users/update ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index a8dc05d82..8fc235f83 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -16,12 +16,14 @@ POST /phones/deactivate ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 03861b76e..41d463f9a 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -16,11 +16,13 @@ POST /phones/get ⇒ { phone }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 46c91c938..3a029a3c8 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -16,11 +16,13 @@ POST /phones/list ⇒ { phones: [phone, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index aef08afa5..6d0b53df0 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -16,11 +16,13 @@ POST /phones/simulate/create_sandbox_phone ⇒ { phone }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 55c38555d..3df1aa214 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -16,11 +16,13 @@ POST /thermostats/activate_climate_preset ⇒ { action_attempt }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 1f0b23aed..561c6da7c 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -16,12 +16,14 @@ POST /thermostats/cool ⇒ { action_attempt }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 5a7bec7d4..bd0b9d70b 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -16,12 +16,14 @@ POST /thermostats/create_climate_preset ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 91eb1a0a1..eb486bb0b 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -16,12 +16,14 @@ POST /thermostats/delete_climate_preset ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index ae4c0f75e..c73f8fa86 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -16,12 +16,14 @@ POST /thermostats/heat ⇒ { action_attempt }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 292b622e6..05487869a 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -16,12 +16,14 @@ POST /thermostats/heat_cool ⇒ { action_attempt }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index ef4a8a895..444972c8b 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -16,12 +16,14 @@ POST /thermostats/list ⇒ { devices: [device, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 5e30716c8..b1694690f 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -16,12 +16,14 @@ POST /thermostats/off ⇒ { action_attempt }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 802678f69..dad3ec776 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -16,12 +16,14 @@ POST /thermostats/schedules/create ⇒ { thermostat_schedule }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 128bbab60..46d7b7299 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -16,12 +16,14 @@ POST /thermostats/schedules/delete ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index f60e445d9..f20321048 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -16,12 +16,14 @@ POST /thermostats/schedules/get ⇒ { thermostat_schedule }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 4c1595f0d..9193dff83 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -16,12 +16,14 @@ POST /thermostats/schedules/list ⇒ { thermostat_schedules: [thermostat_schedul
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index b76eecb73..aad85566b 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -16,12 +16,14 @@ PATCH /thermostats/schedules/update ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index fff3431fe..61bdfc64a 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -16,11 +16,13 @@ POST /thermostats/set_fallback_climate_preset ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index f665e2b87..81c4b3f7e 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -16,12 +16,14 @@ POST /thermostats/set_fan_mode ⇒ { action_attempt }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index c92c9ceb4..6534646d2 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -16,12 +16,14 @@ POST /thermostats/set_hvac_mode ⇒ { action_attempt }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index a54c2774c..267d79040 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -16,11 +16,13 @@ PATCH /thermostats/set_temperature_threshold ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 87d878486..e8c78fb7e 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -16,11 +16,13 @@ POST /thermostats/simulate/hvac_mode_adjusted ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 7cb6819dd..b099bb241 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -16,11 +16,13 @@ POST /thermostats/simulate/temperature_reached ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 27c49cca8..99108d22a 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -16,12 +16,14 @@ PATCH /thermostats/update_climate_preset ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 1d81f9cf2..53b390853 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -16,11 +16,13 @@ PUT /user_identities/add_acs_user ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index b130e3044..4caf008f8 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -16,11 +16,13 @@ POST /user_identities/create ⇒ { user_identity }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index a6b23c642..e2fa91454 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -16,11 +16,13 @@ POST /user_identities/delete ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 59e6524c9..48027ddfe 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -16,11 +16,13 @@ POST /user_identities/enrollment_automations/delete ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index eae687765..918a1ae8d 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -16,12 +16,14 @@ POST /user_identities/enrollment_automations/get ⇒ { enrollment_automation }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index afe7e5890..dadb77f39 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -16,11 +16,13 @@ POST /user_identities/enrollment_automations/launch ⇒ { enrollment_automation
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index e530aaf16..ef1924ec3 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -16,12 +16,14 @@ POST /user_identities/enrollment_automations/list ⇒ { enrollment_automations:
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index cce952270..0b9ff7504 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -16,11 +16,13 @@ POST /user_identities/get ⇒ { user_identity }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 2f5cb6251..99292e176 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -16,11 +16,13 @@ PUT /user_identities/grant_access_to_device ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 72d93c4be..3e5861bdc 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -16,12 +16,14 @@ POST /user_identities/list ⇒ { user_identities: [user_identity, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 4293bb5f0..989b56026 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -16,11 +16,13 @@ POST /user_identities/list_accessible_devices ⇒ { devices: [device, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index fc05115de..a5d80fc9e 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -16,12 +16,14 @@ POST /user_identities/list_acs_systems ⇒ { acs_systems: [acs_system, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Client session token - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index 42b99a998..f4a52b10c 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -16,11 +16,13 @@ POST /user_identities/list_acs_users ⇒ { acs_users: [acs_user, …] }
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 3239040a0..8d4f0febe 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -16,11 +16,13 @@ POST /user_identities/remove_acs_user ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 7f2ef5e5d..933386f09 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -16,11 +16,13 @@ POST /user_identities/revoke_access_to_device ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 41236bf2e..d30753698 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -16,11 +16,13 @@ PATCH /user_identities/update ⇒ void
-[Authentication Methods](https://docs.seam.co/latest/api/authentication) +Authentication Methods - API key - Personal access token
Must also include the `seam-workspace` header in the request. + +To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
## Request Parameters From 2a17fda6efa9db04993526d47c09673dcbb72d9c Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 23:41:17 -0400 Subject: [PATCH 214/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 43e4b63dc..e1580974c 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -39,9 +39,11 @@ ## Properties {{/if}} + + {{#each properties}} -{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} - + + {{/each}} +
** Property **** Description **
{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}} {{#if description}} {{description}} @@ -89,6 +91,7 @@ This object has no properties. {{/if}} ---- +
From bca3eb1a204934c9fb5d4a8a65a8375e156aadac Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 03:42:13 +0000 Subject: [PATCH 215/233] ci: Generate docs --- docs/api/access_codes/README.md | 129 +++++++------- docs/api/access_codes/unmanaged/README.md | 75 +++++---- docs/api/acs/access_groups/README.md | 75 +++++---- docs/api/acs/credentials/README.md | 159 +++++++++--------- docs/api/acs/encoders/README.md | 39 +++-- docs/api/acs/entrances/README.md | 69 ++++---- docs/api/acs/systems/README.md | 147 ++++++++-------- docs/api/acs/users/README.md | 129 +++++++------- docs/api/phones/README.md | 63 +++---- docs/api/thermostats/schedules/README.md | 57 ++++--- docs/api/user_identities/README.md | 51 +++--- .../enrollment_automations/README.md | 33 ++-- 12 files changed, 531 insertions(+), 495 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 9bfc9a9a8..6fb2fa7f9 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -51,134 +51,136 @@ In addition, for certain devices, Seam also supports [offline access codes](http ## Properties -**`access_code_id`** *UUID* - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
** Property **** Description **
**`access_code_id`** *UUID* Unique identifier for the access code. ---- - -**`code`** *String* +
**`code`** *String* Code used for access. Typically, a numeric or alphanumeric string. ---- - -**`common_code_key`** *String* +
**`common_code_key`** *String* Unique identifier for a group of access codes that share the same code. ---- - -**`created_at`** *Datetime* +
**`created_at`** *Datetime* Date and time at which the access code was created. ---- - -**`device_id`** *UUID* +
**`device_id`** *UUID* Unique identifier for the device associated with the access code. ---- - -**`ends_at`** *Datetime* +
**`ends_at`** *Datetime* Date and time after which the time-bound access code becomes inactive. ---- - -[**`errors`**](./#errors) *List* *of Objects* +
[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). ---- - -**`is_backup`** *Boolean* +
**`is_backup`** *Boolean* Indicates whether the access code is a backup code. ---- - -**`is_backup_access_code_available`** *Boolean* +
**`is_backup_access_code_available`** *Boolean* Indicates whether a backup access code is available for use if the primary access code is lost or compromised. ---- - -**`is_external_modification_allowed`** *Boolean* +
**`is_external_modification_allowed`** *Boolean* Indicates whether changes to the access code from external sources are permitted. ---- - -**`is_managed`** *Boolean* +
**`is_managed`** *Boolean* Indicates whether Seam manages the access code. ---- - -**`is_offline_access_code`** *Boolean* +
**`is_offline_access_code`** *Boolean* Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. ---- - -**`is_one_time_use`** *Boolean* +
**`is_one_time_use`** *Boolean* Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. ---- - -**`is_scheduled_on_device`** *Boolean* +
**`is_scheduled_on_device`** *Boolean* Indicates whether the code is set on the device according to a preconfigured schedule. ---- - -**`is_waiting_for_code_assignment`** *Boolean* +
**`is_waiting_for_code_assignment`** *Boolean* Indicates whether the access code is waiting for a code assignment. ---- - -**`name`** *String* +
**`name`** *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. ---- - -**`pulled_backup_access_code_id`** *UUID* +
**`pulled_backup_access_code_id`** *UUID* Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. ---- - -**`starts_at`** *Datetime* +
**`starts_at`** *Datetime* Date and time at which the time-bound access code becomes active. ---- - -**`status`** *Enum* +
**`status`** *Enum* 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.
@@ -193,10 +195,10 @@ Current status of the access code within the operational lifecycle. Values are `
---- - -**`type`** *Enum* +
**`type`** *Enum* Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.
@@ -208,15 +210,16 @@ Nature of the access code. Values are `ongoing` for access codes that are active
---- - -[**`warnings`**](./#warnings) *List* *of Objects* +
[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). ---- +
## Errors diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 5a0b3c009..4e24b98f3 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -42,78 +42,80 @@ Prior to using Seam to manage your devices, you may have used another lock manag ## Properties -**`access_code_id`** *UUID* - + + + + + + + + + + + + + + + + + + + + + + + + + + +
** Property **** Description **
**`access_code_id`** *UUID* Unique identifier for the access code. ---- - -**`code`** *String* +
**`code`** *String* Code used for access. Typically, a numeric or alphanumeric string. ---- - -**`created_at`** *Datetime* +
**`created_at`** *Datetime* Date and time at which the access code was created. ---- - -**`device_id`** *UUID* +
**`device_id`** *UUID* Unique identifier for the device associated with the access code. ---- - -**`ends_at`** *Datetime* +
**`ends_at`** *Datetime* Date and time after which the time-bound access code becomes inactive. ---- - -[**`errors`**](./#errors) *List* *of Objects* +
[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). ---- - -**`is_managed`** *Boolean* +
**`is_managed`** *Boolean* Indicates that Seam does not manage the access code. ---- - -**`name`** *String* +
**`name`** *String* Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. ---- - -**`starts_at`** *Datetime* +
**`starts_at`** *Datetime* Date and time at which the time-bound access code becomes active. ---- - -**`status`** *String* +
**`status`** *String* Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. ---- - -**`type`** *Enum* +
**`type`** *Enum* Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.
@@ -125,15 +127,16 @@ Nature of the access code. Values are `ongoing` for access codes that are active
---- - -[**`warnings`**](./#warnings) *List* *of Objects* +
[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). ---- +
## Errors diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 5577680b8..440aee7c9 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -40,8 +40,10 @@ To learn whether your access control system supports access groups, see the corr ## Properties -**`access_group_type`** *Enum* - + + + + + + + + + + + + ---- + + + + + + ---- + + + + + + + + +
** Property **** Description **
**`access_group_type`** *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} @@ -59,45 +61,45 @@ To learn whether your access control system supports access groups, see the corr ---- - -**`access_group_type_display_name`** *String* +
**`access_group_type_display_name`** *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} ---- - -**`acs_access_group_id`** *UUID* +
**`acs_access_group_id`** *UUID* ID of the access group. ---- - -**`acs_system_id`** *UUID* +
**`acs_system_id`** *UUID* ID of the access control system that contains the access group. ---- - -**`created_at`** *Datetime* +
**`created_at`** *Datetime* Date and time at which the access group was created. ---- - -**`display_name`** *String* - +
**`display_name`** *String* -**`external_type`** *Enum* +
**`external_type`** *Enum* Brand-specific terminology for the access group type.
@@ -113,29 +115,29 @@ Brand-specific terminology for the access group type.
---- - -**`external_type_display_name`** *String* +
**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the access group type. ---- - -**`is_managed`** *Boolean* - +
**`is_managed`** *Boolean* -**`name`** *String* +
**`name`** *String* Name of the access group. ---- - -**`warnings`** *List* *of Objects* +
**`warnings`** *List* *of Objects* Warnings associated with the `acs_access_group`.
@@ -162,15 +164,16 @@ Warnings associated with the `acs_access_group`.
---- - -**`workspace_id`** *UUID* +
**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. ---- +
## Events diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 8e9c4cc27..5758bc95d 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -54,8 +54,10 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties -**`access_method`** *Enum* - + + + + + + -**`acs_credential_pool_id`** *UUID* - - ---- + + + + + + + + + + + + + + + + + + + + + + + + + + + + -**`is_managed`** *Boolean* + + ---- - -**`is_multi_phone_sync_credential`** *Boolean* - + + + + + + + + + + + + + + + + + + +
** Property **** Description **
**`access_method`** *Enum* Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`.
@@ -68,36 +70,36 @@ Access method for the [credential](../../../capability-guides/access-systems/man
---- - -**`acs_credential_id`** *UUID* +
**`acs_credential_id`** *UUID* ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- +
**`acs_credential_pool_id`** *UUID* -**`acs_system_id`** *UUID* +
**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- - -**`acs_user_id`** *UUID* +
**`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs. ---- - -**`assa_abloy_vostio_metadata`** *Object* +
**`assa_abloy_vostio_metadata`** *Object* Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
@@ -126,45 +128,45 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
---- - -**`card_number`** *String* +
**`card_number`** *String* Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- - -**`code`** *String* +
**`code`** *String* Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- - -**`created_at`** *Datetime* +
**`created_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created. ---- - -**`display_name`** *String* +
**`display_name`** *String* Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. ---- - -**`ends_at`** *String* +
**`ends_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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`** *List* *of Objects* +
**`errors`** *List* *of Objects* Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
@@ -181,10 +183,10 @@ Errors associated with the [credential](../../../capability-guides/access-system
---- - -**`external_type`** *Enum* +
**`external_type`** *Enum* Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
@@ -201,78 +203,78 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces
---- - -**`external_type_display_name`** *String* +
**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. ---- - -**`is_issued`** *Boolean* +
**`is_issued`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card. ---- - -**`is_latest_desired_state_synced_with_provider`** *Boolean* +
**`is_latest_desired_state_synced_with_provider`** *Boolean* Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider. ---- +
**`is_managed`** *Boolean* +
**`is_multi_phone_sync_credential`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). ---- - -**`is_one_time_use`** *Boolean* +
**`is_one_time_use`** *Boolean* Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use. ---- - -**`issued_at`** *Datetime* +
**`issued_at`** *Datetime* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card. ---- - -**`latest_desired_state_synced_with_provider_at`** *Datetime* +
**`latest_desired_state_synced_with_provider_at`** *Datetime* Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider. ---- - -**`parent_acs_credential_id`** *UUID* +
**`parent_acs_credential_id`** *UUID* ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- - -**`starts_at`** *String* +
**`starts_at`** *String* Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. ---- - -**`visionline_metadata`** *Object* +
**`visionline_metadata`** *Object* Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
@@ -322,22 +324,23 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
---- - -[**`warnings`**](./#warnings) *List* *of Objects* +
[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- - -**`workspace_id`** *UUID* +
**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). ---- +
## Warnings diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 04e45bbc1..f31bbe28f 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -43,36 +43,38 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties -**`acs_encoder_id`** *UUID* - + + + + + + + + + + + + + + +
** Property **** Description **
**`acs_encoder_id`** *UUID* ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. ---- - -**`acs_system_id`** *UUID* +
**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). ---- - -**`created_at`** *Datetime* +
**`created_at`** *Datetime* Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created. ---- - -**`display_name`** *String* +
**`display_name`** *String* Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). ---- - -**`errors`** *List* *of Objects* +
**`errors`** *List* *of Objects* Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
@@ -99,15 +101,16 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
---- - -**`workspace_id`** *UUID* +
**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). ---- +
## Events diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 61dab062b..b88208279 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -37,22 +37,24 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties -**`acs_entrance_id`** *UUID* - + + + + + + + + + + + + + + + + + + + + + + + + +
** Property **** Description **
**`acs_entrance_id`** *UUID* ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). ---- - -**`acs_system_id`** *UUID* +
**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). ---- - -**`assa_abloy_vostio_metadata`** *Object* +
**`assa_abloy_vostio_metadata`** *Object* ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -92,24 +94,24 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
---- - -**`created_at`** *Datetime* +
**`created_at`** *Datetime* Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created. ---- - -**`display_name`** *String* +
**`display_name`** *String* Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). ---- - -**`dormakaba_community_metadata`** *Object* +
**`dormakaba_community_metadata`** *Object* dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -122,10 +124,10 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
---- - -**`errors`** *List* *of Objects* +
**`errors`** *List* *of Objects* Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -146,10 +148,10 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
---- - -**`latch_metadata`** *Object* +
**`latch_metadata`** *Object* Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -174,10 +176,10 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
---- - -**`salto_ks_metadata`** *Object* +
**`salto_ks_metadata`** *Object* Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -218,10 +220,10 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
---- - -**`salto_space_metadata`** *Object* +
**`salto_space_metadata`** *Object* Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -242,10 +244,10 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
---- - -**`visionline_metadata`** *Object* +
**`visionline_metadata`** *Object* Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
@@ -296,8 +298,9 @@ Visionline-specific metadata associated with the [entrance](../../../capability-
---- +
## Events diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index bce9c2a0e..3a5a3fb88 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -52,60 +52,62 @@ For details about the resources associated with an access control system, see th ## Properties -**`acs_access_group_count`** *Number* + + + + ---- - -**`acs_system_id`** *UUID* - + + ---- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
** Property **** Description **
**`acs_access_group_count`** *Number* +
**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - -**`acs_user_count`** *Number* - +
**`acs_user_count`** *Number* -**`can_add_acs_users_to_acs_access_groups`** *Boolean* +
**`can_add_acs_users_to_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). ---- - -**`can_automate_enrollment`** *Boolean* +
**`can_automate_enrollment`** *Boolean* Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - -**`can_create_acs_access_groups`** *Boolean* +
**`can_create_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). ---- - -**`can_remove_acs_users_from_acs_access_groups`** *Boolean* +
**`can_remove_acs_users_from_acs_access_groups`** *Boolean* Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). ---- - -**`connected_account_id`** *UUID* +
**`connected_account_id`** *UUID* ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - -**`connected_account_ids`** *List* *of UUIDs* +
**`connected_account_ids`** *List* *of UUIDs* IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). {% hint style="warning" %} @@ -113,31 +115,31 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README {% endhint %} ---- - -**`created_at`** *Datetime* +
**`created_at`** *Datetime* Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. ---- - -**`default_credential_manager_acs_system_id`** *UUID* +
**`default_credential_manager_acs_system_id`** *UUID* ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - -[**`errors`**](./#errors) *List* *of Objects* +
[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - -**`external_type`** *Enum* +
**`external_type`** *Enum* Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.
@@ -160,38 +162,38 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/
---- - -**`external_type_display_name`** *String* +
**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. ---- - -**`image_alt_text`** *String* +
**`image_alt_text`** *String* Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. ---- - -**`image_url`** *String* +
**`image_url`** *String* URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - -**`is_credential_manager`** *Boolean* +
**`is_credential_manager`** *Boolean* Indicates whether the `acs_system` is a credential manager. ---- - -**`location`** *Object* +
**`location`** *Object*
Child Properties @@ -204,17 +206,17 @@ Indicates whether the `acs_system` is a credential manager.
---- - -**`name`** *String* +
**`name`** *String* Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - -**`system_type`** *Enum* +
**`system_type`** *Enum* {% hint style="warning" %} **Deprecated**. Use `external_type`. {% endhint %} @@ -239,19 +241,19 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide ---- - -**`system_type_display_name`** *String* +
**`system_type_display_name`** *String* {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. {% endhint %} ---- - -**`visionline_metadata`** *Object* +
**`visionline_metadata`** *Object*
Child Properties @@ -276,22 +278,23 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
---- - -[**`warnings`**](./#warnings) *List* *of Objects* +
[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- - -**`workspace_id`** *UUID* +
**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). ---- +
## Errors diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 8c7c5cc6b..ab4a426fd 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -49,8 +49,10 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties -**`access_schedule`** *Object* - + + + + + + + + + + + + + + + + + + + + + + + + ---- - -**`is_managed`** *Boolean* + + ---- + + + + + + + + + + + + + + + + + + +
** Property **** Description **
**`access_schedule`** *Object* `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access.
@@ -71,61 +73,61 @@ For details about how to configure `acs_user`s in your access control system, se
---- - -**`acs_system_id`** *UUID* +
**`acs_system_id`** *UUID* ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -**`acs_user_id`** *UUID* +
**`acs_user_id`** *UUID* ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -**`created_at`** *Datetime* +
**`created_at`** *Datetime* Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created. ---- - -**`display_name`** *String* +
**`display_name`** *String* Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -**`email`** *String* +
**`email`** *String* {% hint style="warning" %} **Deprecated**. use email_address. {% endhint %} ---- - -**`email_address`** *String* +
**`email_address`** *String* Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -[**`errors`**](./#errors) *List* *of Objects* +
[**`errors`**](./#errors) *List* *of Objects* Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -**`external_type`** *Enum* +
**`external_type`** *Enum* Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.
@@ -142,88 +144,89 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi
---- - -**`external_type_display_name`** *String* +
**`external_type_display_name`** *String* Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. ---- - -**`full_name`** *String* +
**`full_name`** *String* Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -**`hid_acs_system_id`** *UUID* - +
**`hid_acs_system_id`** *UUID* +
**`is_managed`** *Boolean* -**`is_suspended`** *Boolean* +
**`is_suspended`** *Boolean* Indicates whether the [ACS 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). ---- - -**`phone_number`** *String* +
**`phone_number`** *String* Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). ---- - -**`user_identity_email_address`** *String* +
**`user_identity_email_address`** *String* Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -**`user_identity_full_name`** *String* +
**`user_identity_full_name`** *String* Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -**`user_identity_id`** *String* +
**`user_identity_id`** *String* ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -**`user_identity_phone_number`** *String* +
**`user_identity_phone_number`** *String* Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). ---- - -[**`warnings`**](./#warnings) *List* *of Objects* +
[**`warnings`**](./#warnings) *List* *of Objects* Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- - -**`workspace_id`** *UUID* +
**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). ---- +
## Errors diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index dddb2f04d..36852183d 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -34,29 +34,31 @@ Represents an app user's mobile phone. ## Properties -**`created_at`** *Datetime* - + + + + + + + + + + + + + + + + + + + + + + +
** Property **** Description **
**`created_at`** *Datetime* Date and time at which the `phone` was created. ---- - -**`custom_metadata`** *Record* +
**`custom_metadata`** *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. ---- - -**`device_id`** *UUID* +
**`device_id`** *UUID* ID of the `phone`. ---- - -**`device_type`** *Enum* +
**`device_type`** *Enum* Type of phone.
@@ -68,17 +70,17 @@ Type of phone.
---- - -**`display_name`** *String* +
**`display_name`** *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. ---- - -**`errors`** *List* *of Objects* +
**`errors`** *List* *of Objects* Errors associated with the `phone`.
@@ -95,17 +97,17 @@ Errors associated with the `phone`.
---- - -**`nickname`** *String* +
**`nickname`** *String* Optional nickname to describe the phone, settable through Seam. ---- - -**`properties`** *Object* +
**`properties`** *Object* Properties of the phone.
@@ -156,10 +158,10 @@ Properties of the phone.
---- - -**`warnings`** *List* *of Objects* +
**`warnings`** *List* *of Objects* Warnings associated with the `phone`.
@@ -176,15 +178,16 @@ Warnings associated with the `phone`.
---- - -**`workspace_id`** *UUID* +
**`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. ---- +
## Events diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 2a4eecb28..7b179ec0f 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -33,36 +33,38 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties -**`climate_preset_key`** *String* - + + + + + + + + + + + + + + + + + + + + +
** Property **** Description **
**`climate_preset_key`** *String* Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). ---- - -**`created_at`** *Datetime* +
**`created_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created. ---- - -**`device_id`** *UUID* +
**`device_id`** *UUID* ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device. ---- - -**`ends_at`** *Datetime* +
**`ends_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. ---- - -**`errors`** *List* *of Objects* +
**`errors`** *List* *of Objects* Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
@@ -83,36 +85,37 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
---- - -**`max_override_period_minutes`** *Number* +
**`max_override_period_minutes`** *Number* Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). ---- - -**`name`** *String* +
**`name`** *String* User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). ---- - -**`starts_at`** *Datetime* +
**`starts_at`** *Datetime* Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. ---- - -**`thermostat_schedule_id`** *UUID* +
**`thermostat_schedule_id`** *UUID* ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). ---- +
## Endpoints diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 5a0d66066..4d736c81f 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -32,58 +32,61 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties -**`created_at`** *Datetime* - + + + + ---- + + + + ---- + + + + + + + + + + +
** Property **** Description **
**`created_at`** *Datetime* Date and time at which the user identity was created. ---- - -**`display_name`** *String* - +
**`display_name`** *String* -**`email_address`** *String* +
**`email_address`** *String* Unique email address for the user identity. ---- - -**`full_name`** *String* - +
**`full_name`** *String* -**`phone_number`** *String* +
**`phone_number`** *String* Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). ---- - -**`user_identity_id`** *UUID* +
**`user_identity_id`** *UUID* ID of the user identity. ---- - -**`user_identity_key`** *String* +
**`user_identity_key`** *String* Unique key for the user identity. ---- - -**`workspace_id`** *UUID* +
**`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. ---- +
## Endpoints diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index e5a419788..bab59ce79 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -29,41 +29,44 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties -**`created_at`** *Datetime* - + + + + + + + + + + + + +
** Property **** Description **
**`created_at`** *Datetime* Date and time at which the enrollment automation was created. ---- - -**`credential_manager_acs_system_id`** *UUID* +
**`credential_manager_acs_system_id`** *UUID* ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. ---- - -**`enrollment_automation_id`** *UUID* +
**`enrollment_automation_id`** *UUID* ID of the enrollment automation. ---- - -**`user_identity_id`** *UUID* +
**`user_identity_id`** *UUID* ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). ---- - -**`workspace_id`** *UUID* +
**`workspace_id`** *UUID* ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. ---- +
## Events From 7ff3f9663e931360aa3c4846eebdd0f1e2af78ef Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Mon, 14 Apr 2025 23:48:50 -0400 Subject: [PATCH 216/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index e1580974c..9c9a4126f 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -40,9 +40,9 @@ {{/if}} - + {{#each properties}} - +
** Property **** Description **
PropertyDescription
{{#if linkTarget}}[**`{{name}}`**]({{linkTarget}}){{else}}**`{{name}}`**{{/if}} *{{format}}*{{#if listItemFormat}} *of {{listItemFormat}}s*{{/if}}
{{#if linkTarget}}{{name}}{{else}}{{name}}{{/if}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} {{#if description}} {{description}} From 36cce80eb7a6077d3669a025d60b1c4b5f8238d4 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 03:49:47 +0000 Subject: [PATCH 217/233] ci: Generate docs --- docs/api/access_codes/README.md | 44 +++++++-------- docs/api/access_codes/unmanaged/README.md | 26 ++++----- docs/api/acs/access_groups/README.md | 26 ++++----- docs/api/acs/credentials/README.md | 54 +++++++++---------- docs/api/acs/encoders/README.md | 14 ++--- docs/api/acs/entrances/README.md | 24 ++++----- docs/api/acs/systems/README.md | 50 ++++++++--------- docs/api/acs/users/README.md | 44 +++++++-------- docs/api/phones/README.md | 22 ++++---- docs/api/thermostats/schedules/README.md | 20 +++---- docs/api/user_identities/README.md | 18 +++---- .../enrollment_automations/README.md | 12 ++--- 12 files changed, 177 insertions(+), 177 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 6fb2fa7f9..8245e7a19 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -52,134 +52,134 @@ In addition, for certain devices, Seam also supports [offline access codes](http ## Properties - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
** Property **** Description **
**`access_code_id`** *UUID*
PropertyDescription
access_code_id UUID Unique identifier for the access code.
**`code`** *String*
code String Code used for access. Typically, a numeric or alphanumeric string.
**`common_code_key`** *String*
common_code_key String Unique identifier for a group of access codes that share the same code.
**`created_at`** *Datetime*
created_at Datetime Date and time at which the access code was created.
**`device_id`** *UUID*
device_id UUID Unique identifier for the device associated with the access code.
**`ends_at`** *Datetime*
ends_at Datetime Date and time after which the time-bound access code becomes inactive.
[**`errors`**](./#errors) *List* *of Objects*
errors List of Objects Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
**`is_backup`** *Boolean*
is_backup Boolean Indicates whether the access code is a backup code.
**`is_backup_access_code_available`** *Boolean*
is_backup_access_code_available Boolean Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
**`is_external_modification_allowed`** *Boolean*
is_external_modification_allowed Boolean Indicates whether changes to the access code from external sources are permitted.
**`is_managed`** *Boolean*
is_managed Boolean Indicates whether Seam manages the access code.
**`is_offline_access_code`** *Boolean*
is_offline_access_code Boolean Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.
**`is_one_time_use`** *Boolean*
is_one_time_use Boolean Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.
**`is_scheduled_on_device`** *Boolean*
is_scheduled_on_device Boolean Indicates whether the code is set on the device according to a preconfigured schedule.
**`is_waiting_for_code_assignment`** *Boolean*
is_waiting_for_code_assignment Boolean Indicates whether the access code is waiting for a code assignment.
**`name`** *String*
name String Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
**`pulled_backup_access_code_id`** *UUID*
pulled_backup_access_code_id UUID Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
**`starts_at`** *Datetime*
starts_at Datetime Date and time at which the time-bound access code becomes active.
**`status`** *Enum*
status Enum 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. @@ -197,7 +197,7 @@ Current status of the access code within the operational lifecycle. Values are `
**`type`** *Enum*
type Enum Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. @@ -212,7 +212,7 @@ Nature of the access code. Values are `ongoing` for access codes that are active
[**`warnings`**](./#warnings) *List* *of Objects*
warnings List of Objects Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 4e24b98f3..98116f32c 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -43,78 +43,78 @@ Prior to using Seam to manage your devices, you may have used another lock manag ## Properties - - + + - + - + - + - + - + - + - + - + - + - + - +
** Property **** Description **
**`access_code_id`** *UUID*
PropertyDescription
access_code_id UUID Unique identifier for the access code.
**`code`** *String*
code String Code used for access. Typically, a numeric or alphanumeric string.
**`created_at`** *Datetime*
created_at Datetime Date and time at which the access code was created.
**`device_id`** *UUID*
device_id UUID Unique identifier for the device associated with the access code.
**`ends_at`** *Datetime*
ends_at Datetime Date and time after which the time-bound access code becomes inactive.
[**`errors`**](./#errors) *List* *of Objects*
errors List of Objects Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
**`is_managed`** *Boolean*
is_managed Boolean Indicates that Seam does not manage the access code.
**`name`** *String*
name String Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
**`starts_at`** *Datetime*
starts_at Datetime Date and time at which the time-bound access code becomes active.
**`status`** *String*
status String Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.
**`type`** *Enum*
type Enum Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. @@ -129,7 +129,7 @@ Nature of the access code. Values are `ongoing` for access codes that are active
[**`warnings`**](./#warnings) *List* *of Objects*
warnings List of Objects Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 440aee7c9..494332ddd 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -41,8 +41,8 @@ To learn whether your access control system supports access groups, see the corr ## Properties - - + + - + - + - + - + - + - + - + - + - + - + - +
** Property **** Description **
**`access_group_type`** *Enum*
PropertyDescription
access_group_type Enum {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -63,7 +63,7 @@ To learn whether your access control system supports access groups, see the corr
**`access_group_type_display_name`** *String*
access_group_type_display_name String {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -72,33 +72,33 @@ To learn whether your access control system supports access groups, see the corr
**`acs_access_group_id`** *UUID*
acs_access_group_id UUID ID of the access group.
**`acs_system_id`** *UUID*
acs_system_id UUID ID of the access control system that contains the access group.
**`created_at`** *Datetime*
created_at Datetime Date and time at which the access group was created.
**`display_name`** *String*
display_name String
**`external_type`** *Enum*
external_type Enum Brand-specific terminology for the access group type. @@ -117,26 +117,26 @@ Brand-specific terminology for the access group type.
**`external_type_display_name`** *String*
external_type_display_name String Display name that corresponds to the brand-specific terminology for the access group type.
**`is_managed`** *Boolean*
is_managed Boolean
**`name`** *String*
name String Name of the access group.
**`warnings`** *List* *of Objects*
warnings List of Objects Warnings associated with the `acs_access_group`. @@ -166,7 +166,7 @@ Warnings associated with the `acs_access_group`.
**`workspace_id`** *UUID*
workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the access group. diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 5758bc95d..1bf8fde6b 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -55,8 +55,8 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
** Property **** Description **
**`access_method`** *Enum*
PropertyDescription
access_method Enum Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. @@ -72,33 +72,33 @@ Access method for the [credential](../../../capability-guides/access-systems/man
**`acs_credential_id`** *UUID*
acs_credential_id UUID ID of the [credential](../../../capability-guides/access-systems/managing-credentials.md).
**`acs_credential_pool_id`** *UUID*
acs_credential_pool_id UUID
**`acs_system_id`** *UUID*
acs_system_id UUID ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md).
**`acs_user_id`** *UUID*
acs_user_id UUID ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
**`assa_abloy_vostio_metadata`** *Object*
assa_abloy_vostio_metadata Object Vostio-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -130,42 +130,42 @@ Vostio-specific metadata for the [credential](../../../capability-guides/access-
**`card_number`** *String*
card_number String Number of the card associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
**`code`** *String*
code String Access (PIN) code for the [credential](../../../capability-guides/access-systems/managing-credentials.md).
**`created_at`** *Datetime*
created_at Datetime Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was created.
**`display_name`** *String*
display_name String Display name that corresponds to the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
**`ends_at`** *String*
ends_at String Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) 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`** *List* *of Objects*
errors List of Objects Errors associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -185,7 +185,7 @@ Errors associated with the [credential](../../../capability-guides/access-system
**`external_type`** *Enum*
external_type Enum Brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. @@ -205,75 +205,75 @@ Brand-specific terminology for the [credential](../../../capability-guides/acces
**`external_type_display_name`** *String*
external_type_display_name String Display name that corresponds to the brand-specific terminology for the [credential](../../../capability-guides/access-systems/managing-credentials.md) type.
**`is_issued`** *Boolean*
is_issued Boolean Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been encoded onto a card.
**`is_latest_desired_state_synced_with_provider`** *Boolean*
is_latest_desired_state_synced_with_provider Boolean Indicates whether the latest state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) has been synced from Seam to the provider.
**`is_managed`** *Boolean*
is_managed Boolean
**`is_multi_phone_sync_credential`** *Boolean*
is_multi_phone_sync_credential Boolean Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
**`is_one_time_use`** *Boolean*
is_one_time_use Boolean Indicates whether the [credential](../../../capability-guides/access-systems/managing-credentials.md) can only be used once. If `true`, the code becomes invalid after the first use.
**`issued_at`** *Datetime*
issued_at Datetime Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) was encoded onto a card.
**`latest_desired_state_synced_with_provider_at`** *Datetime*
latest_desired_state_synced_with_provider_at Datetime Date and time at which the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was most recently synced from Seam to the provider.
**`parent_acs_credential_id`** *UUID*
parent_acs_credential_id UUID ID of the parent [credential](../../../capability-guides/access-systems/managing-credentials.md).
**`starts_at`** *String*
starts_at String Date and time at which the [credential](../../../capability-guides/access-systems/managing-credentials.md) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
**`visionline_metadata`** *Object*
visionline_metadata Object Visionline-specific metadata for the [credential](../../../capability-guides/access-systems/managing-credentials.md). @@ -326,14 +326,14 @@ Visionline-specific metadata for the [credential](../../../capability-guides/acc
[**`warnings`**](./#warnings) *List* *of Objects*
warnings List of Objects Warnings associated with the [credential](../../../capability-guides/access-systems/managing-credentials.md).
**`workspace_id`** *UUID*
workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [credential](../../../capability-guides/access-systems/managing-credentials.md). diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index f31bbe28f..1aefc8227 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -44,36 +44,36 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties - - + + - + - + - + - + - +
** Property **** Description **
**`acs_encoder_id`** *UUID*
PropertyDescription
acs_encoder_id UUID ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners.
**`acs_system_id`** *UUID*
acs_system_id UUID ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
**`created_at`** *Datetime*
created_at Datetime Date and time at which the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was created.
**`display_name`** *String*
display_name String Display name for the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
**`errors`** *List* *of Objects*
errors List of Objects Errors associated with the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). @@ -103,7 +103,7 @@ Errors associated with the [encoder](../../../capability-guides/access-systems/w
**`workspace_id`** *UUID*
workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index b88208279..718cada51 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -38,22 +38,22 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties - - + + - + - + - + - + - + - + - + - + - + - +
** Property **** Description **
**`acs_entrance_id`** *UUID*
PropertyDescription
acs_entrance_id UUID ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
**`acs_system_id`** *UUID*
acs_system_id UUID ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
**`assa_abloy_vostio_metadata`** *Object*
assa_abloy_vostio_metadata Object ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -96,21 +96,21 @@ ASSA ABLOY Vostio-specific metadata associated with the [entrance](../../../capa
**`created_at`** *Datetime*
created_at Datetime Date and time at which the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md) was created.
**`display_name`** *String*
display_name String Display name for the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
**`dormakaba_community_metadata`** *Object*
dormakaba_community_metadata Object dormakaba Community-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -126,7 +126,7 @@ dormakaba Community-specific metadata associated with the [entrance](../../../ca
**`errors`** *List* *of Objects*
errors List of Objects Errors associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -150,7 +150,7 @@ Errors associated with the [entrance](../../../capability-guides/access-systems/
**`latch_metadata`** *Object*
latch_metadata Object Latch-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -178,7 +178,7 @@ Latch-specific metadata associated with the [entrance](../../../capability-guide
**`salto_ks_metadata`** *Object*
salto_ks_metadata Object Salto KS-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -222,7 +222,7 @@ Salto KS-specific metadata associated with the [entrance](../../../capability-gu
**`salto_space_metadata`** *Object*
salto_space_metadata Object Salto Space-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -246,7 +246,7 @@ Salto Space-specific metadata associated with the [entrance](../../../capability
**`visionline_metadata`** *Object*
visionline_metadata Object Visionline-specific metadata associated with the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 3a5a3fb88..ea5ea581b 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -53,60 +53,60 @@ For details about the resources associated with an access control system, see th ## Properties - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
** Property **** Description **
**`acs_access_group_count`** *Number*
PropertyDescription
acs_access_group_count Number
**`acs_system_id`** *UUID*
acs_system_id UUID ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
**`acs_user_count`** *Number*
acs_user_count Number
**`can_add_acs_users_to_acs_access_groups`** *Boolean*
can_add_acs_users_to_acs_access_groups Boolean Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
**`can_automate_enrollment`** *Boolean*
can_automate_enrollment Boolean Indicates whether it is possible to [launch enrollment automations](../../../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) for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
**`can_create_acs_access_groups`** *Boolean*
can_create_acs_access_groups Boolean Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
**`can_remove_acs_users_from_acs_access_groups`** *Boolean*
can_remove_acs_users_from_acs_access_groups Boolean Indicates whether the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems).
**`connected_account_id`** *UUID*
connected_account_id UUID ID of the [connected account](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
**`connected_account_ids`** *List* *of UUIDs*
connected_account_ids List of UUIDs IDs of the [connected accounts](../../../core-concepts/connected-accounts/README.md) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). @@ -117,28 +117,28 @@ IDs of the [connected accounts](../../../core-concepts/connected-accounts/README
**`created_at`** *Datetime*
created_at Datetime Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created.
**`default_credential_manager_acs_system_id`** *UUID*
default_credential_manager_acs_system_id UUID ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
[**`errors`**](./#errors) *List* *of Objects*
errors List of Objects Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
**`external_type`** *Enum*
external_type Enum Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. @@ -164,35 +164,35 @@ Brand-specific terminology for the [access control system](https://docs.seam.co/
**`external_type_display_name`** *String*
external_type_display_name String Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type.
**`image_alt_text`** *String*
image_alt_text String Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image.
**`image_url`** *String*
image_url String URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
**`is_credential_manager`** *Boolean*
is_credential_manager Boolean Indicates whether the `acs_system` is a credential manager.
**`location`** *Object*
location Object
@@ -208,14 +208,14 @@ Indicates whether the `acs_system` is a credential manager.
**`name`** *String*
name String Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
**`system_type`** *Enum*
system_type Enum {% hint style="warning" %} **Deprecated**. Use `external_type`. @@ -243,7 +243,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
**`system_type_display_name`** *String*
system_type_display_name String {% hint style="warning" %} **Deprecated**. Use `external_type_display_name`. @@ -252,7 +252,7 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
**`visionline_metadata`** *Object*
visionline_metadata Object
@@ -280,14 +280,14 @@ Name of the [access control system](https://docs.seam.co/latest/capability-guide
[**`warnings`**](./#warnings) *List* *of Objects*
warnings List of Objects Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
**`workspace_id`** *UUID*
workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index ab4a426fd..7b9fe4585 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -50,8 +50,8 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties - - + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
** Property **** Description **
**`access_schedule`** *Object*
PropertyDescription
access_schedule Object `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. @@ -75,35 +75,35 @@ For details about how to configure `acs_user`s in your access control system, se
**`acs_system_id`** *UUID*
acs_system_id UUID ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
**`acs_user_id`** *UUID*
acs_user_id UUID ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
**`created_at`** *Datetime*
created_at Datetime Date and time at which the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was created.
**`display_name`** *String*
display_name String Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
**`email`** *String*
email String {% hint style="warning" %} **Deprecated**. use email_address. @@ -112,21 +112,21 @@ Display name for the [ACS user](https://docs.seam.co/latest/capability-guides/ac
**`email_address`** *String*
email_address String Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
[**`errors`**](./#errors) *List* *of Objects*
errors List of Objects Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
**`external_type`** *Enum*
external_type Enum Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type. @@ -146,80 +146,80 @@ Brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capabi
**`external_type_display_name`** *String*
external_type_display_name String Display name that corresponds to the brand-specific terminology for the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) type.
**`full_name`** *String*
full_name String Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
**`hid_acs_system_id`** *UUID*
hid_acs_system_id UUID
**`is_managed`** *Boolean*
is_managed Boolean
**`is_suspended`** *Boolean*
is_suspended Boolean Indicates whether the [ACS 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).
**`phone_number`** *String*
phone_number String Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
**`user_identity_email_address`** *String*
user_identity_email_address String Email address of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
**`user_identity_full_name`** *String*
user_identity_full_name String Full name of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
**`user_identity_id`** *String*
user_identity_id String ID of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
**`user_identity_phone_number`** *String*
user_identity_phone_number String Phone number of the user identity associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`).
[**`warnings`**](./#warnings) *List* *of Objects*
warnings List of Objects Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
**`workspace_id`** *UUID*
workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 36852183d..6b9ef2166 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -35,29 +35,29 @@ Represents an app user's mobile phone. ## Properties - - + + - + - + - + - + - + - + - + - + - +
** Property **** Description **
**`created_at`** *Datetime*
PropertyDescription
created_at Datetime Date and time at which the `phone` was created.
**`custom_metadata`** *Record*
custom_metadata Record Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone.
**`device_id`** *UUID*
device_id UUID ID of the `phone`.
**`device_type`** *Enum*
device_type Enum Type of phone. @@ -72,14 +72,14 @@ Type of phone.
**`display_name`** *String*
display_name String Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.
**`errors`** *List* *of Objects*
errors List of Objects Errors associated with the `phone`. @@ -99,14 +99,14 @@ Errors associated with the `phone`.
**`nickname`** *String*
nickname String Optional nickname to describe the phone, settable through Seam.
**`properties`** *Object*
properties Object Properties of the phone. @@ -160,7 +160,7 @@ Properties of the phone.
**`warnings`** *List* *of Objects*
warnings List of Objects Warnings associated with the `phone`. @@ -180,7 +180,7 @@ Warnings associated with the `phone`.
**`workspace_id`** *UUID*
workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the `phone`. diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 7b179ec0f..481249514 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -34,36 +34,36 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties - - + + - + - + - + - + - + - + - + - +
** Property **** Description **
**`climate_preset_key`** *String*
PropertyDescription
climate_preset_key String Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
**`created_at`** *Datetime*
created_at Datetime Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) was created.
**`device_id`** *UUID*
device_id UUID ID of the desired [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) device.
**`ends_at`** *Datetime*
ends_at Datetime Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
**`errors`** *List* *of Objects*
errors List of Objects Errors associated with the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). @@ -87,28 +87,28 @@ Errors associated with the [thermostat schedule](../../../capability-guides/ther
**`max_override_period_minutes`** *Number*
max_override_period_minutes Number Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
**`name`** *String*
name String User-friendly name to identify the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
**`starts_at`** *Datetime*
starts_at Datetime Date and time at which the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
**`thermostat_schedule_id`** *UUID*
thermostat_schedule_id UUID ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 4d736c81f..ce52d04ab 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -33,53 +33,53 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties - - + + - + - + - + - + - + - + - +
** Property **** Description **
**`created_at`** *Datetime*
PropertyDescription
created_at Datetime Date and time at which the user identity was created.
**`display_name`** *String*
display_name String
**`email_address`** *String*
email_address String Unique email address for the user identity.
**`full_name`** *String*
full_name String
**`phone_number`** *String*
phone_number String Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
**`user_identity_id`** *UUID*
user_identity_id UUID ID of the user identity.
**`user_identity_key`** *String*
user_identity_key String Unique key for the user identity.
**`workspace_id`** *UUID*
workspace_id UUID ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the user identity. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index bab59ce79..8a5c53a8e 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -30,36 +30,36 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties - - + + - + - + - + - +
** Property **** Description **
**`created_at`** *Datetime*
PropertyDescription
created_at Datetime Date and time at which the enrollment automation was created.
**`credential_manager_acs_system_id`** *UUID*
credential_manager_acs_system_id UUID ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.
**`enrollment_automation_id`** *UUID*
enrollment_automation_id UUID ID of the enrollment automation.
**`user_identity_id`** *UUID*
user_identity_id UUID ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
**`workspace_id`** *UUID*
workspace_id UUID ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains the enrollment automation. From fa867a21c598fa3edf8c3c8aedd062287cd94849 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:04:19 -0400 Subject: [PATCH 218/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 9c9a4126f..6f2b6fc27 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -40,7 +40,7 @@ {{/if}} - + {{#each properties}}
PropertyDescription
PropertyDescription
{{#if linkTarget}}{{name}}{{else}}{{name}}{{/if}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} From c95f46e7ca596d7a39be799c77c951a031e1e04d Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 04:05:17 +0000 Subject: [PATCH 219/233] ci: Generate docs --- docs/api/access_codes/README.md | 2 +- docs/api/access_codes/unmanaged/README.md | 2 +- docs/api/acs/access_groups/README.md | 2 +- docs/api/acs/credentials/README.md | 2 +- docs/api/acs/encoders/README.md | 2 +- docs/api/acs/entrances/README.md | 2 +- docs/api/acs/systems/README.md | 2 +- docs/api/acs/users/README.md | 2 +- docs/api/phones/README.md | 2 +- docs/api/thermostats/schedules/README.md | 2 +- docs/api/user_identities/README.md | 2 +- docs/api/user_identities/enrollment_automations/README.md | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 8245e7a19..4a5be08a8 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -52,7 +52,7 @@ In addition, for certain devices, Seam also supports [offline access codes](http ## Properties - +
PropertyDescription
PropertyDescription
access_code_id UUID Unique identifier for the access code. diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 98116f32c..382da1843 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -43,7 +43,7 @@ Prior to using Seam to manage your devices, you may have used another lock manag ## Properties - +
PropertyDescription
PropertyDescription
access_code_id UUID Unique identifier for the access code. diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 494332ddd..6fadc0126 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -41,7 +41,7 @@ To learn whether your access control system supports access groups, see the corr ## Properties - +
PropertyDescription
PropertyDescription
access_group_type Enum {% hint style="warning" %} diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 1bf8fde6b..be891e325 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -55,7 +55,7 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties - +
PropertyDescription
PropertyDescription
access_method Enum Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 1aefc8227..a260a17a4 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -44,7 +44,7 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties - +
PropertyDescription
PropertyDescription
acs_encoder_id UUID ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 718cada51..02ced06da 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -38,7 +38,7 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties - +
PropertyDescription
PropertyDescription
acs_entrance_id UUID ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index ea5ea581b..3aec3210b 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -53,7 +53,7 @@ For details about the resources associated with an access control system, see th ## Properties - +
PropertyDescription
PropertyDescription
acs_access_group_count Number diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 7b9fe4585..e80b76b64 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -50,7 +50,7 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties - +
PropertyDescription
PropertyDescription
access_schedule Object `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 6b9ef2166..edf70d33a 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -35,7 +35,7 @@ Represents an app user's mobile phone. ## Properties - +
PropertyDescription
PropertyDescription
created_at Datetime Date and time at which the `phone` was created. diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 481249514..6965783b5 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -34,7 +34,7 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties - +
PropertyDescription
PropertyDescription
climate_preset_key String Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index ce52d04ab..1e677635e 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -33,7 +33,7 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties - +
PropertyDescription
PropertyDescription
created_at Datetime Date and time at which the user identity was created. diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 8a5c53a8e..8356b54ec 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -30,7 +30,7 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties - +
PropertyDescription
PropertyDescription
created_at Datetime Date and time at which the enrollment automation was created. From 018606c300950886e4b77d3422bc49209556d09d Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:06:53 -0400 Subject: [PATCH 220/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 9c0e9502d..4753ca460 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -33,8 +33,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters {{#if request.parameters.length}} + + {{#each request.parameters}} -**`{{this.name}}`** *{{this.jsonType}}*{{#if this.itemFormat}} *of {{this.itemFormat}}s*{{/if}}{{#if this.required}} (Required){{/if}} + + {{/each}} +
PropertyDescription
{{this.name}} {{this.jsonType}}{{#if this.itemFormat}} of {{this.itemFormat}}s{{/if}}{{#if this.required}} (Required){{/if}} {{#if this.description}} {{this.description}} @@ -49,8 +52,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati {{/if}} --- - +
{{else}} None From 248f9aaf405b6876d667f9d64cc0f69734dac67e Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 04:07:50 +0000 Subject: [PATCH 221/233] ci: Generate docs --- docs/api/access_codes/create.md | 83 ++++++++++------- docs/api/access_codes/create_multiple.md | 83 ++++++++++------- docs/api/access_codes/delete.md | 13 ++- docs/api/access_codes/get.md | 18 ++-- docs/api/access_codes/list.md | 18 ++-- .../access_codes/pull_backup_access_code.md | 8 +- .../simulate/create_unmanaged_access_code.md | 18 ++-- .../unmanaged/convert_to_managed.md | 23 +++-- docs/api/access_codes/unmanaged/delete.md | 8 +- docs/api/access_codes/unmanaged/get.md | 18 ++-- docs/api/access_codes/unmanaged/list.md | 13 ++- docs/api/access_codes/unmanaged/update.md | 28 ++++-- docs/api/access_codes/update.md | 93 ++++++++++++------- docs/api/access_codes/update_multiple.md | 23 +++-- docs/api/acs/access_groups/add_user.md | 13 ++- docs/api/acs/access_groups/get.md | 8 +- docs/api/acs/access_groups/list.md | 13 ++- .../list_accessible_entrances.md | 8 +- docs/api/acs/access_groups/list_users.md | 8 +- docs/api/acs/access_groups/remove_user.md | 13 ++- docs/api/acs/credentials/assign.md | 13 ++- docs/api/acs/credentials/create.md | 58 +++++++----- docs/api/acs/credentials/delete.md | 8 +- docs/api/acs/credentials/get.md | 8 +- docs/api/acs/credentials/list.md | 33 ++++--- .../credentials/list_accessible_entrances.md | 8 +- docs/api/acs/credentials/unassign.md | 13 ++- docs/api/acs/credentials/update.md | 18 ++-- docs/api/acs/encoders/encode_credential.md | 13 ++- docs/api/acs/encoders/list.md | 23 +++-- docs/api/acs/encoders/scan_credential.md | 8 +- .../next_credential_encode_will_fail.md | 18 ++-- .../next_credential_encode_will_succeed.md | 13 ++- .../next_credential_scan_will_fail.md | 18 ++-- .../next_credential_scan_will_succeed.md | 18 ++-- docs/api/acs/entrances/get.md | 8 +- docs/api/acs/entrances/grant_access.md | 13 ++- docs/api/acs/entrances/list.md | 13 ++- .../entrances/list_credentials_with_access.md | 13 ++- docs/api/acs/systems/get.md | 8 +- docs/api/acs/systems/list.md | 8 +- ...mpatible_credential_manager_acs_systems.md | 8 +- docs/api/acs/users/add_to_access_group.md | 13 ++- docs/api/acs/users/create.md | 43 +++++---- docs/api/acs/users/delete.md | 8 +- docs/api/acs/users/get.md | 8 +- docs/api/acs/users/list.md | 43 +++++---- .../acs/users/list_accessible_entrances.md | 8 +- .../api/acs/users/remove_from_access_group.md | 13 ++- .../users/revoke_access_to_all_entrances.md | 8 +- docs/api/acs/users/suspend.md | 8 +- docs/api/acs/users/unsuspend.md | 8 +- docs/api/acs/users/update.md | 38 +++++--- docs/api/phones/deactivate.md | 8 +- docs/api/phones/get.md | 8 +- docs/api/phones/list.md | 13 ++- .../phones/simulate/create_sandbox_phone.md | 23 +++-- .../thermostats/activate_climate_preset.md | 13 ++- docs/api/thermostats/cool.md | 18 ++-- docs/api/thermostats/create_climate_preset.md | 53 +++++++---- docs/api/thermostats/delete_climate_preset.md | 13 ++- docs/api/thermostats/heat.md | 18 ++-- docs/api/thermostats/heat_cool.md | 28 ++++-- docs/api/thermostats/list.md | 58 +++++++----- docs/api/thermostats/off.md | 8 +- docs/api/thermostats/schedules/create.md | 38 +++++--- docs/api/thermostats/schedules/delete.md | 8 +- docs/api/thermostats/schedules/get.md | 8 +- docs/api/thermostats/schedules/list.md | 13 ++- docs/api/thermostats/schedules/update.md | 38 +++++--- .../set_fallback_climate_preset.md | 13 ++- docs/api/thermostats/set_fan_mode.md | 18 ++-- docs/api/thermostats/set_hvac_mode.md | 33 ++++--- .../thermostats/set_temperature_threshold.md | 28 ++++-- .../simulate/hvac_mode_adjusted.md | 33 ++++--- .../simulate/temperature_reached.md | 18 ++-- docs/api/thermostats/update_climate_preset.md | 53 +++++++---- docs/api/user_identities/add_acs_user.md | 13 ++- docs/api/user_identities/create.md | 23 +++-- docs/api/user_identities/delete.md | 8 +- .../enrollment_automations/delete.md | 8 +- .../enrollment_automations/get.md | 8 +- .../enrollment_automations/launch.md | 28 ++++-- .../enrollment_automations/list.md | 8 +- docs/api/user_identities/get.md | 13 ++- .../user_identities/grant_access_to_device.md | 13 ++- docs/api/user_identities/list.md | 8 +- .../list_accessible_devices.md | 8 +- docs/api/user_identities/list_acs_systems.md | 8 +- docs/api/user_identities/list_acs_users.md | 8 +- docs/api/user_identities/remove_acs_user.md | 13 ++- .../revoke_access_to_device.md | 13 ++- docs/api/user_identities/update.md | 28 ++++-- 93 files changed, 1203 insertions(+), 616 deletions(-) diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index 09590edc7..a95207791 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -28,98 +28,117 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
device_id String (Required) ID of the device for which to create the new access code. --- - -**`allow_external_modification`** *Boolean* +
allow_external_modification Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- - -**`attempt_for_offline_device`** *Boolean* +
attempt_for_offline_device Boolean --- - -**`code`** *String* +
code String Code to be used for access. --- - -**`common_code_key`** *String* +
common_code_key String Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md). --- - -**`ends_at`** *String* +
ends_at String Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- - -**`is_external_modification_allowed`** *Boolean* +
is_external_modification_allowed Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- - -**`is_offline_access_code`** *Boolean* +
is_offline_access_code Boolean Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). --- - -**`is_one_time_use`** *Boolean* +
is_one_time_use Boolean Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. --- - -**`max_time_rounding`** *String* +
max_time_rounding String Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. --- - -**`name`** *String* +
name String Name of the new access code. --- - -**`prefer_native_scheduling`** *Boolean* +
prefer_native_scheduling Boolean Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. --- - -**`preferred_code_length`** *Number* +
preferred_code_length Number Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. --- - -**`starts_at`** *String* +
starts_at String Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- - -**`use_backup_access_code_pool`** *Boolean* +
use_backup_access_code_pool Boolean Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). --- - -**`use_offline_access_code`** *Boolean* +
use_offline_access_code Boolean --- - +
## Response diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 38c3807d4..266c034ce 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -36,98 +36,117 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_ids`** *Array* *of UUIDs* (Required) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
device_ids Array of UUIDs (Required) IDs of the devices for which to create the new access codes. --- - -**`allow_external_modification`** *Boolean* +
allow_external_modification Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- - -**`attempt_for_offline_device`** *Boolean* +
attempt_for_offline_device Boolean --- - -**`behavior_when_code_cannot_be_shared`** *String* +
behavior_when_code_cannot_be_shared String Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. --- - -**`code`** *String* +
code String Code to be used for access. --- - -**`ends_at`** *String* +
ends_at String Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- - -**`is_external_modification_allowed`** *Boolean* +
is_external_modification_allowed Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- - -**`is_offline_access_code`** *Boolean* +
is_offline_access_code Boolean Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). --- - -**`is_one_time_use`** *Boolean* +
is_one_time_use Boolean Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. --- - -**`max_time_rounding`** *String* +
max_time_rounding String Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. --- - -**`name`** *String* +
name String Name of the new access code. --- - -**`prefer_native_scheduling`** *Boolean* +
prefer_native_scheduling Boolean Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. --- - -**`preferred_code_length`** *Number* +
preferred_code_length Number Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. --- - -**`starts_at`** *String* +
starts_at String Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- - -**`use_backup_access_code_pool`** *Boolean* +
use_backup_access_code_pool Boolean Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). --- - -**`use_offline_access_code`** *Boolean* +
use_offline_access_code Boolean --- - +
## Response diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index b7465f2c9..e8e4fba3e 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -28,18 +28,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** *String* (Required) + + + + + + +
PropertyDescription
access_code_id String (Required) ID of the access code to delete. --- - -**`device_id`** *String* +
device_id String ID of the device for which to delete the access code. --- - +
## Response diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 878e2dd04..d86cc9d14 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -28,24 +28,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** *String* + + + + + + + + +
PropertyDescription
access_code_id String ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- - -**`code`** *String* +
code String Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- - -**`device_id`** *String* +
device_id String ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- - +
## Response diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 771b44918..147b0cab0 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -30,24 +30,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_ids`** *Array* *of UUIDs* + + + + + + + + +
PropertyDescription
access_code_ids Array of UUIDs IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. --- - -**`device_id`** *String* +
device_id String ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. --- - -**`user_identifier_key`** *String* +
user_identifier_key String Your user ID for the user by which to filter access codes. --- - +
## Response diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 48ff7116c..0bbcca67d 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -36,12 +36,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** *String* (Required) + + + + +
PropertyDescription
access_code_id String (Required) ID of the access code for which you want to pull a backup access code. --- - +
## Response diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index 9dea2b849..98665dfb9 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -28,24 +28,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`code`** *String* (Required) + + + + + + + + +
PropertyDescription
code String (Required) Code of the simulated unmanaged access code. --- - -**`device_id`** *String* (Required) +
device_id String (Required) ID of the device for which you want to simulate the creation of an unmanaged access code. --- - -**`name`** *String* (Required) +
name String (Required) Name of the simulated unmanaged access code. --- - +
## Response diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 0bc7123cc..f5c56be08 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -32,30 +32,37 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** *String* (Required) + + + + + + + + + + +
PropertyDescription
access_code_id String (Required) ID of the unmanaged access code that you want to convert to a managed access code. --- - -**`allow_external_modification`** *Boolean* +
allow_external_modification Boolean Indicates whether external modification of the access code is allowed. --- - -**`force`** *Boolean* +
force Boolean Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. --- - -**`is_external_modification_allowed`** *Boolean* +
is_external_modification_allowed Boolean Indicates whether external modification of the access code is allowed. --- - +
## Response diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index 25eb0a93f..af70775af 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -28,12 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** *String* (Required) + + + + +
PropertyDescription
access_code_id String (Required) ID of the unmanaged access code to delete. --- - +
## Response diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index 53035d0fd..01377e635 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -30,24 +30,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** *String* + + + + + + + + +
PropertyDescription
access_code_id String ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- - -**`code`** *String* +
code String Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- - -**`device_id`** *String* +
device_id String ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. --- - +
## Response diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index 439b309ea..152a278c8 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -28,18 +28,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + +
PropertyDescription
device_id String (Required) ID of the device for which you want to list unmanaged access codes. --- - -**`user_identifier_key`** *String* +
user_identifier_key String Your user ID for the user by which to filter unmanaged access codes. --- - +
## Response diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index a7fd10c5c..acf9a7436 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -28,34 +28,42 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** *String* (Required) + + + + + + + + + + + + +
PropertyDescription
access_code_id String (Required) ID of the unmanaged access code that you want to update. --- - -**`is_managed`** *Boolean* (Required) +
is_managed Boolean (Required) --- - -**`allow_external_modification`** *Boolean* +
allow_external_modification Boolean Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. --- - -**`force`** *Boolean* +
force Boolean Indicates whether to force the unmanaged access code update. --- - -**`is_external_modification_allowed`** *Boolean* +
is_external_modification_allowed Boolean Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. --- - +
## Response diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index 92c7a07ee..28864d11d 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -30,110 +30,131 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_code_id`** *String* (Required) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
access_code_id String (Required) ID of the access code that you want to update. --- - -**`allow_external_modification`** *Boolean* +
allow_external_modification Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- - -**`attempt_for_offline_device`** *Boolean* +
attempt_for_offline_device Boolean --- - -**`code`** *String* +
code String Code to be used for access. --- - -**`device_id`** *String* +
device_id String ID of the device containing the access code that you want to update. --- - -**`ends_at`** *String* +
ends_at String Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- - -**`is_external_modification_allowed`** *Boolean* +
is_external_modification_allowed Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. --- - -**`is_managed`** *Boolean* +
is_managed Boolean Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`. --- - -**`is_offline_access_code`** *Boolean* +
is_offline_access_code Boolean Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). --- - -**`is_one_time_use`** *Boolean* +
is_one_time_use Boolean Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. --- - -**`max_time_rounding`** *String* +
max_time_rounding String Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. --- - -**`name`** *String* +
name String Name of the new access code. --- - -**`prefer_native_scheduling`** *Boolean* +
prefer_native_scheduling Boolean Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. --- - -**`preferred_code_length`** *Number* +
preferred_code_length Number Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. --- - -**`starts_at`** *String* +
starts_at String Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- - -**`type`** *String* +
type String Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access). --- - -**`use_backup_access_code_pool`** *Boolean* +
use_backup_access_code_pool Boolean Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). --- - -**`use_offline_access_code`** *Boolean* +
use_offline_access_code Boolean --- - +
## Response diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index 358f7d784..f0683bccc 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -32,30 +32,37 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`common_code_key`** *String* (Required) + + + + + + + + + + +
PropertyDescription
common_code_key String (Required) Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. --- - -**`ends_at`** *String* +
ends_at String Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- - -**`name`** *String* +
name String Name of the new access code. --- - -**`starts_at`** *String* +
starts_at String Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- - +
## Response diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 069608143..093ff90bc 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_access_group_id String (Required) ID of the desired access group. --- - -**`acs_user_id`** *String* (Required) +
acs_user_id String (Required) ID of the desired user. --- - +
## Response diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index efb8009ca..f5ad21cd8 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** *String* (Required) + + + + +
PropertyDescription
acs_access_group_id String (Required) ID of the desired access group. --- - +
## Response diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index a2092ee9a..bbdc21a82 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* + + + + + + +
PropertyDescription
acs_system_id String ID of the access control system for which you want to retrieve all access groups. --- - -**`acs_user_id`** *String* +
acs_user_id String ID of the user for which you want to retrieve all access groups. --- - +
## Response diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 19fa4e62d..d93abf3b4 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** *String* (Required) + + + + +
PropertyDescription
acs_access_group_id String (Required) ID of the access group for which you want to retrieve all accessible entrances. --- - +
## Response diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 9872c0bd6..785663696 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** *String* (Required) + + + + +
PropertyDescription
acs_access_group_id String (Required) ID of the access group for which you want to retrieve all users. --- - +
## Response diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 6d1f38607..b4bd21d33 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_access_group_id String (Required) ID of the desired access group. --- - -**`acs_user_id`** *String* (Required) +
acs_user_id String (Required) ID of the desired user. --- - +
## Response diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 98b348863..fbb4b7a1f 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_credential_id String (Required) ID of the desired credential. --- - -**`acs_user_id`** *String* (Required) +
acs_user_id String (Required) ID of the desired user. --- - +
## Response diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index c440f996d..aeb50ff0a 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -27,72 +27,86 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`access_method`** *String* (Required) + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
access_method String (Required) Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. --- - -**`acs_user_id`** *String* (Required) +
acs_user_id String (Required) ID of the ACS user to whom the new credential belongs. --- - -**`allowed_acs_entrance_ids`** *Array* *of UUIDs* +
allowed_acs_entrance_ids Array of UUIDs Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. --- - -**`assa_abloy_vostio_metadata`** *Object* +
assa_abloy_vostio_metadata Object Vostio-specific metadata for the new credential. --- - -**`code`** *String* +
code String Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). --- - -**`credential_manager_acs_system_id`** *String* +
credential_manager_acs_system_id String ACS system ID of the credential manager for the new credential. --- - -**`ends_at`** *String* +
ends_at String Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. --- - -**`is_multi_phone_sync_credential`** *Boolean* +
is_multi_phone_sync_credential Boolean Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). --- - -**`salto_space_metadata`** *Object* +
salto_space_metadata Object Salto Space-specific metadata for the new credential. --- - -**`starts_at`** *String* +
starts_at String Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- - -**`visionline_metadata`** *Object* +
visionline_metadata Object Visionline-specific metadata for the new credential. --- - +
## Response diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index c177daf54..2313bd0b3 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** *String* (Required) + + + + +
PropertyDescription
acs_credential_id String (Required) ID of the desired credential. --- - +
## Response diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 99eb175a1..49148186e 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** *String* (Required) + + + + +
PropertyDescription
acs_credential_id String (Required) ID of the desired credential. --- - +
## Response diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 5d0f8ac2b..51cd17eec 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -28,42 +28,51 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* + + + + + + + + + + + + + + +
PropertyDescription
acs_system_id String ID of the access control system for which you want to retrieve all credentials. --- - -**`acs_user_id`** *String* +
acs_user_id String ID of the ACS user for which you want to retrieve all credentials. --- - -**`created_before`** *String* +
created_before String Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. --- - -**`is_multi_phone_sync_credential`** *Boolean* +
is_multi_phone_sync_credential Boolean Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. --- - -**`limit`** *Number* +
limit Number Number of credentials to return. --- - -**`user_identity_id`** *String* +
user_identity_id String ID of the user identity for which you want to retrieve all credentials. --- - +
## Response diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3551ec95a..3007639e4 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** *String* (Required) + + + + +
PropertyDescription
acs_credential_id String (Required) ID of the credential for which you want to retrieve all entrances to which this credential grants access. --- - +
## Response diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index a43b0dc0e..0db59beee 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_credential_id String (Required) ID of the desired credential. --- - -**`acs_user_id`** *String* (Required) +
acs_user_id String (Required) ID of the desired user. --- - +
## Response diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 48cd40220..02f1b88f9 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -27,24 +27,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** *String* (Required) + + + + + + + + +
PropertyDescription
acs_credential_id String (Required) ID of the desired credential. --- - -**`code`** *String* +
code String Replacement access (PIN) code for the credential. --- - -**`ends_at`** *String* +
ends_at String Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. --- - +
## Response diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 40d544be3..9569796de 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_credential_id String (Required) ID of the `acs_credential` to encode onto a card. --- - -**`acs_encoder_id`** *String* (Required) +
acs_encoder_id String (Required) ID of the `acs_encoder` to use to encode the `acs_credential`. --- - +
## Response diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 71cdaa187..9655d6a37 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -27,30 +27,37 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_ids`** *Array* *of UUIDs* + + + + + + + + + + +
PropertyDescription
acs_encoder_ids Array of UUIDs IDs of the `acs_encoder`s that you want to retrieve. --- - -**`acs_system_id`** *String* +
acs_system_id String ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. --- - -**`acs_system_ids`** *Array* *of UUIDs* +
acs_system_ids Array of UUIDs IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. --- - -**`limit`** *Number* +
limit Number Number of `acs_encoders` to return. --- - +
## Response diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 101d17445..57e143f4a 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** *String* (Required) + + + + +
PropertyDescription
acs_encoder_id String (Required) ID of the `acs_encoder` to use for the scan. --- - +
## Response diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index b14437d20..04fa508bd 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -27,24 +27,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** *String* (Required) + + + + + + + + +
PropertyDescription
acs_encoder_id String (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- - -**`acs_credential_id`** *String* +
acs_credential_id String ID of the `acs_credential` that will fail to be encoded onto a card in the next request. --- - -**`error_code`** *String* +
error_code String Code of the error to simulate. --- - +
## Response diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index cf65a0918..2dbe1e6dd 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_encoder_id String (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. --- - -**`scenario`** *String* +
scenario String Scenario to simulate. --- - +
## Response diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index 308d70237..c6f4bcb63 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -27,20 +27,26 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** *String* (Required) + + + + + + + + +
PropertyDescription
acs_encoder_id String (Required) ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. --- - -**`acs_credential_id_on_seam`** *String* +
acs_credential_id_on_seam String --- - -**`error_code`** *String* +
error_code String --- - +
## Response diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index f3802da18..867ae9aea 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -27,24 +27,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_encoder_id`** *String* (Required) + + + + + + + + +
PropertyDescription
acs_encoder_id String (Required) ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. --- - -**`acs_credential_id_on_seam`** *String* +
acs_credential_id_on_seam String ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. --- - -**`scenario`** *String* +
scenario String Scenario to simulate. --- - +
## Response diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index ac234ca30..c836260da 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -26,10 +26,14 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_entrance_id`** *String* (Required) + + + + +
PropertyDescription
acs_entrance_id String (Required) --- - +
## Response diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index eac8bc075..c364b134e 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -27,14 +27,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_entrance_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_entrance_id String (Required) --- - -**`acs_user_id`** *String* (Required) +
acs_user_id String (Required) --- - +
## Response diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index d876b0054..83c98b222 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -28,14 +28,19 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** *String* + + + + + + +
PropertyDescription
acs_credential_id String --- - -**`acs_system_id`** *String* +
acs_system_id String --- - +
## Response diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 6925b7dd6..81083d589 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -28,11 +28,15 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_entrance_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_entrance_id String (Required) --- - -**`include_if`** *Array* *of Enums* +
include_if Array of Enums
Enum values @@ -42,7 +46,8 @@ Possible enum values:
--- - +
## Response diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index ff3d211c8..c59fc6085 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -29,12 +29,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* (Required) + + + + +
PropertyDescription
acs_system_id String (Required) ID of the desired access control system. --- - +
## Response diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index c63a7e005..5279e8257 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -30,12 +30,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`connected_account_id`** *String* + + + + +
PropertyDescription
connected_account_id String ID of the connected account by which to filter the list of returned access control systems. --- - +
## Response diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 8e69f3bbd..f9816b7ee 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -29,12 +29,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* (Required) + + + + +
PropertyDescription
acs_system_id String (Required) ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. --- - +
## Response diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index c4fc24a78..4691d02dc 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_access_group_id String (Required) ID of the desired access group. --- - -**`acs_user_id`** *String* (Required) +
acs_user_id String (Required) ID of the desired `acs_user`. --- - +
## Response diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index e96b83539..795008f35 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -27,52 +27,63 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* (Required) + + + + + + + + + + + + + + + + + + +
PropertyDescription
acs_system_id String (Required) ID of the `acs_system` to which to add the new `acs_user`. --- - -**`full_name`** *String* (Required) +
full_name String (Required) Full name of the new `acs_user`. --- - -**`access_schedule`** *Object* +
access_schedule Object `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. --- - -**`acs_access_group_ids`** *Array* *of UUIDs* +
acs_access_group_ids Array of UUIDs Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. --- - -**`email`** *String* +
email String --- - -**`email_address`** *String* +
email_address String Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- - -**`phone_number`** *String* +
phone_number String Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- - -**`user_identity_id`** *String* +
user_identity_id String ID of the user identity with which to associate the new `acs_user`. --- - +
## Response diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 59b00588b..0050c138b 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** *String* (Required) + + + + +
PropertyDescription
acs_user_id String (Required) ID of the desired `acs_user`. --- - +
## Response diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 2ee20bba9..4df2bbfa0 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** *String* (Required) + + + + +
PropertyDescription
acs_user_id String (Required) ID of the desired `acs_user`. --- - +
## Response diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 77ee3e652..ef8cc356b 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -28,52 +28,63 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_system_id`** *String* + + + + + + + + + + + + + + + + + + +
PropertyDescription
acs_system_id String ID of the `acs_system` for which you want to retrieve all `acs_user`s. --- - -**`created_before`** *String* +
created_before String --- - -**`limit`** *Number* +
limit Number Maximum number of records to return per page. --- - -**`page_cursor`** *String* +
page_cursor String Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. --- - -**`search`** *String* +
search String String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. --- - -**`user_identity_email_address`** *String* +
user_identity_email_address String Email address of the user identity for which you want to retrieve all `acs_user`s. --- - -**`user_identity_id`** *String* +
user_identity_id String ID of the user identity for which you want to retrieve all `acs_user`s. --- - -**`user_identity_phone_number`** *String* +
user_identity_phone_number String Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). --- - +
## Response diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index acf996785..c08470358 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -28,12 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** *String* (Required) + + + + +
PropertyDescription
acs_user_id String (Required) ID of the desired `acs_user`. --- - +
## Response diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 650eb9d90..c41555af9 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_access_group_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_access_group_id String (Required) ID of the desired access group. --- - -**`acs_user_id`** *String* (Required) +
acs_user_id String (Required) ID of the desired `acs_user`. --- - +
## Response diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 62085c201..eceef223a 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** *String* (Required) + + + + +
PropertyDescription
acs_user_id String (Required) ID of the desired `acs_user`. --- - +
## Response diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 8e2617641..e1a2685d5 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** *String* (Required) + + + + +
PropertyDescription
acs_user_id String (Required) ID of the desired `acs_user`. --- - +
## Response diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index cb3dd3a14..4c9fd2299 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** *String* (Required) + + + + +
PropertyDescription
acs_user_id String (Required) ID of the desired `acs_user`. --- - +
## Response diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index f5c046d06..b1c2b0112 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -27,44 +27,54 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** *String* (Required) + + + + + + + + + + + + + + + + +
PropertyDescription
acs_user_id String (Required) ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- - -**`access_schedule`** *Object* +
access_schedule Object `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. --- - -**`email`** *String* +
email String --- - -**`email_address`** *String* +
email_address String Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- - -**`full_name`** *String* +
full_name String Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). --- - -**`hid_acs_system_id`** *String* +
hid_acs_system_id String --- - -**`phone_number`** *String* +
phone_number String Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). --- - +
## Response diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 8fc235f83..0ff894733 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -28,12 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + +
PropertyDescription
device_id String (Required) Device ID of the desired phone. --- - +
## Response diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 41d463f9a..981920757 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + +
PropertyDescription
device_id String (Required) Device ID of the desired phone. --- - +
## Response diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 3a029a3c8..9fc9b03f3 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_credential_id`** *String* + + + + + + +
PropertyDescription
acs_credential_id String ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. --- - -**`owner_user_identity_id`** *String* +
owner_user_identity_id String ID of the user identity that represents the owner by which to filter the list of returned phones. --- - +
## Response diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 6d0b53df0..ed7e17aa2 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -27,30 +27,37 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** *String* (Required) + + + + + + + + + + +
PropertyDescription
user_identity_id String (Required) ID of the user identity to associate with the simulated phone. --- - -**`assa_abloy_metadata`** *Object* +
assa_abloy_metadata Object ASSA ABLOY metadata to associate with the simulated phone. --- - -**`custom_sdk_installation_id`** *String* +
custom_sdk_installation_id String ID of the custom SDK installation to use for the simulated phone. --- - -**`phone_metadata`** *Object* +
phone_metadata Object Metadata to associate with the simulated phone. --- - +
## Response diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 3df1aa214..395b2a3f8 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** *String* (Required) + + + + + + +
PropertyDescription
climate_preset_key String (Required) Climate preset key of the desired climate preset. --- - -**`device_id`** *String* (Required) +
device_id String (Required) ID of the desired thermostat device. --- - +
## Response diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 561c6da7c..9d49740b8 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -28,24 +28,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired thermostat device. --- - -**`cooling_set_point_celsius`** *Number* +
cooling_set_point_celsius Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- - -**`cooling_set_point_fahrenheit`** *Number* +
cooling_set_point_fahrenheit Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- - +
## Response diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index bd0b9d70b..dc18de359 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -28,66 +28,79 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** *String* (Required) + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
climate_preset_key String (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- - -**`device_id`** *String* (Required) +
device_id String (Required) ID of the desired thermostat device. --- - -**`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). --- - -**`fan_mode_setting`** *String* +
fan_mode_setting String 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`. --- - -**`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`** *String* +
hvac_mode_setting String Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- - -**`manual_override_allowed`** *Boolean* +
manual_override_allowed Boolean Indicates whether a person at the thermostat or using the API can change the thermostat's settings. --- - -**`name`** *String* +
name String User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- - +
## Response diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index eb486bb0b..e152b10d1 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -28,18 +28,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** *String* (Required) + + + + + + +
PropertyDescription
climate_preset_key String (Required) Climate preset key of the desired climate preset. --- - -**`device_id`** *String* (Required) +
device_id String (Required) ID of the desired thermostat device. --- - +
## Response diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index c73f8fa86..c10089cde 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -28,24 +28,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired thermostat device. --- - -**`heating_set_point_celsius`** *Number* +
heating_set_point_celsius Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- - -**`heating_set_point_fahrenheit`** *Number* +
heating_set_point_fahrenheit Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. --- - +
## Response diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 05487869a..d55eb3d73 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -28,36 +28,44 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired thermostat device. --- - -**`cooling_set_point_celsius`** *Number* +
cooling_set_point_celsius Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- - -**`cooling_set_point_fahrenheit`** *Number* +
cooling_set_point_fahrenheit Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- - -**`heating_set_point_celsius`** *Number* +
heating_set_point_celsius Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- - -**`heating_set_point_fahrenheit`** *Number* +
heating_set_point_fahrenheit Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. --- - +
## Response diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 444972c8b..2f11668c4 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -28,49 +28,59 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`connect_webview_id`** *String* + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
connect_webview_id String ID of the Connect Webview by which to filter devices. --- - -**`connected_account_id`** *String* +
connected_account_id String ID of the connected account by which to filter. --- - -**`connected_account_ids`** *Array* *of UUIDs* +
connected_account_ids Array of UUIDs Array of IDs of the connected accounts by which to filter devices. --- - -**`created_before`** *String* +
created_before String Date threshold for devices to return. If specified, returns only devices created before the specified date. --- - -**`custom_metadata_has`** *Object* +
custom_metadata_has Object Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. --- - -**`device_ids`** *Array* *of UUIDs* +
device_ids Array of UUIDs Array of device IDs by which to filter devices. --- - -**`device_type`** *String* +
device_type String Device type by which to filter devices. --- - -**`device_types`** *Array* *of Enums* +
device_types Array of Enums Array of device types by which to filter devices.
@@ -86,25 +96,29 @@ Possible enum values:
--- - -**`limit`** *Number* +
limit Number Numerical limit on the number of devices to return. --- - -**`manufacturer`** *String* +
manufacturer String Manufacturer by which to filter devices. --- - -**`user_identifier_key`** *String* +
user_identifier_key String Your own internal user ID for the user by which to filter devices. --- - +
## Response diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index b1694690f..322c984f7 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -28,12 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + +
PropertyDescription
device_id String (Required) ID of the desired thermostat device. --- - +
## Response diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index dad3ec776..3ba7a0b6e 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -28,48 +28,58 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** *String* (Required) + + + + + + + + + + + + + + + + +
PropertyDescription
climate_preset_key String (Required) Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- - -**`device_id`** *String* (Required) +
device_id String (Required) ID of the desired thermostat device. --- - -**`ends_at`** *String* (Required) +
ends_at String (Required) Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- - -**`starts_at`** *String* (Required) +
starts_at String (Required) Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- - -**`is_override_allowed`** *Boolean* +
is_override_allowed Boolean Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- - -**`max_override_period_minutes`** *Number* +
max_override_period_minutes Number Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- - -**`name`** *String* +
name String User-friendly name to identify the thermostat schedule. --- - +
## Response diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 46d7b7299..3f0d200eb 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -28,12 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`thermostat_schedule_id`** *String* (Required) + + + + +
PropertyDescription
thermostat_schedule_id String (Required) ID of the desired thermostat schedule. --- - +
## Response diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index f20321048..cd9966cc2 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -28,12 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`thermostat_schedule_id`** *String* (Required) + + + + +
PropertyDescription
thermostat_schedule_id String (Required) ID of the desired thermostat schedule. --- - +
## Response diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 9193dff83..d9a5fbca1 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -28,18 +28,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired thermostat device. --- - -**`user_identifier_key`** *String* +
user_identifier_key String User identifier key by which to filter the list of returned thermostat schedules. --- - +
## Response diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index aad85566b..fde6cebbd 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -28,48 +28,58 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`thermostat_schedule_id`** *String* (Required) + + + + + + + + + + + + + + + + +
PropertyDescription
thermostat_schedule_id String (Required) ID of the desired thermostat schedule. --- - -**`climate_preset_key`** *String* +
climate_preset_key String Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. --- - -**`ends_at`** *String* +
ends_at String Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- - -**`is_override_allowed`** *Boolean* +
is_override_allowed Boolean Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- - -**`max_override_period_minutes`** *Number* +
max_override_period_minutes Number Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- - -**`name`** *String* +
name String User-friendly name to identify the thermostat schedule. --- - -**`starts_at`** *String* +
starts_at String Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. --- - +
## Response diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 61bdfc64a..c0d34067a 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** *String* (Required) + + + + + + +
PropertyDescription
climate_preset_key String (Required) Climate preset key of the desired climate preset. --- - -**`device_id`** *String* (Required) +
device_id String (Required) ID of the desired thermostat device. --- - +
## Response diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 81c4b3f7e..08fa53f41 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -28,20 +28,26 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + + + +
PropertyDescription
device_id String (Required) --- - -**`fan_mode`** *String* +
fan_mode String --- - -**`fan_mode_setting`** *String* +
fan_mode_setting String Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. --- - +
## Response diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 6534646d2..877138689 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -28,40 +28,49 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + + + + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired thermostat device. --- - -**`hvac_mode_setting`** *String* (Required) +
hvac_mode_setting String (Required) --- - -**`cooling_set_point_celsius`** *Number* +
cooling_set_point_celsius Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. --- - -**`cooling_set_point_fahrenheit`** *Number* +
cooling_set_point_fahrenheit Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. --- - -**`heating_set_point_celsius`** *Number* +
heating_set_point_celsius Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. --- - -**`heating_set_point_fahrenheit`** *Number* +
heating_set_point_fahrenheit Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. --- - +
## Response diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 267d79040..ca00530b2 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -27,36 +27,44 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired thermostat device. --- - -**`lower_limit_celsius`** *Number* +
lower_limit_celsius Number Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- - -**`lower_limit_fahrenheit`** *Number* +
lower_limit_fahrenheit Number Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. --- - -**`upper_limit_celsius`** *Number* +
upper_limit_celsius Number Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. --- - -**`upper_limit_fahrenheit`** *Number* +
upper_limit_fahrenheit Number Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. --- - +
## Response diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index e8c78fb7e..808534d16 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -27,42 +27,51 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + + + + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired thermostat device. --- - -**`hvac_mode`** *String* (Required) +
hvac_mode String (Required) Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate. --- - -**`cooling_set_point_celsius`** *Number* +
cooling_set_point_celsius Number Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. --- - -**`cooling_set_point_fahrenheit`** *Number* +
cooling_set_point_fahrenheit Number Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. --- - -**`heating_set_point_celsius`** *Number* +
heating_set_point_celsius Number Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. --- - -**`heating_set_point_fahrenheit`** *Number* +
heating_set_point_fahrenheit Number Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. --- - +
## Response diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index b099bb241..fc722dcdb 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -27,24 +27,30 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired thermostat device. --- - -**`temperature_celsius`** *Number* +
temperature_celsius Number Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. --- - -**`temperature_fahrenheit`** *Number* +
temperature_fahrenheit Number Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. --- - +
## Response diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index 99108d22a..cde1da86a 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -28,66 +28,79 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`climate_preset_key`** *String* (Required) + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
climate_preset_key String (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- - -**`device_id`** *String* (Required) +
device_id String (Required) ID of the desired thermostat device. --- - -**`manual_override_allowed`** *Boolean* (Required) +
manual_override_allowed Boolean (Required) Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). --- - -**`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). --- - -**`fan_mode_setting`** *String* +
fan_mode_setting String 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`. --- - -**`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`** *String* +
hvac_mode_setting String Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. --- - -**`name`** *String* +
name String User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). --- - +
## Response diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 53b390853..25001f64b 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_user_id String (Required) ID of the desired ACS user. --- - -**`user_identity_id`** *String* (Required) +
user_identity_id String (Required) ID of the desired user identity. --- - +
## Response diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 4caf008f8..ccc7479f2 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -27,30 +27,37 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`email_address`** *String* + + + + + + + + + + +
PropertyDescription
email_address String Unique email address for the user identity. --- - -**`full_name`** *String* +
full_name String Full name of the user associated with the user identity. --- - -**`phone_number`** *String* +
phone_number String Unique phone number for the user identity in E.164 format (for example, +15555550100). --- - -**`user_identity_key`** *String* +
user_identity_key String Unique key for the user identity. --- - +
## Response diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index e2fa91454..10157e291 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** *String* (Required) + + + + +
PropertyDescription
user_identity_id String (Required) ID of the desired user identity. --- - +
## Response diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 48027ddfe..df00241d7 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`enrollment_automation_id`** *String* (Required) + + + + +
PropertyDescription
enrollment_automation_id String (Required) ID of the desired enrollment automation. --- - +
## Response diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 918a1ae8d..419dd5035 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -28,12 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`enrollment_automation_id`** *String* (Required) + + + + +
PropertyDescription
enrollment_automation_id String (Required) ID of the desired enrollment automation. --- - +
## Response diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index dadb77f39..ff46d358d 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -27,36 +27,44 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`credential_manager_acs_system_id`** *String* (Required) + + + + + + + + + + + + +
PropertyDescription
credential_manager_acs_system_id String (Required) ID of the desired ACS system that serves as the credential manager. --- - -**`user_identity_id`** *String* (Required) +
user_identity_id String (Required) ID of the desired user identity. --- - -**`acs_credential_pool_id`** *String* +
acs_credential_pool_id String ID of the ACS credential pool from which to obtain credentials for the user identity. --- - -**`create_credential_manager_user`** *Boolean* +
create_credential_manager_user Boolean Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. --- - -**`credential_manager_acs_user_id`** *String* +
credential_manager_acs_user_id String ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. --- - +
## Response diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index ef1924ec3..248998a2c 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -28,12 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** *String* (Required) + + + + +
PropertyDescription
user_identity_id String (Required) ID of the user identity for which you want to retrieve all enrollment automations. --- - +
## Response diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 0b9ff7504..757ea9ed8 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -27,16 +27,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** *String* + + + + + + +
PropertyDescription
user_identity_id String ID of the desired user identity. --- - -**`user_identity_key`** *String* +
user_identity_key String --- - +
## Response diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 99292e176..1d490e166 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired managed device. --- - -**`user_identity_id`** *String* (Required) +
user_identity_id String (Required) ID of the desired user identity. --- - +
## Response diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 3e5861bdc..62322824d 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -28,10 +28,14 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`credential_manager_acs_system_id`** *String* + + + + +
PropertyDescription
credential_manager_acs_system_id String --- - +
## Response diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 989b56026..50876767e 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** *String* (Required) + + + + +
PropertyDescription
user_identity_id String (Required) ID of the user identity for which you want to retrieve all accessible devices. --- - +
## Response diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index a5d80fc9e..ef3f33070 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -28,12 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** *String* (Required) + + + + +
PropertyDescription
user_identity_id String (Required) ID of the user identity for which you want to retrieve all access control systems. --- - +
## Response diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index f4a52b10c..a31533776 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -27,12 +27,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** *String* (Required) + + + + +
PropertyDescription
user_identity_id String (Required) ID of the user identity for which you want to retrieve all ACS users. --- - +
## Response diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 8d4f0febe..e87a53205 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`acs_user_id`** *String* (Required) + + + + + + +
PropertyDescription
acs_user_id String (Required) ID of the ACS user. --- - -**`user_identity_id`** *String* (Required) +
user_identity_id String (Required) ID of the desired user identity. --- - +
## Response diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 933386f09..5b3cac5f8 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -27,18 +27,23 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`device_id`** *String* (Required) + + + + + + +
PropertyDescription
device_id String (Required) ID of the desired managed device. --- - -**`user_identity_id`** *String* (Required) +
user_identity_id String (Required) ID of the desired user identity. --- - +
## Response diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index d30753698..1632f2ad4 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -27,34 +27,42 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters -**`user_identity_id`** *String* (Required) + + + + + + + + + + + + +
PropertyDescription
user_identity_id String (Required) ID of the user identity. --- - -**`email_address`** *String* +
email_address String Unique email address for the user identity. --- - -**`full_name`** *String* +
full_name String --- - -**`phone_number`** *String* +
phone_number String Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). --- - -**`user_identity_key`** *String* +
user_identity_key String Unique key for the user identity. --- - +
## Response From 1d47cbe7255e8b286644a22bd454544914923588 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:12:40 -0400 Subject: [PATCH 222/233] Update api-route.hbs --- src/layouts/api-route.hbs | 41 +++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 17 deletions(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index b9012d4e9..10e0e5a73 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -6,36 +6,40 @@ ## Errors + + {{#each errors}} -**`{{name}}`** - -{{description}} - ---- + + + {{/each}} +
ErrorDescription
{{name}}{{description}}
{{/if}} {{#if warnings.length}} ## Warnings + + {{#each warnings}} -**`{{name}}`** - -{{description}} - ---- + + + {{/each}} +
WarningDescription
{{name}}{{description}}
{{/if}} {{/each}} {{#if events.length}} ## Events + + {{#each events}} -**`{{name}}`** - + + {{/each}} {{/if}} +
EventDescription
{{name}} {{#if description}} {{description}} @@ -49,17 +53,20 @@ {{/each}} ---- - +
+ ## Endpoints + + {{#each endpoints}} -[**`{{path}}`**](./{{name}}.md) + -{{description}} + {{/each}} - +
EndpointDescription
{{path}}{{description}}
From 06f2720849407f2c99d30478c5709b28ee29d3d0 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:13:25 -0400 Subject: [PATCH 223/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 4753ca460..8fe57adce 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -34,7 +34,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati {{#if request.parameters.length}} - + {{#each request.parameters}} {{/each}}
PropertyDescription
ParameterDescription
{{this.name}} {{this.jsonType}}{{#if this.itemFormat}} of {{this.itemFormat}}s{{/if}}{{#if this.required}} (Required){{/if}} @@ -50,8 +50,6 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati {{> enum-values enumValues=this.itemEnumValues}} {{/if}} - ----
From 7a3282e9e18b18607be588912f1585a05ce5073a Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 04:14:24 +0000 Subject: [PATCH 224/233] ci: Generate docs --- docs/api/access_codes/README.md | 573 +++++++----------- docs/api/access_codes/create.md | 34 +- docs/api/access_codes/create_multiple.md | 34 +- docs/api/access_codes/delete.md | 6 +- docs/api/access_codes/get.md | 8 +- docs/api/access_codes/list.md | 8 +- .../access_codes/pull_backup_access_code.md | 4 +- docs/api/access_codes/simulate/README.md | 10 +- .../simulate/create_unmanaged_access_code.md | 8 +- docs/api/access_codes/unmanaged/README.md | 440 ++++++-------- .../unmanaged/convert_to_managed.md | 10 +- docs/api/access_codes/unmanaged/delete.md | 4 +- docs/api/access_codes/unmanaged/get.md | 8 +- docs/api/access_codes/unmanaged/list.md | 6 +- docs/api/access_codes/unmanaged/update.md | 12 +- docs/api/access_codes/update.md | 38 +- docs/api/access_codes/update_multiple.md | 10 +- docs/api/acs/access_groups/README.md | 37 +- docs/api/acs/access_groups/add_user.md | 6 +- docs/api/acs/access_groups/get.md | 4 +- docs/api/acs/access_groups/list.md | 6 +- .../list_accessible_entrances.md | 4 +- docs/api/acs/access_groups/list_users.md | 4 +- docs/api/acs/access_groups/remove_user.md | 6 +- docs/api/acs/credentials/README.md | 117 ++-- docs/api/acs/credentials/assign.md | 6 +- docs/api/acs/credentials/create.md | 24 +- docs/api/acs/credentials/delete.md | 4 +- docs/api/acs/credentials/get.md | 4 +- docs/api/acs/credentials/list.md | 14 +- .../credentials/list_accessible_entrances.md | 4 +- docs/api/acs/credentials/unassign.md | 6 +- docs/api/acs/credentials/update.md | 8 +- docs/api/acs/encoders/README.md | 32 +- docs/api/acs/encoders/encode_credential.md | 6 +- docs/api/acs/encoders/list.md | 10 +- docs/api/acs/encoders/scan_credential.md | 4 +- docs/api/acs/encoders/simulate/README.md | 22 +- .../next_credential_encode_will_fail.md | 8 +- .../next_credential_encode_will_succeed.md | 6 +- .../next_credential_scan_will_fail.md | 8 +- .../next_credential_scan_will_succeed.md | 8 +- docs/api/acs/entrances/README.md | 36 +- docs/api/acs/entrances/get.md | 4 +- docs/api/acs/entrances/grant_access.md | 6 +- docs/api/acs/entrances/list.md | 6 +- .../entrances/list_credentials_with_access.md | 6 +- docs/api/acs/systems/README.md | 123 ++-- docs/api/acs/systems/get.md | 4 +- docs/api/acs/systems/list.md | 4 +- ...mpatible_credential_manager_acs_systems.md | 4 +- docs/api/acs/users/README.md | 127 ++-- docs/api/acs/users/add_to_access_group.md | 6 +- docs/api/acs/users/create.md | 18 +- docs/api/acs/users/delete.md | 4 +- docs/api/acs/users/get.md | 4 +- docs/api/acs/users/list.md | 18 +- .../acs/users/list_accessible_entrances.md | 4 +- .../api/acs/users/remove_from_access_group.md | 6 +- .../users/revoke_access_to_all_entrances.md | 4 +- docs/api/acs/users/suspend.md | 4 +- docs/api/acs/users/unsuspend.md | 4 +- docs/api/acs/users/update.md | 16 +- docs/api/phones/README.md | 25 +- docs/api/phones/deactivate.md | 4 +- docs/api/phones/get.md | 4 +- docs/api/phones/list.md | 6 +- docs/api/phones/simulate/README.md | 10 +- .../phones/simulate/create_sandbox_phone.md | 10 +- docs/api/thermostats/README.md | 58 +- .../thermostats/activate_climate_preset.md | 6 +- docs/api/thermostats/cool.md | 8 +- docs/api/thermostats/create_climate_preset.md | 22 +- docs/api/thermostats/delete_climate_preset.md | 6 +- docs/api/thermostats/heat.md | 8 +- docs/api/thermostats/heat_cool.md | 12 +- docs/api/thermostats/list.md | 24 +- docs/api/thermostats/off.md | 4 +- docs/api/thermostats/schedules/README.md | 26 +- docs/api/thermostats/schedules/create.md | 16 +- docs/api/thermostats/schedules/delete.md | 4 +- docs/api/thermostats/schedules/get.md | 4 +- docs/api/thermostats/schedules/list.md | 6 +- docs/api/thermostats/schedules/update.md | 16 +- .../set_fallback_climate_preset.md | 6 +- docs/api/thermostats/set_fan_mode.md | 8 +- docs/api/thermostats/set_hvac_mode.md | 14 +- .../thermostats/set_temperature_threshold.md | 12 +- docs/api/thermostats/simulate/README.md | 14 +- .../simulate/hvac_mode_adjusted.md | 14 +- .../simulate/temperature_reached.md | 8 +- docs/api/thermostats/update_climate_preset.md | 22 +- docs/api/user_identities/README.md | 54 +- docs/api/user_identities/add_acs_user.md | 6 +- docs/api/user_identities/create.md | 10 +- docs/api/user_identities/delete.md | 4 +- .../enrollment_automations/README.md | 29 +- .../enrollment_automations/delete.md | 4 +- .../enrollment_automations/get.md | 4 +- .../enrollment_automations/launch.md | 12 +- .../enrollment_automations/list.md | 4 +- docs/api/user_identities/get.md | 6 +- .../user_identities/grant_access_to_device.md | 6 +- docs/api/user_identities/list.md | 4 +- .../list_accessible_devices.md | 4 +- docs/api/user_identities/list_acs_systems.md | 4 +- docs/api/user_identities/list_acs_users.md | 4 +- docs/api/user_identities/remove_acs_user.md | 6 +- .../revoke_access_to_device.md | 6 +- docs/api/user_identities/update.md | 12 +- 110 files changed, 875 insertions(+), 1660 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 4a5be08a8..74d309882 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -223,321 +223,227 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Errors -**`smartthings_failed_to_set_access_code`** - -Failed to set code on SmartThings device. - ---- - -**`smartthings_failed_to_set_after_multiple_retries`** - -Failed to set code after multiple retries. - ---- - -**`smartthings_no_free_slots_available`** - -No free slots available on the device. - ---- - -**`failed_to_set_on_device`** - -Failed to set code on device. - ---- - -**`failed_to_remove_from_device`** - -Failed to remove code from device. - ---- - -**`duplicate_code_on_device`** - -Duplicate access code detected on device. - ---- - -**`duplicate_code_attempt_prevented`** - -An attempt to modify this access code was prevented. - ---- - -**`igloohome_bridge_too_many_pending_jobs`** - -Igloohome bridge has too many pending jobs in the queue. - ---- - -**`igloohome_bridge_offline`** - -Igloohome bridge is offline. - ---- - -**`igloohome_offline_access_code_no_variance_available`** - -Lock has reached maximum amount of codes. - ---- - -**`kwikset_unable_to_confirm_code`** - -Unable to confirm that the access code is set on Kwikset device. - ---- - -**`kwikset_unable_to_confirm_deletion`** - -Unable to confirm the deletion of the access code on Kwikset device. - ---- - -**`code_modified_external_to_seam`** - -Code was modified or removed externally after Seam successfully set it on the device. - ---- - -**`august_lock_invalid_code_length`** - -Invalid code length for August lock. - ---- - -**`august_device_programming_delay`** - -Access code has not yet been fully moved to the device. - ---- - -**`august_device_slots_full`** - -All access code slots on the device are full. - ---- - -**`august_lock_missing_keypad`** - -August lock is missing a keypad. - ---- - -**`august_lock_temporarily_offline`** - -August lock is temporarily offline. - ---- - -**`salto_ks_user_not_subscribed`** - -Salto site user is not subscribed. - ---- - -**`hubitat_device_programming_delay`** - -Access code has not yet been fully moved to the device. - ---- - -**`hubitat_no_free_positions_available`** - -No free positions available on the device. - ---- - -**`wyze_duplicate_code_name`** - -Duplicate access code name detected. - ---- - -**`wyze_potential_duplicate_code`** - -Potential duplicate access code detected. - ---- - -**`dormakaba_oracode_no_valid_user_level`** - -No valid user level for Oracode. - ---- - -**`account_disconnected`** - -Account is disconnected - ---- - -**`salto_ks_subscription_limit_exceeded`** - -Salto site user limit reached. + + + ---- + + + -**`device_offline`** + + + -Device is offline + + + ---- + + + -**`device_removed`** + + + -Device has been removed + + + ---- + + + -**`hub_disconnected`** - -Hub is disconnected - ---- + + + -**`device_disconnected`** + + + -Device is disconnected + + + ---- + + + -**`empty_backup_access_code_pool`** + + + -The backup access code pool is empty. + + + ---- + + + -**`august_lock_not_authorized`** + + + -User is not authorized to use the August Lock. + + + ---- + + + -**`august_lock_missing_bridge`** + + + -Lock is not connected to the Seam Bridge. + + + ---- + + + -**`ttlock_lock_not_paired_to_gateway`** + + + -Lock is not paired with a Gateway. + + + ---- + + + -**`missing_device_credentials`** + + + -Missing device credentials. + + + ---- + + + -**`auxiliary_heat_running`** + + + -The auxiliary heat is running. + + + ---- + + + -**`subscription_required`** + + + -Subscription required to connect. + + + ---- + + + -**`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). + + + ---- + + + + + +
ErrorDescription
smartthings_failed_to_set_access_codeFailed to set code on SmartThings device.
smartthings_failed_to_set_after_multiple_retriesFailed to set code after multiple retries.
smartthings_no_free_slots_availableNo free slots available on the device.
failed_to_set_on_deviceFailed to set code on device.
failed_to_remove_from_deviceFailed to remove code from device.
duplicate_code_on_deviceDuplicate access code detected on device.
duplicate_code_attempt_preventedAn attempt to modify this access code was prevented.
igloohome_bridge_too_many_pending_jobsIgloohome bridge has too many pending jobs in the queue.
igloohome_bridge_offlineIgloohome bridge is offline.
igloohome_offline_access_code_no_variance_availableLock has reached maximum amount of codes.
kwikset_unable_to_confirm_codeUnable to confirm that the access code is set on Kwikset device.
kwikset_unable_to_confirm_deletionUnable to confirm the deletion of the access code on Kwikset device.
code_modified_external_to_seamCode was modified or removed externally after Seam successfully set it on the device.
august_lock_invalid_code_lengthInvalid code length for August lock.
august_device_programming_delayAccess code has not yet been fully moved to the device.
august_device_slots_fullAll access code slots on the device are full.
august_lock_missing_keypadAugust lock is missing a keypad.
august_lock_temporarily_offlineAugust lock is temporarily offline.
salto_ks_user_not_subscribedSalto site user is not subscribed.
hubitat_device_programming_delayAccess code has not yet been fully moved to the device.
hubitat_no_free_positions_availableNo free positions available on the device.
wyze_duplicate_code_nameDuplicate access code name detected.
wyze_potential_duplicate_codePotential duplicate access code detected.
dormakaba_oracode_no_valid_user_levelNo valid user level for Oracode.
account_disconnectedAccount is disconnected
salto_ks_subscription_limit_exceededSalto site user limit reached.
device_offlineDevice is offline
device_removedDevice has been removed
hub_disconnectedHub is disconnected
device_disconnectedDevice is disconnected
empty_backup_access_code_poolThe backup access code pool is empty.
august_lock_not_authorizedUser is not authorized to use the August Lock.
august_lock_missing_bridgeLock is not connected to the Seam Bridge.
ttlock_lock_not_paired_to_gatewayLock is not paired with a Gateway.
missing_device_credentialsMissing device credentials.
auxiliary_heat_runningThe auxiliary heat is running.
subscription_requiredSubscription required to connect.
invalid_credentialsCredentials provided were invalid.
bridge_disconnectedIndicates 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).
## Warnings -**`smartthings_failed_to_set_access_code`** - -Failed to set code on SmartThings device. - ---- - -**`schlage_detected_duplicate`** - -Duplicate access code detected. - ---- - -**`schlage_creation_outage`** - -Received an error when attempting to create this code. - ---- - -**`code_modified_external_to_seam`** - -Code was modified or removed externally after Seam successfully set it on the device. - ---- - -**`delay_in_setting_on_device`** - -Delay in setting code on device. - ---- - -**`delay_in_removing_from_device`** - -Delay in removing code from device. - ---- - -**`third_party_integration_detected`** - -Third-party integration detected that may cause access codes to fail. - ---- - -**`august_device_programming_delay`** - -Access code has not yet been fully moved to the device. - ---- - -**`august_lock_temporarily_offline`** + + + -August lock is temporarily offline. + + + ---- + + + -**`igloo_algopin_must_be_used_within_24_hours`** + + + -Algopins must be used within 24 hours. + + + ---- + + + -**`management_transferred`** + + + -Management was transferred to another workspace. + + + ---- + + + -**`kwikset_unable_to_confirm_code`** + + + -Unable to confirm that the access code is set on Kwikset device. + + + ---- + + + + + +
WarningDescription
smartthings_failed_to_set_access_codeFailed to set code on SmartThings device.
schlage_detected_duplicateDuplicate access code detected.
schlage_creation_outageReceived an error when attempting to create this code.
code_modified_external_to_seamCode was modified or removed externally after Seam successfully set it on the device.
delay_in_setting_on_deviceDelay in setting code on device.
delay_in_removing_from_deviceDelay in removing code from device.
third_party_integration_detectedThird-party integration detected that may cause access codes to fail.
august_device_programming_delayAccess code has not yet been fully moved to the device.
august_lock_temporarily_offlineAugust lock is temporarily offline.
igloo_algopin_must_be_used_within_24_hoursAlgopins must be used within 24 hours.
management_transferredManagement was transferred to another workspace.
kwikset_unable_to_confirm_codeUnable to confirm that the access code is set on Kwikset device.
## Events -**`access_code.created`** - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EventDescription
access_code.created An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created.
@@ -591,10 +497,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.changed`** - +
access_code.changed An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was changed.
@@ -648,10 +553,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.scheduled_on_device`** - +
access_code.scheduled_on_device An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was [scheduled natively](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) on a device.
@@ -711,10 +615,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.set_on_device`** - +
access_code.set_on_device An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was set on a device.
@@ -774,10 +677,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.removed_from_device`** - +
access_code.removed_from_device An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was removed from a device.
@@ -831,10 +733,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.delay_in_setting_on_device`** - +
access_code.delay_in_setting_on_device There was an unusually long delay in setting an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) on a device.
@@ -888,10 +789,9 @@ There was an unusually long delay in setting an [access code](https://docs.seam.
---- - -**`access_code.failed_to_set_on_device`** - +
access_code.failed_to_set_on_device An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be set on a device.
@@ -945,10 +845,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.deleted`** - +
access_code.deleted An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted.
@@ -1008,10 +907,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.delay_in_removing_from_device`** - +
access_code.delay_in_removing_from_device There was an unusually long delay in removing an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) from a device.
@@ -1065,10 +963,9 @@ There was an unusually long delay in removing an [access code](https://docs.seam
---- - -**`access_code.failed_to_remove_from_device`** - +
access_code.failed_to_remove_from_device An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) failed to be removed from a device.
@@ -1122,10 +1019,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.modified_external_to_seam`** - +
access_code.modified_external_to_seam An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was modified outside of Seam.
@@ -1179,10 +1075,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.deleted_external_to_seam`** - +
access_code.deleted_external_to_seam An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was deleted outside of Seam.
@@ -1236,10 +1131,9 @@ An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/acces
---- - -**`access_code.backup_access_code_pulled`** - +
access_code.backup_access_code_pulled A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes) was pulled from the backup access code pool and set on a device.
@@ -1297,10 +1191,9 @@ A [backup access code](https://docs.seam.co/latest/capability-guides/smart-locks
---- - -**`access_code.unmanaged.converted_to_managed`** - +
access_code.unmanaged.converted_to_managed An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was converted successfully to a managed access code.
@@ -1354,10 +1247,9 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
---- - -**`access_code.unmanaged.failed_to_convert_to_managed`** - +
access_code.unmanaged.failed_to_convert_to_managed An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) failed to be converted to a managed access code.
@@ -1411,10 +1303,9 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
---- - -**`access_code.unmanaged.created`** - +
access_code.unmanaged.created An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was created on a device.
@@ -1468,10 +1359,9 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
---- - -**`access_code.unmanaged.removed`** - +
access_code.unmanaged.removed An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) was removed from a device.
@@ -1525,48 +1415,51 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l
---- +
## Endpoints + + -[**`/access_codes/create`**](./create.md) - -Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + -[**`/access_codes/create_multiple`**](./create_multiple.md) -Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. + + -[**`/access_codes/delete`**](./delete.md) -Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + -[**`/access_codes/get`**](./get.md) -Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + -[**`/access_codes/list`**](./list.md) -Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + -[**`/access_codes/pull_backup_access_code`**](./pull_backup_access_code.md) -Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes). + + -[**`/access_codes/update`**](./update.md) -Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + -[**`/access_codes/update_multiple`**](./update_multiple.md) -Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices. + + +
EndpointDescription
/access_codes/createCreates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
/access_codes/create_multipleCreates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
/access_codes/deleteDeletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
/access_codes/getReturns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
/access_codes/listReturns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
/access_codes/pull_backup_access_codeRetrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).
/access_codes/updateUpdates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
/access_codes/update_multipleUpdates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.
diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index a95207791..f4bd59dda 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -29,114 +29,82 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the device for which to create the new access code. - ----
allow_external_modification Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. - ----
attempt_for_offline_device Boolean - ----
code String Code to be used for access. - ----
common_code_key String Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md). - ----
ends_at String Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - ----
is_external_modification_allowed Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. - ----
is_offline_access_code Boolean Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). - ----
is_one_time_use Boolean Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. - ----
max_time_rounding String Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. - ----
name String Name of the new access code. - ----
prefer_native_scheduling Boolean Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. - ----
preferred_code_length Number Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. - ----
starts_at String Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ----
use_backup_access_code_pool Boolean Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). - ----
use_offline_access_code Boolean - ----
diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 266c034ce..8f77bd13f 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -37,114 +37,82 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_ids Array of UUIDs (Required) IDs of the devices for which to create the new access codes. - ----
allow_external_modification Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. - ----
attempt_for_offline_device Boolean - ----
behavior_when_code_cannot_be_shared String Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. - ----
code String Code to be used for access. - ----
ends_at String Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - ----
is_external_modification_allowed Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. - ----
is_offline_access_code Boolean Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). - ----
is_one_time_use Boolean Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. - ----
max_time_rounding String Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. - ----
name String Name of the new access code. - ----
prefer_native_scheduling Boolean Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. - ----
preferred_code_length Number Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. - ----
starts_at String Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ----
use_backup_access_code_pool Boolean Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). - ----
use_offline_access_code Boolean - ----
diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index e8e4fba3e..838752de7 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -29,20 +29,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_code_id String (Required) ID of the access code to delete. - ----
device_id String ID of the device for which to delete the access code. - ----
diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index d86cc9d14..84a133635 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -29,27 +29,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_code_id String ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. - ----
code String Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. - ----
device_id String ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. - ----
diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 147b0cab0..1bfca58c1 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -31,27 +31,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_code_ids Array of UUIDs IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. - ----
device_id String ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. - ----
user_identifier_key String Your user ID for the user by which to filter access codes. - ----
diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 0bbcca67d..6d019d1de 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -37,13 +37,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_code_id String (Required) ID of the access code for which you want to pull a backup access code. - ----
diff --git a/docs/api/access_codes/simulate/README.md b/docs/api/access_codes/simulate/README.md index 02bd1d359..5846ebac4 100644 --- a/docs/api/access_codes/simulate/README.md +++ b/docs/api/access_codes/simulate/README.md @@ -1,10 +1,14 @@ # Access Code Simulations -## Endpoints +
+## Endpoints -[**`/access_codes/simulate/create_unmanaged_access_code`**](./create_unmanaged_access_code.md) + + -Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + +
EndpointDescription
/access_codes/simulate/create_unmanaged_access_codeSimulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces).
diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index 98665dfb9..26faf96c9 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -29,27 +29,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
code String (Required) Code of the simulated unmanaged access code. - ----
device_id String (Required) ID of the device for which you want to simulate the creation of an unmanaged access code. - ----
name String (Required) Name of the simulated unmanaged access code. - ----
diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 382da1843..4a576cd1d 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -140,341 +140,249 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Errors -**`smartthings_failed_to_set_access_code`** - -Failed to set code on SmartThings device. - ---- - -**`smartthings_failed_to_set_after_multiple_retries`** - -Failed to set code after multiple retries. - ---- - -**`smartthings_no_free_slots_available`** - -No free slots available on the device. - ---- - -**`failed_to_set_on_device`** - -Failed to set code on device. - ---- - -**`failed_to_remove_from_device`** - -Failed to remove code from device. - ---- - -**`duplicate_code_on_device`** - -Duplicate access code detected on device. - ---- - -**`duplicate_code_attempt_prevented`** - -An attempt to modify this access code was prevented. - ---- - -**`igloohome_bridge_too_many_pending_jobs`** - -Igloohome bridge has too many pending jobs in the queue. - ---- - -**`igloohome_bridge_offline`** - -Igloohome bridge is offline. - ---- - -**`igloohome_offline_access_code_no_variance_available`** - -Lock has reached maximum amount of codes. - ---- - -**`kwikset_unable_to_confirm_code`** - -Unable to confirm that the access code is set on Kwikset device. - ---- - -**`kwikset_unable_to_confirm_deletion`** - -Unable to confirm the deletion of the access code on Kwikset device. - ---- - -**`code_modified_external_to_seam`** - -Code was modified or removed externally after Seam successfully set it on the device. - ---- - -**`august_lock_invalid_code_length`** - -Invalid code length for August lock. - ---- - -**`august_device_programming_delay`** - -Access code has not yet been fully moved to the device. - ---- - -**`august_device_slots_full`** - -All access code slots on the device are full. - ---- - -**`august_lock_missing_keypad`** - -August lock is missing a keypad. - ---- - -**`august_lock_temporarily_offline`** - -August lock is temporarily offline. - ---- - -**`salto_ks_user_not_subscribed`** - -Salto site user is not subscribed. - ---- - -**`hubitat_device_programming_delay`** - -Access code has not yet been fully moved to the device. - ---- - -**`hubitat_no_free_positions_available`** - -No free positions available on the device. - ---- - -**`wyze_duplicate_code_name`** - -Duplicate access code name detected. - ---- - -**`wyze_potential_duplicate_code`** - -Potential duplicate access code detected. - ---- - -**`dormakaba_oracode_no_valid_user_level`** - -No valid user level for Oracode. - ---- - -**`account_disconnected`** - -Account is disconnected - ---- - -**`salto_ks_subscription_limit_exceeded`** - -Salto site user limit reached. - ---- - -**`device_offline`** + + + -Device is offline + + + ---- + + + -**`device_removed`** + + + -Device has been removed + + + ---- + + + -**`hub_disconnected`** + + + -Hub is disconnected + + + ---- + + + -**`device_disconnected`** + + + -Device is disconnected + + + ---- + + + -**`empty_backup_access_code_pool`** + + + -The backup access code pool is empty. + + + ---- + + + -**`august_lock_not_authorized`** + + + -User is not authorized to use the August Lock. + + + ---- + + + -**`august_lock_missing_bridge`** + + + -Lock is not connected to the Seam Bridge. + + + ---- + + + -**`ttlock_lock_not_paired_to_gateway`** + + + -Lock is not paired with a Gateway. + + + ---- + + + -**`missing_device_credentials`** + + + -Missing device credentials. + + + ---- + + + -**`auxiliary_heat_running`** + + + -The auxiliary heat is running. + + + ---- + + + -**`subscription_required`** + + + -Subscription required to connect. + + + ---- + + + -**`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). + + + ---- + + + + + +
ErrorDescription
smartthings_failed_to_set_access_codeFailed to set code on SmartThings device.
smartthings_failed_to_set_after_multiple_retriesFailed to set code after multiple retries.
smartthings_no_free_slots_availableNo free slots available on the device.
failed_to_set_on_deviceFailed to set code on device.
failed_to_remove_from_deviceFailed to remove code from device.
duplicate_code_on_deviceDuplicate access code detected on device.
duplicate_code_attempt_preventedAn attempt to modify this access code was prevented.
igloohome_bridge_too_many_pending_jobsIgloohome bridge has too many pending jobs in the queue.
igloohome_bridge_offlineIgloohome bridge is offline.
igloohome_offline_access_code_no_variance_availableLock has reached maximum amount of codes.
kwikset_unable_to_confirm_codeUnable to confirm that the access code is set on Kwikset device.
kwikset_unable_to_confirm_deletionUnable to confirm the deletion of the access code on Kwikset device.
code_modified_external_to_seamCode was modified or removed externally after Seam successfully set it on the device.
august_lock_invalid_code_lengthInvalid code length for August lock.
august_device_programming_delayAccess code has not yet been fully moved to the device.
august_device_slots_fullAll access code slots on the device are full.
august_lock_missing_keypadAugust lock is missing a keypad.
august_lock_temporarily_offlineAugust lock is temporarily offline.
salto_ks_user_not_subscribedSalto site user is not subscribed.
hubitat_device_programming_delayAccess code has not yet been fully moved to the device.
hubitat_no_free_positions_availableNo free positions available on the device.
wyze_duplicate_code_nameDuplicate access code name detected.
wyze_potential_duplicate_codePotential duplicate access code detected.
dormakaba_oracode_no_valid_user_levelNo valid user level for Oracode.
account_disconnectedAccount is disconnected
salto_ks_subscription_limit_exceededSalto site user limit reached.
device_offlineDevice is offline
device_removedDevice has been removed
hub_disconnectedHub is disconnected
device_disconnectedDevice is disconnected
empty_backup_access_code_poolThe backup access code pool is empty.
august_lock_not_authorizedUser is not authorized to use the August Lock.
august_lock_missing_bridgeLock is not connected to the Seam Bridge.
ttlock_lock_not_paired_to_gatewayLock is not paired with a Gateway.
missing_device_credentialsMissing device credentials.
auxiliary_heat_runningThe auxiliary heat is running.
subscription_requiredSubscription required to connect.
invalid_credentialsCredentials provided were invalid.
bridge_disconnectedIndicates 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).
## Warnings -**`smartthings_failed_to_set_access_code`** - -Failed to set code on SmartThings device. - ---- - -**`schlage_detected_duplicate`** - -Duplicate access code detected. - ---- - -**`schlage_creation_outage`** - -Received an error when attempting to create this code. - ---- - -**`code_modified_external_to_seam`** - -Code was modified or removed externally after Seam successfully set it on the device. - ---- - -**`delay_in_setting_on_device`** - -Delay in setting code on device. - ---- - -**`delay_in_removing_from_device`** - -Delay in removing code from device. - ---- - -**`third_party_integration_detected`** - -Third-party integration detected that may cause access codes to fail. - ---- - -**`august_device_programming_delay`** - -Access code has not yet been fully moved to the device. - ---- + + + -**`august_lock_temporarily_offline`** + + + -August lock is temporarily offline. + + + ---- + + + -**`igloo_algopin_must_be_used_within_24_hours`** + + + -Algopins must be used within 24 hours. + + + ---- + + + -**`management_transferred`** + + + -Management was transferred to another workspace. + + + ---- + + + -**`kwikset_unable_to_confirm_code`** + + + -Unable to confirm that the access code is set on Kwikset device. + + + ---- + + +
WarningDescription
smartthings_failed_to_set_access_codeFailed to set code on SmartThings device.
schlage_detected_duplicateDuplicate access code detected.
schlage_creation_outageReceived an error when attempting to create this code.
code_modified_external_to_seamCode was modified or removed externally after Seam successfully set it on the device.
delay_in_setting_on_deviceDelay in setting code on device.
delay_in_removing_from_deviceDelay in removing code from device.
third_party_integration_detectedThird-party integration detected that may cause access codes to fail.
august_device_programming_delayAccess code has not yet been fully moved to the device.
august_lock_temporarily_offlineAugust lock is temporarily offline.
igloo_algopin_must_be_used_within_24_hoursAlgopins must be used within 24 hours.
management_transferredManagement was transferred to another workspace.
kwikset_unable_to_confirm_codeUnable to confirm that the access code is set on Kwikset device.
+
## Endpoints + + -[**`/access_codes/unmanaged/convert_to_managed`**](./convert_to_managed.md) - -Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). + + -[**`/access_codes/unmanaged/delete`**](./delete.md) -Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + + -[**`/access_codes/unmanaged/get`**](./get.md) -Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + + -[**`/access_codes/unmanaged/list`**](./list.md) -Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + + -[**`/access_codes/unmanaged/update`**](./update.md) -Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes). + + +
EndpointDescription
/access_codes/unmanaged/convert_to_managedConverts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
/access_codes/unmanaged/deleteDeletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
/access_codes/unmanaged/getReturns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
/access_codes/unmanaged/listReturns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
/access_codes/unmanaged/updateUpdates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index f5c56be08..645f85352 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -33,34 +33,26 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_code_id String (Required) ID of the unmanaged access code that you want to convert to a managed access code. - ----
allow_external_modification Boolean Indicates whether external modification of the access code is allowed. - ----
force Boolean Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. - ----
is_external_modification_allowed Boolean Indicates whether external modification of the access code is allowed. - ----
diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index af70775af..00e8b61e0 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -29,13 +29,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_code_id String (Required) ID of the unmanaged access code to delete. - ----
diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index 01377e635..fa000d52b 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -31,27 +31,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_code_id String ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. - ----
code String Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. - ----
device_id String ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. - ----
diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index 152a278c8..c3f7cd7f5 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -29,20 +29,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the device for which you want to list unmanaged access codes. - ----
user_identifier_key String Your user ID for the user by which to filter unmanaged access codes. - ----
diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index acf9a7436..cad036f50 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -29,39 +29,29 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_code_id String (Required) ID of the unmanaged access code that you want to update. - ----
is_managed Boolean (Required) - ----
allow_external_modification Boolean Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. - ----
force Boolean Indicates whether to force the unmanaged access code update. - ----
is_external_modification_allowed Boolean Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. - ----
diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index 28864d11d..4d235304e 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -31,128 +31,92 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_code_id String (Required) ID of the access code that you want to update. - ----
allow_external_modification Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. - ----
attempt_for_offline_device Boolean - ----
code String Code to be used for access. - ----
device_id String ID of the device containing the access code that you want to update. - ----
ends_at String Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - ----
is_external_modification_allowed Boolean Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. - ----
is_managed Boolean Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`. - ----
is_offline_access_code Boolean Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). - ----
is_one_time_use Boolean Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. - ----
max_time_rounding String Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. - ----
name String Name of the new access code. - ----
prefer_native_scheduling Boolean Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. - ----
preferred_code_length Number Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. - ----
starts_at String Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ----
type String Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access). - ----
use_backup_access_code_pool Boolean Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](../../api-clients/access_codes/pull_backup_access_code.md). - ----
use_offline_access_code Boolean - ----
diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index f0683bccc..bc038681f 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -33,34 +33,26 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
common_code_key String (Required) Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. - ----
ends_at String Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - ----
name String Name of the new access code. - ----
starts_at String Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ----
diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 6fadc0126..048c93191 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -177,8 +177,10 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events -**`acs_access_group.deleted`** - + + + + +
EventDescription
acs_access_group.deleted An ACS access group was deleted.
@@ -230,38 +232,41 @@ An ACS access group was deleted.
---- +
## Endpoints + + -[**`/acs/access_groups/add_user`**](./add_user.md) - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + -[**`/acs/access_groups/get`**](./get.md) -Returns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + -[**`/acs/access_groups/list`**](./list.md) -Returns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + -[**`/acs/access_groups/list_accessible_entrances`**](./list_accessible_entrances.md) -Returns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + -[**`/acs/access_groups/list_users`**](./list_users.md) -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + -[**`/acs/access_groups/remove_user`**](./remove_user.md) -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + +
EndpointDescription
/acs/access_groups/add_userAdds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
/acs/access_groups/getReturns a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
/acs/access_groups/listReturns a list of all [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
/acs/access_groups/list_accessible_entrancesReturns a list of all accessible entrances for a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
/acs/access_groups/list_usersReturns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
/acs/access_groups/remove_userRemoves a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 093ff90bc..971da82d9 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_access_group_id String (Required) ID of the desired access group. - ----
acs_user_id String (Required) ID of the desired user. - ----
diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index f5ad21cd8..cd19d2703 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_access_group_id String (Required) ID of the desired access group. - ----
diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index bbdc21a82..ea3b44df4 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_system_id String ID of the access control system for which you want to retrieve all access groups. - ----
acs_user_id String ID of the user for which you want to retrieve all access groups. - ----
diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index d93abf3b4..771cc37af 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_access_group_id String (Required) ID of the access group for which you want to retrieve all accessible entrances. - ----
diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 785663696..4e8bc1457 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_access_group_id String (Required) ID of the access group for which you want to retrieve all users. - ----
diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index b4bd21d33..503f5ce4d 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_access_group_id String (Required) ID of the desired access group. - ----
acs_user_id String (Required) ID of the desired user. - ----
diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index be891e325..7581e7b5f 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -344,47 +344,40 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Warnings -**`waiting_to_be_issued`** - -Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued. - ---- - -**`schedule_externally_modified`** - -Indicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally. - ---- - -**`schedule_modified`** - -Indicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past. - ---- - -**`being_deleted`** - -Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted. - ---- + + + -**`unknown_issue_with_acs_credential`** + + + -An unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential. + + + ---- + + + -**`needs_to_be_reissued`** + + + -Access permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential. - ---- + + + + + +
WarningDescription
waiting_to_be_issuedIndicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.
schedule_externally_modifiedIndicates that the schedule of one of the [credential](../../../capability-guides/access-systems/managing-credentials.md)'s children was modified externally.
schedule_modifiedIndicates that the schedule of the [credential](../../../capability-guides/access-systems/managing-credentials.md) was modified to avoid creating a credential with a start date in the past.
being_deletedIndicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is being deleted.
unknown_issue_with_acs_credentialAn unknown issue occurred while syncing the state of the [credential](../../../capability-guides/access-systems/managing-credentials.md) with the provider. This issue may affect the proper functioning of the credential.
needs_to_be_reissuedAccess permissions for the [credential](../../../capability-guides/access-systems/managing-credentials.md) have changed. [Reissue](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md) (re-encode) the credential. This issue may affect the proper functioning of the credential.
## Events -**`acs_credential.deleted`** - + + + + + + + + + + +
EventDescription
acs_credential.deleted An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was deleted.
@@ -436,10 +429,9 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
---- - -**`acs_credential.issued`** - +
acs_credential.issued An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was issued.
@@ -491,10 +483,9 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
---- - -**`acs_credential.reissued`** - +
acs_credential.reissued An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was reissued.
@@ -546,10 +537,9 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
---- - -**`acs_credential.invalidated`** - +
acs_credential.invalidated An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was invalidated.
@@ -601,48 +591,51 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia
---- +
## Endpoints + + -[**`/acs/credentials/assign`**](./assign.md) - -Assigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + -[**`/acs/credentials/create`**](./create.md) -Creates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + -[**`/acs/credentials/delete`**](./delete.md) -Deletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + + -[**`/acs/credentials/get`**](./get.md) -Returns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + + -[**`/acs/credentials/list`**](./list.md) -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md). + + -[**`/acs/credentials/list_accessible_entrances`**](./list_accessible_entrances.md) -Returns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access. + + -[**`/acs/credentials/unassign`**](./unassign.md) -Unassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + -[**`/acs/credentials/update`**](./update.md) -Updates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md). + + +
EndpointDescription
/acs/credentials/assignAssigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
/acs/credentials/createCreates a new [credential](../../../capability-guides/access-systems/managing-credentials.md) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
/acs/credentials/deleteDeletes a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
/acs/credentials/getReturns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
/acs/credentials/listReturns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md).
/acs/credentials/list_accessible_entrancesReturns a list of all [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a [credential](https://docs.seam.co/latest/api/acs/credentials) grants access.
/acs/credentials/unassignUnassigns a specified [credential](../../../capability-guides/access-systems/managing-credentials.md) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
/acs/credentials/updateUpdates the code and ends at date and time for a specified [credential](../../../capability-guides/access-systems/managing-credentials.md).
diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index fbb4b7a1f..665d97a02 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_credential_id String (Required) ID of the desired credential. - ----
acs_user_id String (Required) ID of the desired user. - ----
diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index aeb50ff0a..29560d6e9 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -28,83 +28,61 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
access_method String (Required) Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. - ----
acs_user_id String (Required) ID of the ACS user to whom the new credential belongs. - ----
allowed_acs_entrance_ids Array of UUIDs Set of IDs of the [entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md) for which the new credential grants access. - ----
assa_abloy_vostio_metadata Object Vostio-specific metadata for the new credential. - ----
code String Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md). - ----
credential_manager_acs_system_id String ACS system ID of the credential manager for the new credential. - ----
ends_at String Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. - ----
is_multi_phone_sync_credential Boolean Indicates whether the new credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). - ----
salto_space_metadata Object Salto Space-specific metadata for the new credential. - ----
starts_at String Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ----
visionline_metadata Object Visionline-specific metadata for the new credential. - ----
diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 2313bd0b3..2b5d064ad 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_credential_id String (Required) ID of the desired credential. - ----
diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 49148186e..c497b99c1 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_credential_id String (Required) ID of the desired credential. - ----
diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 51cd17eec..bc1cc2d0e 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -29,48 +29,36 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_system_id String ID of the access control system for which you want to retrieve all credentials. - ----
acs_user_id String ID of the ACS user for which you want to retrieve all credentials. - ----
created_before String Date and time, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format, before which events to return were created. - ----
is_multi_phone_sync_credential Boolean Indicates whether you want to retrieve only multi-phone sync credentials or non-multi-phone sync credentials. - ----
limit Number Number of credentials to return. - ----
user_identity_id String ID of the user identity for which you want to retrieve all credentials. - ----
diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index 3007639e4..ab71d2913 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_credential_id String (Required) ID of the credential for which you want to retrieve all entrances to which this credential grants access. - ----
diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 0db59beee..92920b808 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_credential_id String (Required) ID of the desired credential. - ----
acs_user_id String (Required) ID of the desired user. - ----
diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 02f1b88f9..4bc574bc5 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -28,27 +28,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_credential_id String (Required) ID of the desired credential. - ----
code String Replacement access (PIN) code for the credential. - ----
ends_at String Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. - ----
diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index a260a17a4..fdad52be3 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -114,8 +114,10 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events -**`acs_encoder.added`** - + + + + + + +
EventDescription
acs_encoder.added An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was added.
@@ -169,10 +171,9 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
---- - -**`acs_encoder.removed`** - +
acs_encoder.removed An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was removed.
@@ -226,23 +227,26 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc
---- +
## Endpoints + + -[**`/acs/encoders/encode_credential`**](./encode_credential.md) - -Encodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + + -[**`/acs/encoders/list`**](./list.md) -Returns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + + -[**`/acs/encoders/scan_credential`**](./scan_credential.md) -Scans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md). + + +
EndpointDescription
/acs/encoders/encode_credentialEncodes an existing [credential](../../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
/acs/encoders/listReturns a list of all [encoders](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
/acs/encoders/scan_credentialScans an encoded [acs_credential](../../../capability-guides/access-systems/managing-credentials.md) from a plastic card placed on the specified [encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index 9569796de..b80b1891e 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_credential_id String (Required) ID of the `acs_credential` to encode onto a card. - ----
acs_encoder_id String (Required) ID of the `acs_encoder` to use to encode the `acs_credential`. - ----
diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 9655d6a37..5dddfad6d 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -28,34 +28,26 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_encoder_ids Array of UUIDs IDs of the `acs_encoder`s that you want to retrieve. - ----
acs_system_id String ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. - ----
acs_system_ids Array of UUIDs IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. - ----
limit Number Number of `acs_encoders` to return. - ----
diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 57e143f4a..9690ff317 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_encoder_id String (Required) ID of the `acs_encoder` to use for the scan. - ----
diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index 91ad7fa2c..be1516d8a 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -1,25 +1,29 @@ # Encoder Simulations -## Endpoints +
+## Endpoints -[**`/acs/encoders/simulate/next_credential_encode_will_fail`**](./next_credential_encode_will_fail.md) + + -Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + -[**`/acs/encoders/simulate/next_credential_encode_will_succeed`**](./next_credential_encode_will_succeed.md) -Simulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + -[**`/acs/encoders/simulate/next_credential_scan_will_fail`**](./next_credential_scan_will_fail.md) -Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + -[**`/acs/encoders/simulate/next_credential_scan_will_succeed`**](./next_credential_scan_will_succeed.md) -Simulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces). + + +
EndpointDescription
/acs/encoders/simulate/next_credential_encode_will_failSimulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
/acs/encoders/simulate/next_credential_encode_will_succeedSimulates that the next attempt to encode a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
/acs/encoders/simulate/next_credential_scan_will_failSimulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will fail. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
/acs/encoders/simulate/next_credential_scan_will_succeedSimulates that the next attempt to scan a [credential](../../../../capability-guides/access-systems/managing-credentials.md) using the specified [encoder](../../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) will succeed. You can only perform this action within a [sandbox workspace](../../../../core-concepts/workspaces/README.md#sandbox-workspaces).
diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 04fa508bd..0e4753b1e 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -28,27 +28,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_encoder_id String (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. - ----
acs_credential_id String ID of the `acs_credential` that will fail to be encoded onto a card in the next request. - ----
error_code String Code of the error to simulate. - ----
diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index 2dbe1e6dd..a5ad52dcc 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_encoder_id String (Required) ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. - ----
scenario String Scenario to simulate. - ----
diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index c6f4bcb63..bbd68768e 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -28,23 +28,17 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_encoder_id String (Required) ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. - ----
acs_credential_id_on_seam String - ----
error_code String - ----
diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 867ae9aea..98452ee25 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -28,27 +28,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_encoder_id String (Required) ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. - ----
acs_credential_id_on_seam String ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. - ----
scenario String Scenario to simulate. - ----
diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 02ced06da..42f43088d 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -304,8 +304,10 @@ Visionline-specific metadata associated with the [entrance](../../../capability- ## Events -**`acs_entrance.added`** - + + + + + + +
EventDescription
acs_entrance.added An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.
@@ -357,10 +359,9 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
---- - -**`acs_entrance.removed`** - +
acs_entrance.removed An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.
@@ -412,28 +413,31 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra
---- +
## Endpoints + + -[**`/acs/entrances/get`**](./get.md) - -Returns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). - + -[**`/acs/entrances/grant_access`**](./grant_access.md) + + + -[**`/acs/entrances/list`**](./list.md) -Returns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). + + -[**`/acs/entrances/list_credentials_with_access`**](./list_credentials_with_access.md) -Returns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). + + +
EndpointDescription
/acs/entrances/getReturns a specified [ACS entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
/acs/entrances/grant_access
/acs/entrances/listReturns a list of all [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
/acs/entrances/list_credentials_with_accessReturns a list of all [credentials](../../../capability-guides/access-systems/managing-credentials.md) with access to a specified [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md).
diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index c836260da..3be23bcd4 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -27,11 +27,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_entrance_id String (Required) - ----
diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index c364b134e..be5e9e32c 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -28,16 +28,12 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_entrance_id String (Required) - ----
acs_user_id String (Required) - ----
diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 83c98b222..5e7ba5426 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -29,16 +29,12 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_credential_id String - ----
acs_system_id String - ----
diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 81083d589..5534b7e7d 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -29,11 +29,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_entrance_id String (Required) - ----
include_if Array of Enums @@ -44,8 +42,6 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati Possible enum values: - `visionline_metadata.is_valid` - ----
diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 3aec3210b..542159d87 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -298,73 +298,63 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Errors -**`seam_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. + + + -**`visionline_instance_unreachable`** + + + -Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). + + + ---- - -**`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. + + + ---- - -**`acs_system_disconnected`** + + + -Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue. - ---- - -**`account_disconnected`** - -Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access. - ---- - -**`salto_ks_certification_expired`** - -Indicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access. - ---- + + + + + +
ErrorDescription
seam_bridge_disconnectedIndicates 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. This error might also occur if Seam Bridge is connected to the wrong [workspace](../../../core-concepts/workspaces/README.md). - See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected). - ---- - -**`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). - ---- + See also [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md#acs_system.errors.seam_bridge_disconnected).
bridge_disconnectedIndicates 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).
visionline_instance_unreachableIndicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system). For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](../../../core-concepts/workspaces/README.md). - See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable). + See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).
salto_ks_subscription_limit_exceededIndicates 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.
acs_system_disconnectedIndicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has been disconnected. See [Troubleshooting Your Access Control System](../../../capability-guides/access-systems/troubleshooting-your-access-control-system.md) to resolve the issue.
account_disconnectedIndicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.
salto_ks_certification_expiredIndicates that the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) has lost its Salto KS certification. Contact [support](mailto:support@seam.co) to regain access.
## Warnings -**`salto_ks_subscription_limit_almost_reached`** - -Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue. - ---- - -**`time_zone_does_not_match_location`** + + + -Indicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md). - ---- + + + + + +
WarningDescription
salto_ks_subscription_limit_almost_reachedIndicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.
time_zone_does_not_match_locationIndicates the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) time zone could not be determined because the reported physical location does not match the time zone configured on the physical [ACS entrances](../../../capability-guides/access-systems/retrieving-entrance-details.md).
## Events -**`acs_system.connected`** - + + + + + + + + +
EventDescription
acs_system.connected An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected.
@@ -412,10 +402,9 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
---- - -**`acs_system.added`** - +
acs_system.added An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was added.
@@ -463,10 +452,9 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
---- - -**`acs_system.disconnected`** - +
acs_system.disconnected An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was disconnected.
@@ -514,23 +502,26 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa
---- +
## Endpoints + + -[**`/acs/systems/get`**](./get.md) - -Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + + -[**`/acs/systems/list`**](./list.md) -Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems). + + -[**`/acs/systems/list_compatible_credential_manager_acs_systems`**](./list_compatible_credential_manager_acs_systems.md) -Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems). + + +
EndpointDescription
/acs/systems/getReturns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
/acs/systems/listReturns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).
/acs/systems/list_compatible_credential_manager_acs_systemsReturns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index c59fc6085..c1498277a 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -30,13 +30,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_system_id String (Required) ID of the desired access control system. - ----
diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index 5279e8257..f7a72b7cb 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -31,13 +31,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
connected_account_id String ID of the connected account by which to filter the list of returned access control systems. - ----
diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index f9816b7ee..9d2b6cc92 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -30,13 +30,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_system_id String (Required) ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. - ----
diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index e80b76b64..a91547cfb 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -230,62 +230,54 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Errors -**`deleted_externally`** - -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam. - ---- - -**`salto_ks_subscription_limit_exceeded`** - -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded. - ---- - -**`failed_to_create_on_acs_system`** - -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). - ---- + + + -**`failed_to_update_on_acs_system`** + + + -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). + + + ---- + + + -**`failed_to_delete_on_acs_system`** - -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co). - ---- + + + + + +
ErrorDescription
deleted_externallyIndicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.
salto_ks_subscription_limit_exceededIndicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) could not be subscribed on Salto KS because the subscription limit has been exceeded.
failed_to_create_on_acs_systemIndicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not created on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
failed_to_update_on_acs_systemIndicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not updated on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
failed_to_delete_on_acs_systemIndicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was not deleted on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
## Warnings -**`being_deleted`** - -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly. - ---- - -**`salto_ks_user_not_subscribed`** - -Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed. - ---- - -**`unknown_issue_with_acs_user`** + + + -An unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user. + + + ---- + + + + + +
WarningDescription
being_deletedIndicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.
salto_ks_user_not_subscribedIndicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is not subscribed on Salto KS, so they cannot unlock doors or perform any actions. This occurs when the their access schedule hasn’t started yet, if their access schedule has ended, if the site has reached its limit for active users (subscription slots), or if they have been manually unsubscribed.
unknown_issue_with_acs_userAn unknown issue occurred while syncing the state of this [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) with the provider. This issue may affect the proper functioning of this user.
## Events -**`acs_user.deleted`** - + + + + +
EventDescription
acs_user.deleted An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted.
@@ -337,63 +329,66 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-
---- +
## Endpoints + + -[**`/acs/users/add_to_access_group`**](./add_to_access_group.md) - -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + -[**`/acs/users/create`**](./create.md) -Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + -[**`/acs/users/delete`**](./delete.md) -Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md). + + -[**`/acs/users/get`**](./get.md) -Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + -[**`/acs/users/list`**](./list.md) -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + -[**`/acs/users/list_accessible_entrances`**](./list_accessible_entrances.md) -Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access. + + -[**`/acs/users/remove_from_access_group`**](./remove_from_access_group.md) -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). + + -[**`/acs/users/revoke_access_to_all_entrances`**](./revoke_access_to_all_entrances.md) -Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + -[**`/acs/users/suspend`**](./suspend.md) -[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them. + + -[**`/acs/users/unsuspend`**](./unsuspend.md) -[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access. + + -[**`/acs/users/update`**](./update.md) -Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). + + +
EndpointDescription
/acs/users/add_to_access_groupAdds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
/acs/users/createCreates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
/acs/users/deleteDeletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](../../../capability-guides/access-systems/managing-credentials.md).
/acs/users/getReturns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
/acs/users/listReturns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
/acs/users/list_accessible_entrancesLists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.
/acs/users/remove_from_access_groupRemoves a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).
/acs/users/revoke_access_to_all_entrancesRevokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
/acs/users/suspend[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.
/acs/users/unsuspend[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.
/acs/users/updateUpdates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).
diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 4691d02dc..c805cac9e 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_access_group_id String (Required) ID of the desired access group. - ----
acs_user_id String (Required) ID of the desired `acs_user`. - ----
diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 795008f35..6875b8c40 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -28,60 +28,44 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_system_id String (Required) ID of the `acs_system` to which to add the new `acs_user`. - ----
full_name String (Required) Full name of the new `acs_user`. - ----
access_schedule Object `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. - ----
acs_access_group_ids Array of UUIDs Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. - ----
email String - ----
email_address String Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ----
phone_number String Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). - ----
user_identity_id String ID of the user identity with which to associate the new `acs_user`. - ----
diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 0050c138b..64e659ad5 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_user_id String (Required) ID of the desired `acs_user`. - ----
diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 4df2bbfa0..aaf8206ae 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_user_id String (Required) ID of the desired `acs_user`. - ----
diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index ef8cc356b..8be157a39 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -29,60 +29,44 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_system_id String ID of the `acs_system` for which you want to retrieve all `acs_user`s. - ----
created_before String - ----
limit Number Maximum number of records to return per page. - ----
page_cursor String Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. - ----
search String String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. - ----
user_identity_email_address String Email address of the user identity for which you want to retrieve all `acs_user`s. - ----
user_identity_id String ID of the user identity for which you want to retrieve all `acs_user`s. - ----
user_identity_phone_number String Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). - ----
diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index c08470358..46bb1c53d 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -29,13 +29,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_user_id String (Required) ID of the desired `acs_user`. - ----
diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index c41555af9..971f463e8 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_access_group_id String (Required) ID of the desired access group. - ----
acs_user_id String (Required) ID of the desired `acs_user`. - ----
diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index eceef223a..45f1e5141 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_user_id String (Required) ID of the desired `acs_user`. - ----
diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index e1a2685d5..0761b10ae 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_user_id String (Required) ID of the desired `acs_user`. - ----
diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 4c9fd2299..9d82642f3 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_user_id String (Required) ID of the desired `acs_user`. - ----
diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index b1c2b0112..cbd78ffce 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -28,51 +28,37 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_user_id String (Required) ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ----
access_schedule Object `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. - ----
email String - ----
email_address String Email address of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ----
full_name String Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - ----
hid_acs_system_id String - ----
phone_number String Phone number of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in E.164 format (for example, `+15555550100`). - ----
diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index edf70d33a..c687ff09f 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -191,8 +191,10 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th ## Events -**`phone.deactivated`** - + + + + +
EventDescription
phone.deactivated A phone device was deactivated.
@@ -234,23 +236,26 @@ A phone device was deactivated.
---- +
## Endpoints + + -[**`/phones/deactivate`**](./deactivate.md) - -Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process). + + -[**`/phones/get`**](./get.md) -Returns a single phone entry matching the provided `device_id`. + + -[**`/phones/list`**](./list.md) -Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body. + + +
EndpointDescription
/phones/deactivateDeactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md#app-user-lost-phone-process).
/phones/getReturns a single phone entry matching the provided `device_id`.
/phones/listReturns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 0ff894733..a0c608fa7 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -29,13 +29,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) Device ID of the desired phone. - ----
diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 981920757..f755887c7 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) Device ID of the desired phone. - ----
diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 9fc9b03f3..8ef2d1878 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_credential_id String ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones. - ----
owner_user_identity_id String ID of the user identity that represents the owner by which to filter the list of returned phones. - ----
diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index f40205492..cbac1cf3e 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -1,10 +1,14 @@ # Phone Simulations -## Endpoints +
+## Endpoints -[**`/phones/simulate/create_sandbox_phone`**](./create_sandbox_phone.md) + + -Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity). + + +
EndpointDescription
/phones/simulate/create_sandbox_phoneCreates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity).
diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index ed7e17aa2..5562fdf50 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -28,34 +28,26 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
user_identity_id String (Required) ID of the user identity to associate with the simulated phone. - ----
assa_abloy_metadata Object ASSA ABLOY metadata to associate with the simulated phone. - ----
custom_sdk_installation_id String ID of the custom SDK installation to use for the simulated phone. - ----
phone_metadata Object Metadata to associate with the simulated phone. - ----
diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index ed509331e..19f2abadb 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -1,70 +1,74 @@ # Thermostats -## Endpoints +
+## Endpoints -[**`/thermostats/activate_climate_preset`**](./activate_climate_preset.md) + + -Activates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/cool`**](./cool.md) -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + + -[**`/thermostats/create_climate_preset`**](./create_climate_preset.md) -Creates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/delete_climate_preset`**](./delete_climate_preset.md) -Deletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/heat`**](./heat.md) -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + + -[**`/thermostats/heat_cool`**](./heat_cool.md) -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + + -[**`/thermostats/list`**](./list.md) -Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/off`**](./off.md) -Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings). + + -[**`/thermostats/set_fallback_climate_preset`**](./set_fallback_climate_preset.md) -Sets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/set_fan_mode`**](./set_fan_mode.md) -Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/set_hvac_mode`**](./set_hvac_mode.md) -Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/set_temperature_threshold`**](./set_temperature_threshold.md) -Sets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range. + + -[**`/thermostats/update_climate_preset`**](./update_climate_preset.md) -Updates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + +
EndpointDescription
/thermostats/activate_climate_presetActivates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/coolSets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
/thermostats/create_climate_presetCreates a [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/delete_climate_presetDeletes a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/heatSets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
/thermostats/heat_coolSets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
/thermostats/listReturns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/offSets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).
/thermostats/set_fallback_climate_presetSets a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) as the ["fallback"](../../capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset.md) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/set_fan_modeSets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/set_hvac_modeSets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/set_temperature_thresholdSets a [temperature threshold](../../capability-guides/thermostats/setting-and-monitoring-temperature-thresholds.md) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
/thermostats/update_climate_presetUpdates a specified [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 395b2a3f8..5501c757f 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
climate_preset_key String (Required) Climate preset key of the desired climate preset. - ----
device_id String (Required) ID of the desired thermostat device. - ----
diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 9d49740b8..64e2ca2a0 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -29,27 +29,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired thermostat device. - ----
cooling_set_point_celsius Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. - ----
cooling_set_point_fahrenheit Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. - ----
diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index dc18de359..d2c975a39 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -29,76 +29,56 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
climate_preset_key String (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). - ----
device_id String (Required) ID of the desired thermostat device. - ----
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 Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). - ----
fan_mode_setting String 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`. - ----
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 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 String Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - ----
manual_override_allowed Boolean Indicates whether a person at the thermostat or using the API can change the thermostat's settings. - ----
name String User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). - ----
diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index e152b10d1..dd61b8b75 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -29,20 +29,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
climate_preset_key String (Required) Climate preset key of the desired climate preset. - ----
device_id String (Required) ID of the desired thermostat device. - ----
diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index c10089cde..2590d0785 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -29,27 +29,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired thermostat device. - ----
heating_set_point_celsius Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. - ----
heating_set_point_fahrenheit Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. - ----
diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index d55eb3d73..6e913184b 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -29,41 +29,31 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired thermostat device. - ----
cooling_set_point_celsius Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. - ----
cooling_set_point_fahrenheit Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. - ----
heating_set_point_celsius Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. - ----
heating_set_point_fahrenheit Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. - ----
diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 2f11668c4..409dd1fb2 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -29,55 +29,41 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
connect_webview_id String ID of the Connect Webview by which to filter devices. - ----
connected_account_id String ID of the connected account by which to filter. - ----
connected_account_ids Array of UUIDs Array of IDs of the connected accounts by which to filter devices. - ----
created_before String Date threshold for devices to return. If specified, returns only devices created before the specified date. - ----
custom_metadata_has Object Set of key:value [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) pairs by which you want to filter devices. - ----
device_ids Array of UUIDs Array of device IDs by which to filter devices. - ----
device_type String Device type by which to filter devices. - ----
device_types Array of Enums @@ -94,29 +80,21 @@ Possible enum values: - `tado_thermostat` - `sensi_thermostat` - ----
limit Number Numerical limit on the number of devices to return. - ----
manufacturer String Manufacturer by which to filter devices. - ----
user_identifier_key String Your own internal user ID for the user by which to filter devices. - ----
diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 322c984f7..32aa90e12 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -29,13 +29,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired thermostat device. - ----
diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 6965783b5..4009d36bd 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -116,31 +116,35 @@ ID of the [thermostat schedule](../../../capability-guides/thermostats/creating-
-## Endpoints +
+## Endpoints -[**`/thermostats/schedules/create`**](./create.md) + + -Creates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/schedules/delete`**](./delete.md) -Deletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/schedules/get`**](./get.md) -Returns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + + -[**`/thermostats/schedules/list`**](./list.md) -Returns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). + + -[**`/thermostats/schedules/update`**](./update.md) -Updates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). + + +
EndpointDescription
/thermostats/schedules/createCreates a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/schedules/deleteDeletes a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/schedules/getReturns a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
/thermostats/schedules/listReturns a list of all [thermostat schedules](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).
/thermostats/schedules/updateUpdates a specified [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 3ba7a0b6e..17d79fa79 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -29,55 +29,41 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
climate_preset_key String (Required) Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. - ----
device_id String (Required) ID of the desired thermostat device. - ----
ends_at String (Required) Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ----
starts_at String (Required) Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ----
is_override_allowed Boolean Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). - ----
max_override_period_minutes Number Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). - ----
name String User-friendly name to identify the thermostat schedule. - ----
diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 3f0d200eb..3dec7d7d6 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -29,13 +29,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
thermostat_schedule_id String (Required) ID of the desired thermostat schedule. - ----
diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index cd9966cc2..8891bb0a2 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -29,13 +29,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
thermostat_schedule_id String (Required) ID of the desired thermostat schedule. - ----
diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index d9a5fbca1..fe76268b0 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -29,20 +29,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired thermostat device. - ----
user_identifier_key String User identifier key by which to filter the list of returned thermostat schedules. - ----
diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index fde6cebbd..db975a753 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -29,55 +29,41 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
thermostat_schedule_id String (Required) ID of the desired thermostat schedule. - ----
climate_preset_key String Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the thermostat schedule. - ----
ends_at String Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ----
is_override_allowed Boolean Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). - ----
max_override_period_minutes Number Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). - ----
name String User-friendly name to identify the thermostat schedule. - ----
starts_at String Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. - ----
diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index c0d34067a..2df23f34b 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
climate_preset_key String (Required) Climate preset key of the desired climate preset. - ----
device_id String (Required) ID of the desired thermostat device. - ----
diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 08fa53f41..7f8948d94 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -29,23 +29,17 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) - ----
fan_mode String - ----
fan_mode_setting String Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. - ----
diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 877138689..4cb380fad 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -29,46 +29,34 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired thermostat device. - ----
hvac_mode_setting String (Required) - ----
cooling_set_point_celsius Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters. - ----
cooling_set_point_fahrenheit Number Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters. - ----
heating_set_point_celsius Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters. - ----
heating_set_point_fahrenheit Number Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters. - ----
diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index ca00530b2..922bb1892 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -28,41 +28,31 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired thermostat device. - ----
lower_limit_celsius Number Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. - ----
lower_limit_fahrenheit Number Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. - ----
upper_limit_celsius Number Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. - ----
upper_limit_fahrenheit Number Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. - ----
diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index b05e76fe5..80d9488e2 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -1,15 +1,19 @@ # Thermostat Simulations -## Endpoints +
+## Endpoints -[**`/thermostats/simulate/hvac_mode_adjusted`**](./hvac_mode_adjusted.md) + + -Simulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). + + -[**`/thermostats/simulate/temperature_reached`**](./temperature_reached.md) -Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md). + + +
EndpointDescription
/thermostats/simulate/hvac_mode_adjustedSimulates having adjusted the [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
/thermostats/simulate/temperature_reachedSimulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](../../../capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints.md).
diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 808534d16..2e9e3c64c 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -28,48 +28,36 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired thermostat device. - ----
hvac_mode String (Required) Desired [HVAC mode](../../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) to simulate. - ----
cooling_set_point_celsius Number Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. - ----
cooling_set_point_fahrenheit Number Desired simulated cooling [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. - ----
heating_set_point_celsius Number Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. - ----
heating_set_point_fahrenheit Number Desired simulated heating [set point](../../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. - ----
diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index fc722dcdb..7f1c140c1 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -28,27 +28,21 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired thermostat device. - ----
temperature_celsius Number Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. - ----
temperature_fahrenheit Number Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. - ----
diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index cde1da86a..b8a71a72b 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -29,76 +29,56 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
climate_preset_key String (Required) Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). - ----
device_id String (Required) ID of the desired thermostat device. - ----
manual_override_allowed Boolean (Required) Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions). - ----
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 Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md). - ----
fan_mode_setting String 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`. - ----
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 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 String Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`. - ----
name String User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md). - ----
diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 1e677635e..46bd55a92 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -87,66 +87,70 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th
-## Endpoints - +
-[**`/user_identities/add_acs_user`**](./add_acs_user.md) +## Endpoints -Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + + -[**`/user_identities/create`**](./create.md) + -Creates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + -[**`/user_identities/delete`**](./delete.md) + -Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones. + -[**`/user_identities/get`**](./get.md) + -Returns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + -[**`/user_identities/grant_access_to_device`**](./grant_access_to_device.md) + -Grants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md). + -[**`/user_identities/list`**](./list.md) + -Returns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + -[**`/user_identities/list_accessible_devices`**](./list_accessible_devices.md) + -Returns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + -[**`/user_identities/list_acs_systems`**](./list_acs_systems.md) + -Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + -[**`/user_identities/list_acs_users`**](./list_acs_users.md) + -Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + -[**`/user_identities/remove_acs_user`**](./remove_acs_user.md) + -Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + -[**`/user_identities/revoke_access_to_device`**](./revoke_access_to_device.md) + -Revokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + -[**`/user_identities/update`**](./update.md) + + + +
EndpointDescription
/user_identities/add_acs_userAdds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
/user_identities/createCreates a new [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
/user_identities/deleteDeletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.
/user_identities/getReturns a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
/user_identities/grant_access_to_deviceGrants a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](../../core-concepts/devices/README.md).
/user_identities/listReturns a list of all [user identities](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
/user_identities/list_accessible_devicesReturns a list of all [devices](../../core-concepts/devices/README.md) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
/user_identities/list_acs_systemsReturns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems) associated with a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
/user_identities/list_acs_usersReturns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
/user_identities/remove_acs_userRemoves a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
/user_identities/revoke_access_to_deviceRevokes access to a specified [device](../../core-concepts/devices/README.md) from a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
/user_identities/update
diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 25001f64b..414d0c2c4 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_user_id String (Required) ID of the desired ACS user. - ----
user_identity_id String (Required) ID of the desired user identity. - ----
diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index ccc7479f2..baf62bb5d 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -28,34 +28,26 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
email_address String Unique email address for the user identity. - ----
full_name String Full name of the user associated with the user identity. - ----
phone_number String Unique phone number for the user identity in E.164 format (for example, +15555550100). - ----
user_identity_key String Unique key for the user identity. - ----
diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 10157e291..90d4d77f5 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
user_identity_id String (Required) ID of the desired user identity. - ----
diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 8356b54ec..cb362c94b 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -70,8 +70,10 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events -**`enrollment_automation.deleted`** - + + + + +
EventDescription
enrollment_automation.deleted An [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) was deleted.
@@ -113,28 +115,31 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi
---- +
## Endpoints + + -[**`/user_identities/enrollment_automations/delete`**](./delete.md) - -Deletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete). + + -[**`/user_identities/enrollment_automations/get`**](./get.md) -Returns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + + -[**`/user_identities/enrollment_automations/launch`**](./launch.md) -Sets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). + + -[**`/user_identities/enrollment_automations/list`**](./list.md) -Returns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). + + +
EndpointDescription
/user_identities/enrollment_automations/deleteDeletes a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system). You must delete all enrollment automations associated with a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) before [deleting the user identity](https://docs.seam.co/latest/api/user_identities/delete).
/user_identities/enrollment_automations/getReturns a specified [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
/user_identities/enrollment_automations/launchSets up a new [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) with a specified [credential manager](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system).
/user_identities/enrollment_automations/listReturns a list of all [enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) for a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index df00241d7..39193c711 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
enrollment_automation_id String (Required) ID of the desired enrollment automation. - ----
diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 419dd5035..6db78728d 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -29,13 +29,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
enrollment_automation_id String (Required) ID of the desired enrollment automation. - ----
diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index ff46d358d..fb6cbbb43 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -28,41 +28,31 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
credential_manager_acs_system_id String (Required) ID of the desired ACS system that serves as the credential manager. - ----
user_identity_id String (Required) ID of the desired user identity. - ----
acs_credential_pool_id String ID of the ACS credential pool from which to obtain credentials for the user identity. - ----
create_credential_manager_user Boolean Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. - ----
credential_manager_acs_user_id String ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. - ----
diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 248998a2c..15fc1630a 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -29,13 +29,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
user_identity_id String (Required) ID of the user identity for which you want to retrieve all enrollment automations. - ----
diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 757ea9ed8..0d6c6e946 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -28,18 +28,14 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
user_identity_id String ID of the desired user identity. - ----
user_identity_key String - ----
diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 1d490e166..318faf92b 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired managed device. - ----
user_identity_id String (Required) ID of the desired user identity. - ----
diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index 62322824d..d82bf428c 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -29,11 +29,9 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
credential_manager_acs_system_id String - ----
diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index 50876767e..b47f15542 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
user_identity_id String (Required) ID of the user identity for which you want to retrieve all accessible devices. - ----
diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index ef3f33070..d94c166ff 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -29,13 +29,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
user_identity_id String (Required) ID of the user identity for which you want to retrieve all access control systems. - ----
diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index a31533776..f4be67b25 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -28,13 +28,11 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
user_identity_id String (Required) ID of the user identity for which you want to retrieve all ACS users. - ----
diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index e87a53205..3262ca448 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
acs_user_id String (Required) ID of the ACS user. - ----
user_identity_id String (Required) ID of the desired user identity. - ----
diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 5b3cac5f8..1b6480442 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -28,20 +28,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
device_id String (Required) ID of the desired managed device. - ----
user_identity_id String (Required) ID of the desired user identity. - ----
diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 1632f2ad4..17e39f026 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -28,39 +28,29 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
PropertyDescription
ParameterDescription
user_identity_id String (Required) ID of the user identity. - ----
email_address String Unique email address for the user identity. - ----
full_name String - ----
phone_number String Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). - ----
user_identity_key String Unique key for the user identity. - ----
From ae6473207f5943c3fc809e0a2a6ec6a7556c6d76 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:18:22 -0400 Subject: [PATCH 225/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 6f2b6fc27..9e5bc0c35 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -40,7 +40,7 @@ {{/if}} - + {{#each properties}}
PropertyDescription
PropertyDescription
{{#if linkTarget}}{{name}}{{else}}{{name}}{{/if}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} From 73e23b7e0af970f10771eb79d892841f70c96b44 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:18:59 -0400 Subject: [PATCH 226/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 8fe57adce..61dae0848 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -34,7 +34,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati {{#if request.parameters.length}} - + {{#each request.parameters}}
ParameterDescription
ParameterDescription
{{this.name}} {{this.jsonType}}{{#if this.itemFormat}} of {{this.itemFormat}}s{{/if}}{{#if this.required}} (Required){{/if}} From 240ce3b7b1d855b49547146e77985811cf21ee00 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 04:19:56 +0000 Subject: [PATCH 227/233] ci: Generate docs --- docs/api/access_codes/README.md | 2 +- docs/api/access_codes/create.md | 2 +- docs/api/access_codes/create_multiple.md | 2 +- docs/api/access_codes/delete.md | 2 +- docs/api/access_codes/get.md | 2 +- docs/api/access_codes/list.md | 2 +- docs/api/access_codes/pull_backup_access_code.md | 2 +- docs/api/access_codes/simulate/create_unmanaged_access_code.md | 2 +- docs/api/access_codes/unmanaged/README.md | 2 +- docs/api/access_codes/unmanaged/convert_to_managed.md | 2 +- docs/api/access_codes/unmanaged/delete.md | 2 +- docs/api/access_codes/unmanaged/get.md | 2 +- docs/api/access_codes/unmanaged/list.md | 2 +- docs/api/access_codes/unmanaged/update.md | 2 +- docs/api/access_codes/update.md | 2 +- docs/api/access_codes/update_multiple.md | 2 +- docs/api/acs/access_groups/README.md | 2 +- docs/api/acs/access_groups/add_user.md | 2 +- docs/api/acs/access_groups/get.md | 2 +- docs/api/acs/access_groups/list.md | 2 +- docs/api/acs/access_groups/list_accessible_entrances.md | 2 +- docs/api/acs/access_groups/list_users.md | 2 +- docs/api/acs/access_groups/remove_user.md | 2 +- docs/api/acs/credentials/README.md | 2 +- docs/api/acs/credentials/assign.md | 2 +- docs/api/acs/credentials/create.md | 2 +- docs/api/acs/credentials/delete.md | 2 +- docs/api/acs/credentials/get.md | 2 +- docs/api/acs/credentials/list.md | 2 +- docs/api/acs/credentials/list_accessible_entrances.md | 2 +- docs/api/acs/credentials/unassign.md | 2 +- docs/api/acs/credentials/update.md | 2 +- docs/api/acs/encoders/README.md | 2 +- docs/api/acs/encoders/encode_credential.md | 2 +- docs/api/acs/encoders/list.md | 2 +- docs/api/acs/encoders/scan_credential.md | 2 +- .../acs/encoders/simulate/next_credential_encode_will_fail.md | 2 +- .../encoders/simulate/next_credential_encode_will_succeed.md | 2 +- .../api/acs/encoders/simulate/next_credential_scan_will_fail.md | 2 +- .../acs/encoders/simulate/next_credential_scan_will_succeed.md | 2 +- docs/api/acs/entrances/README.md | 2 +- docs/api/acs/entrances/get.md | 2 +- docs/api/acs/entrances/grant_access.md | 2 +- docs/api/acs/entrances/list.md | 2 +- docs/api/acs/entrances/list_credentials_with_access.md | 2 +- docs/api/acs/systems/README.md | 2 +- docs/api/acs/systems/get.md | 2 +- docs/api/acs/systems/list.md | 2 +- .../systems/list_compatible_credential_manager_acs_systems.md | 2 +- docs/api/acs/users/README.md | 2 +- docs/api/acs/users/add_to_access_group.md | 2 +- docs/api/acs/users/create.md | 2 +- docs/api/acs/users/delete.md | 2 +- docs/api/acs/users/get.md | 2 +- docs/api/acs/users/list.md | 2 +- docs/api/acs/users/list_accessible_entrances.md | 2 +- docs/api/acs/users/remove_from_access_group.md | 2 +- docs/api/acs/users/revoke_access_to_all_entrances.md | 2 +- docs/api/acs/users/suspend.md | 2 +- docs/api/acs/users/unsuspend.md | 2 +- docs/api/acs/users/update.md | 2 +- docs/api/phones/README.md | 2 +- docs/api/phones/deactivate.md | 2 +- docs/api/phones/get.md | 2 +- docs/api/phones/list.md | 2 +- docs/api/phones/simulate/create_sandbox_phone.md | 2 +- docs/api/thermostats/activate_climate_preset.md | 2 +- docs/api/thermostats/cool.md | 2 +- docs/api/thermostats/create_climate_preset.md | 2 +- docs/api/thermostats/delete_climate_preset.md | 2 +- docs/api/thermostats/heat.md | 2 +- docs/api/thermostats/heat_cool.md | 2 +- docs/api/thermostats/list.md | 2 +- docs/api/thermostats/off.md | 2 +- docs/api/thermostats/schedules/README.md | 2 +- docs/api/thermostats/schedules/create.md | 2 +- docs/api/thermostats/schedules/delete.md | 2 +- docs/api/thermostats/schedules/get.md | 2 +- docs/api/thermostats/schedules/list.md | 2 +- docs/api/thermostats/schedules/update.md | 2 +- docs/api/thermostats/set_fallback_climate_preset.md | 2 +- docs/api/thermostats/set_fan_mode.md | 2 +- docs/api/thermostats/set_hvac_mode.md | 2 +- docs/api/thermostats/set_temperature_threshold.md | 2 +- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 2 +- docs/api/thermostats/simulate/temperature_reached.md | 2 +- docs/api/thermostats/update_climate_preset.md | 2 +- docs/api/user_identities/README.md | 2 +- docs/api/user_identities/add_acs_user.md | 2 +- docs/api/user_identities/create.md | 2 +- docs/api/user_identities/delete.md | 2 +- docs/api/user_identities/enrollment_automations/README.md | 2 +- docs/api/user_identities/enrollment_automations/delete.md | 2 +- docs/api/user_identities/enrollment_automations/get.md | 2 +- docs/api/user_identities/enrollment_automations/launch.md | 2 +- docs/api/user_identities/enrollment_automations/list.md | 2 +- docs/api/user_identities/get.md | 2 +- docs/api/user_identities/grant_access_to_device.md | 2 +- docs/api/user_identities/list.md | 2 +- docs/api/user_identities/list_accessible_devices.md | 2 +- docs/api/user_identities/list_acs_systems.md | 2 +- docs/api/user_identities/list_acs_users.md | 2 +- docs/api/user_identities/remove_acs_user.md | 2 +- docs/api/user_identities/revoke_access_to_device.md | 2 +- docs/api/user_identities/update.md | 2 +- 105 files changed, 105 insertions(+), 105 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 74d309882..4f64cc070 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -52,7 +52,7 @@ In addition, for certain devices, Seam also supports [offline access codes](http ## Properties - +
PropertyDescription
PropertyDescription
access_code_id UUID Unique identifier for the access code. diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index f4bd59dda..ac028c120 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index 8f77bd13f..d50e9dbb5 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -37,7 +37,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_ids Array of UUIDs (Required) diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index 838752de7..06d90f905 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 84a133635..37cf2d3dc 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 1bfca58c1..4f7496991 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -31,7 +31,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_ids Array of UUIDs diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 6d019d1de..20462566a 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -37,7 +37,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index 26faf96c9..e10010282 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
code String (Required) diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 4a576cd1d..5051bed2f 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -43,7 +43,7 @@ Prior to using Seam to manage your devices, you may have used another lock manag ## Properties - +
PropertyDescription
PropertyDescription
access_code_id UUID Unique identifier for the access code. diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index 645f85352..ab42dce45 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -33,7 +33,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index 00e8b61e0..368a48c47 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index fa000d52b..93edd3e9e 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -31,7 +31,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index c3f7cd7f5..60c405db7 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index cad036f50..0d1dd25f5 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index 4d235304e..b50a351dd 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -31,7 +31,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index bc038681f..d87b94a66 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -33,7 +33,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
common_code_key String (Required) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 048c93191..8bab7ceca 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -41,7 +41,7 @@ To learn whether your access control system supports access groups, see the corr ## Properties - +
PropertyDescription
PropertyDescription
access_group_type Enum {% hint style="warning" %} diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 971da82d9..253dc5a08 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index cd19d2703..f042b7c58 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index ea3b44df4..d627eb17c 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index 771cc37af..c2a66153c 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 4e8bc1457..77abb2ac2 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index 503f5ce4d..a56efa846 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 7581e7b5f..1cc72e3c3 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -55,7 +55,7 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties - +
PropertyDescription
PropertyDescription
access_method Enum Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 665d97a02..472ff36b4 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 29560d6e9..1a7a6cff3 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_method String (Required) diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 2b5d064ad..3dc6bd48f 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index c497b99c1..8fa1ba9af 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index bc1cc2d0e..938a71299 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index ab71d2913..d3af3f3a9 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 92920b808..7217b74f3 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index 4bc574bc5..e9c31958f 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index fdad52be3..8c2a90beb 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -44,7 +44,7 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties - +
PropertyDescription
PropertyDescription
acs_encoder_id UUID ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index b80b1891e..bbb96e5cd 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 5dddfad6d..7dc5af9dd 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_ids Array of UUIDs diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index 9690ff317..c813942d7 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index 0e4753b1e..badc2f657 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index a5ad52dcc..d2a8ca85c 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index bbd68768e..f103a532e 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 98452ee25..9c92209b5 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 42f43088d..49356e85f 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -38,7 +38,7 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties - +
PropertyDescription
PropertyDescription
acs_entrance_id UUID ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index 3be23bcd4..a01e2961d 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - + diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index be5e9e32c..12fc67a1c 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
acs_entrance_id String (Required)
- + diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index 5e7ba5426..e3d27f1f2 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
acs_entrance_id String (Required)
- + diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 5534b7e7d..8b5037c3f 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
acs_credential_id String
- + diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 542159d87..8f9810dd4 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -53,7 +53,7 @@ For details about the resources associated with an access control system, see th ## Properties
ParameterDescription
ParameterDescription
acs_entrance_id String (Required)
- +
PropertyDescription
PropertyDescription
acs_access_group_count Number diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index c1498277a..902ce2849 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String (Required) diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index f7a72b7cb..d7facc23c 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -31,7 +31,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
connected_account_id String diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index 9d2b6cc92..ba16fad26 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String (Required) diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index a91547cfb..a0ea7316e 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -50,7 +50,7 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties - +
PropertyDescription
PropertyDescription
access_schedule Object `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index c805cac9e..6bd53e20d 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 6875b8c40..6ae0e3210 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String (Required) diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 64e659ad5..3a58b08e4 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index aaf8206ae..168e995ff 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 8be157a39..7ffab9a08 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 46bb1c53d..1085550e2 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 971f463e8..0877af81d 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 45f1e5141..7a7a87584 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index 0761b10ae..db3b0ebb2 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 9d82642f3..49ce8b27e 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index cbd78ffce..60174191a 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index c687ff09f..c6efcc52f 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -35,7 +35,7 @@ Represents an app user's mobile phone. ## Properties - +
PropertyDescription
PropertyDescription
created_at Datetime Date and time at which the `phone` was created. diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index a0c608fa7..58ff6bb4c 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index f755887c7..174f750ac 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 8ef2d1878..4b28ea9e6 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index 5562fdf50..fe1332534 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index 5501c757f..b20600cca 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index 64e2ca2a0..feb9f5318 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index d2c975a39..752962cd0 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index dd61b8b75..41933f0f7 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 2590d0785..01ff40d19 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index 6e913184b..d13dd306c 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index 409dd1fb2..aae1b4b32 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
connect_webview_id String diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 32aa90e12..783f3c719 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index 4009d36bd..d6719787b 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -34,7 +34,7 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties - +
PropertyDescription
PropertyDescription
climate_preset_key String Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index 17d79fa79..bd81da432 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index 3dec7d7d6..a7e676966 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
thermostat_schedule_id String (Required) diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index 8891bb0a2..daf3bf59a 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
thermostat_schedule_id String (Required) diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index fe76268b0..9e3e96d6a 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index db975a753..d7ef1207e 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
thermostat_schedule_id String (Required) diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 2df23f34b..3c4ae9b64 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 7f8948d94..59ac3ad08 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - + diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 4cb380fad..22cb55e53 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
device_id String (Required)
- +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 922bb1892..364587902 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 2e9e3c64c..520d9802e 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 7f1c140c1..4de38d2a4 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index b8a71a72b..eeaa89db1 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 46bd55a92..4ff8c0316 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -33,7 +33,7 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties - +
PropertyDescription
PropertyDescription
created_at Datetime Date and time at which the user identity was created. diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index 414d0c2c4..d371c8b61 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index baf62bb5d..18f029e0c 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
email_address String diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 90d4d77f5..944a8d525 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index cb362c94b..0596af4b6 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -30,7 +30,7 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties - +
PropertyDescription
PropertyDescription
created_at Datetime Date and time at which the enrollment automation was created. diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 39193c711..7a8899b78 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
enrollment_automation_id String (Required) diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 6db78728d..40a86f623 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
enrollment_automation_id String (Required) diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index fb6cbbb43..b58de4309 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
credential_manager_acs_system_id String (Required) diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 15fc1630a..28c36537a 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 0d6c6e946..5584e2aee 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index 318faf92b..abad225ec 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index d82bf428c..c0a10daa2 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - + diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index b47f15542..fd41584cc 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
credential_manager_acs_system_id String
- +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index d94c166ff..c6be35b9c 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index f4be67b25..c556b3e4b 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index 3262ca448..f30ee3371 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index 1b6480442..da4cfa04a 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 17e39f026..71b24f7a4 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) From 1cd4e0fd0379c8d7313849dab510b97ea45f4e6e Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:20:42 -0400 Subject: [PATCH 228/233] Update api-route.hbs --- src/layouts/api-route.hbs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 10e0e5a73..7932b89c3 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -7,7 +7,7 @@ ## Errors - + {{#each errors}} @@ -21,7 +21,7 @@ ## Warnings
ErrorDescription
ErrorDescription
{{name}}
- + {{#each warnings}} @@ -36,7 +36,7 @@ ## Events
WarningDescription
WarningDescription
{{name}}
- + {{#each events}}
EventDescription
EventDescription
{{name}} @@ -61,7 +61,7 @@ ## Endpoints - + {{#each endpoints}} From 45fdbe6a1f2a7226b2a9d1c61742961d8b615e47 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 04:21:37 +0000 Subject: [PATCH 229/233] ci: Generate docs --- docs/api/access_codes/README.md | 8 ++++---- docs/api/access_codes/simulate/README.md | 2 +- docs/api/access_codes/unmanaged/README.md | 6 +++--- docs/api/acs/access_groups/README.md | 4 ++-- docs/api/acs/credentials/README.md | 6 +++--- docs/api/acs/encoders/README.md | 4 ++-- docs/api/acs/encoders/simulate/README.md | 2 +- docs/api/acs/entrances/README.md | 4 ++-- docs/api/acs/systems/README.md | 8 ++++---- docs/api/acs/users/README.md | 8 ++++---- docs/api/phones/README.md | 4 ++-- docs/api/phones/simulate/README.md | 2 +- docs/api/thermostats/README.md | 2 +- docs/api/thermostats/schedules/README.md | 2 +- docs/api/thermostats/simulate/README.md | 2 +- docs/api/user_identities/README.md | 2 +- docs/api/user_identities/enrollment_automations/README.md | 4 ++-- 17 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 4f64cc070..10e83294b 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -224,7 +224,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Errors
EndpointDescription
EndpointDescription
{{path}}
- + @@ -387,7 +387,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Warnings
ErrorDescription
ErrorDescription
smartthings_failed_to_set_access_code Failed to set code on SmartThings device.
- + @@ -441,7 +441,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Events
WarningDescription
WarningDescription
smartthings_failed_to_set_access_code Failed to set code on SmartThings device.
- +
EventDescription
EventDescription
access_code.created An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created. @@ -1421,7 +1421,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l ## Endpoints - + diff --git a/docs/api/access_codes/simulate/README.md b/docs/api/access_codes/simulate/README.md index 5846ebac4..b1ecfb38a 100644 --- a/docs/api/access_codes/simulate/README.md +++ b/docs/api/access_codes/simulate/README.md @@ -5,7 +5,7 @@ ## Endpoints
EndpointDescription
EndpointDescription
/access_codes/create
- + diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 5051bed2f..86a578872 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -141,7 +141,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Errors
EndpointDescription
EndpointDescription
/access_codes/simulate/create_unmanaged_access_code
- + @@ -304,7 +304,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Warnings
ErrorDescription
ErrorDescription
smartthings_failed_to_set_access_code Failed to set code on SmartThings device.
- + @@ -359,7 +359,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Endpoints
WarningDescription
WarningDescription
smartthings_failed_to_set_access_code Failed to set code on SmartThings device.
- + diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index 8bab7ceca..fbc2110d9 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -178,7 +178,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events
EndpointDescription
EndpointDescription
/access_codes/unmanaged/convert_to_managed
- +
EventDescription
EventDescription
acs_access_group.deleted An ACS access group was deleted. @@ -238,7 +238,7 @@ An ACS access group was deleted. ## Endpoints - + diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 1cc72e3c3..538a47302 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -345,7 +345,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Warnings
EndpointDescription
EndpointDescription
/acs/access_groups/add_user
- + @@ -375,7 +375,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events
WarningDescription
WarningDescription
waiting_to_be_issued Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.
- +
EventDescription
EventDescription
acs_credential.deleted An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was deleted. @@ -597,7 +597,7 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia ## Endpoints - + diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 8c2a90beb..84c852cf1 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -115,7 +115,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events
EndpointDescription
EndpointDescription
/acs/credentials/assign
- +
EventDescription
EventDescription
acs_encoder.added An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was added. @@ -233,7 +233,7 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc ## Endpoints - + diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index be1516d8a..fa6a42b58 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -5,7 +5,7 @@ ## Endpoints
EndpointDescription
EndpointDescription
/acs/encoders/encode_credential
- + diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index 49356e85f..a3c06f399 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -305,7 +305,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability- ## Events
EndpointDescription
EndpointDescription
/acs/encoders/simulate/next_credential_encode_will_fail
- +
EventDescription
EventDescription
acs_entrance.added An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added. @@ -419,7 +419,7 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra ## Endpoints - + diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 8f9810dd4..27a0ce155 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -299,7 +299,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Errors
EndpointDescription
EndpointDescription
/acs/entrances/get
- +
ErrorDescription
ErrorDescription
seam_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. @@ -338,7 +338,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Warnings - + @@ -352,7 +352,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events
WarningDescription
WarningDescription
salto_ks_subscription_limit_almost_reached Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.
- +
EventDescription
EventDescription
acs_system.connected An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected. @@ -508,7 +508,7 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa ## Endpoints - + diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index a0ea7316e..53928b000 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -231,7 +231,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Errors
EndpointDescription
EndpointDescription
/acs/systems/get
- + @@ -257,7 +257,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Warnings
ErrorDescription
ErrorDescription
deleted_externally Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.
- + @@ -275,7 +275,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events
WarningDescription
WarningDescription
being_deleted Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.
- +
EventDescription
EventDescription
acs_user.deleted An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted. @@ -335,7 +335,7 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user- ## Endpoints - + diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index c6efcc52f..760a70f76 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -192,7 +192,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th ## Events
EndpointDescription
EndpointDescription
/acs/users/add_to_access_group
- +
EventDescription
EventDescription
phone.deactivated A phone device was deactivated. @@ -242,7 +242,7 @@ A phone device was deactivated. ## Endpoints - + diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index cbac1cf3e..baf661f24 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -5,7 +5,7 @@ ## Endpoints
EndpointDescription
EndpointDescription
/phones/deactivate
- + diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index 19f2abadb..d5c45785f 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -5,7 +5,7 @@ ## Endpoints
EndpointDescription
EndpointDescription
/phones/simulate/create_sandbox_phone
- + diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index d6719787b..fce39eaf6 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -121,7 +121,7 @@ ID of the [thermostat schedule](../../../capability-guides/thermostats/creating- ## Endpoints
EndpointDescription
EndpointDescription
/thermostats/activate_climate_preset
- + diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index 80d9488e2..c619f81de 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -5,7 +5,7 @@ ## Endpoints
EndpointDescription
EndpointDescription
/thermostats/schedules/create
- + diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 4ff8c0316..5bbcc9890 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -92,7 +92,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th ## Endpoints
EndpointDescription
EndpointDescription
/thermostats/simulate/hvac_mode_adjusted
- + diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index 0596af4b6..a58e6f0f9 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -71,7 +71,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events
EndpointDescription
EndpointDescription
/user_identities/add_acs_user
- +
EventDescription
EventDescription
enrollment_automation.deleted An [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) was deleted. @@ -121,7 +121,7 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi ## Endpoints - + From 5ac09f44e339e68b4e11890a1f09af72f6ec9e44 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:25:05 -0400 Subject: [PATCH 230/233] Update api-route.hbs --- src/layouts/api-route.hbs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/layouts/api-route.hbs b/src/layouts/api-route.hbs index 7932b89c3..0d07a138d 100644 --- a/src/layouts/api-route.hbs +++ b/src/layouts/api-route.hbs @@ -7,7 +7,7 @@ ## Errors
EndpointDescription
EndpointDescription
/user_identities/enrollment_automations/delete
- + {{#each errors}} @@ -21,7 +21,7 @@ ## Warnings
ErrorDescription
ErrorDescription
{{name}}
- + {{#each warnings}} @@ -36,7 +36,7 @@ ## Events
WarningDescription
WarningDescription
{{name}}
- + {{#each events}}
EventDescription
EventDescription
{{name}} @@ -61,7 +61,7 @@ ## Endpoints - + {{#each endpoints}} From ce0bda672c7911c7a9ec457709aebed434814917 Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:25:42 -0400 Subject: [PATCH 231/233] Update api-endpoint.hbs --- src/layouts/api-endpoint.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs index 61dae0848..8997031a4 100644 --- a/src/layouts/api-endpoint.hbs +++ b/src/layouts/api-endpoint.hbs @@ -34,7 +34,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati {{#if request.parameters.length}}
EndpointDescription
EndpointDescription
{{path}}
- + {{#each request.parameters}}
ParameterDescription
ParameterDescription
{{this.name}} {{this.jsonType}}{{#if this.itemFormat}} of {{this.itemFormat}}s{{/if}}{{#if this.required}} (Required){{/if}} From cd2bd3b3d1c3993f2915e7818d300c1e0028ba4b Mon Sep 17 00:00:00 2001 From: DebbieAtSeam <145377258+DebbieAtSeam@users.noreply.github.com> Date: Tue, 15 Apr 2025 00:26:26 -0400 Subject: [PATCH 232/233] Update api-resource.hbs --- src/layouts/partials/api-resource.hbs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/layouts/partials/api-resource.hbs b/src/layouts/partials/api-resource.hbs index 9e5bc0c35..bf3248493 100644 --- a/src/layouts/partials/api-resource.hbs +++ b/src/layouts/partials/api-resource.hbs @@ -40,7 +40,7 @@ {{/if}} - + {{#each properties}}
PropertyDescription
PropertyDescription
{{#if linkTarget}}{{name}}{{else}}{{name}}{{/if}} {{format}}{{#if listItemFormat}} of {{listItemFormat}}s{{/if}} From c2ef92d056a6645e9f3ea69ae13d16bbef1a08b5 Mon Sep 17 00:00:00 2001 From: Seam Bot Date: Tue, 15 Apr 2025 04:27:21 +0000 Subject: [PATCH 233/233] ci: Generate docs --- docs/api/access_codes/README.md | 10 +++++----- docs/api/access_codes/create.md | 2 +- docs/api/access_codes/create_multiple.md | 2 +- docs/api/access_codes/delete.md | 2 +- docs/api/access_codes/get.md | 2 +- docs/api/access_codes/list.md | 2 +- docs/api/access_codes/pull_backup_access_code.md | 2 +- docs/api/access_codes/simulate/README.md | 2 +- .../simulate/create_unmanaged_access_code.md | 2 +- docs/api/access_codes/unmanaged/README.md | 8 ++++---- docs/api/access_codes/unmanaged/convert_to_managed.md | 2 +- docs/api/access_codes/unmanaged/delete.md | 2 +- docs/api/access_codes/unmanaged/get.md | 2 +- docs/api/access_codes/unmanaged/list.md | 2 +- docs/api/access_codes/unmanaged/update.md | 2 +- docs/api/access_codes/update.md | 2 +- docs/api/access_codes/update_multiple.md | 2 +- docs/api/acs/access_groups/README.md | 6 +++--- docs/api/acs/access_groups/add_user.md | 2 +- docs/api/acs/access_groups/get.md | 2 +- docs/api/acs/access_groups/list.md | 2 +- .../api/acs/access_groups/list_accessible_entrances.md | 2 +- docs/api/acs/access_groups/list_users.md | 2 +- docs/api/acs/access_groups/remove_user.md | 2 +- docs/api/acs/credentials/README.md | 8 ++++---- docs/api/acs/credentials/assign.md | 2 +- docs/api/acs/credentials/create.md | 2 +- docs/api/acs/credentials/delete.md | 2 +- docs/api/acs/credentials/get.md | 2 +- docs/api/acs/credentials/list.md | 2 +- docs/api/acs/credentials/list_accessible_entrances.md | 2 +- docs/api/acs/credentials/unassign.md | 2 +- docs/api/acs/credentials/update.md | 2 +- docs/api/acs/encoders/README.md | 6 +++--- docs/api/acs/encoders/encode_credential.md | 2 +- docs/api/acs/encoders/list.md | 2 +- docs/api/acs/encoders/scan_credential.md | 2 +- docs/api/acs/encoders/simulate/README.md | 2 +- .../simulate/next_credential_encode_will_fail.md | 2 +- .../simulate/next_credential_encode_will_succeed.md | 2 +- .../simulate/next_credential_scan_will_fail.md | 2 +- .../simulate/next_credential_scan_will_succeed.md | 2 +- docs/api/acs/entrances/README.md | 6 +++--- docs/api/acs/entrances/get.md | 2 +- docs/api/acs/entrances/grant_access.md | 2 +- docs/api/acs/entrances/list.md | 2 +- docs/api/acs/entrances/list_credentials_with_access.md | 2 +- docs/api/acs/systems/README.md | 10 +++++----- docs/api/acs/systems/get.md | 2 +- docs/api/acs/systems/list.md | 2 +- .../list_compatible_credential_manager_acs_systems.md | 2 +- docs/api/acs/users/README.md | 10 +++++----- docs/api/acs/users/add_to_access_group.md | 2 +- docs/api/acs/users/create.md | 2 +- docs/api/acs/users/delete.md | 2 +- docs/api/acs/users/get.md | 2 +- docs/api/acs/users/list.md | 2 +- docs/api/acs/users/list_accessible_entrances.md | 2 +- docs/api/acs/users/remove_from_access_group.md | 2 +- docs/api/acs/users/revoke_access_to_all_entrances.md | 2 +- docs/api/acs/users/suspend.md | 2 +- docs/api/acs/users/unsuspend.md | 2 +- docs/api/acs/users/update.md | 2 +- docs/api/phones/README.md | 6 +++--- docs/api/phones/deactivate.md | 2 +- docs/api/phones/get.md | 2 +- docs/api/phones/list.md | 2 +- docs/api/phones/simulate/README.md | 2 +- docs/api/phones/simulate/create_sandbox_phone.md | 2 +- docs/api/thermostats/README.md | 2 +- docs/api/thermostats/activate_climate_preset.md | 2 +- docs/api/thermostats/cool.md | 2 +- docs/api/thermostats/create_climate_preset.md | 2 +- docs/api/thermostats/delete_climate_preset.md | 2 +- docs/api/thermostats/heat.md | 2 +- docs/api/thermostats/heat_cool.md | 2 +- docs/api/thermostats/list.md | 2 +- docs/api/thermostats/off.md | 2 +- docs/api/thermostats/schedules/README.md | 4 ++-- docs/api/thermostats/schedules/create.md | 2 +- docs/api/thermostats/schedules/delete.md | 2 +- docs/api/thermostats/schedules/get.md | 2 +- docs/api/thermostats/schedules/list.md | 2 +- docs/api/thermostats/schedules/update.md | 2 +- docs/api/thermostats/set_fallback_climate_preset.md | 2 +- docs/api/thermostats/set_fan_mode.md | 2 +- docs/api/thermostats/set_hvac_mode.md | 2 +- docs/api/thermostats/set_temperature_threshold.md | 2 +- docs/api/thermostats/simulate/README.md | 2 +- docs/api/thermostats/simulate/hvac_mode_adjusted.md | 2 +- docs/api/thermostats/simulate/temperature_reached.md | 2 +- docs/api/thermostats/update_climate_preset.md | 2 +- docs/api/user_identities/README.md | 4 ++-- docs/api/user_identities/add_acs_user.md | 2 +- docs/api/user_identities/create.md | 2 +- docs/api/user_identities/delete.md | 2 +- .../user_identities/enrollment_automations/README.md | 6 +++--- .../user_identities/enrollment_automations/delete.md | 2 +- docs/api/user_identities/enrollment_automations/get.md | 2 +- .../user_identities/enrollment_automations/launch.md | 2 +- .../api/user_identities/enrollment_automations/list.md | 2 +- docs/api/user_identities/get.md | 2 +- docs/api/user_identities/grant_access_to_device.md | 2 +- docs/api/user_identities/list.md | 2 +- docs/api/user_identities/list_accessible_devices.md | 2 +- docs/api/user_identities/list_acs_systems.md | 2 +- docs/api/user_identities/list_acs_users.md | 2 +- docs/api/user_identities/remove_acs_user.md | 2 +- docs/api/user_identities/revoke_access_to_device.md | 2 +- docs/api/user_identities/update.md | 2 +- 110 files changed, 140 insertions(+), 140 deletions(-) diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 10e83294b..e04338f85 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -52,7 +52,7 @@ In addition, for certain devices, Seam also supports [offline access codes](http ## Properties - +
PropertyDescription
PropertyDescription
access_code_id UUID Unique identifier for the access code. @@ -224,7 +224,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Errors - + @@ -387,7 +387,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Warnings
ErrorDescription
ErrorDescription
smartthings_failed_to_set_access_code Failed to set code on SmartThings device.
- + @@ -441,7 +441,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Events
WarningDescription
WarningDescription
smartthings_failed_to_set_access_code Failed to set code on SmartThings device.
- +
EventDescription
EventDescription
access_code.created An [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) was created. @@ -1421,7 +1421,7 @@ An [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-l ## Endpoints - + diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index ac028c120..326638f7a 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/access_codes/create
- +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index d50e9dbb5..42dfcdfa1 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -37,7 +37,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_ids Array of UUIDs (Required) diff --git a/docs/api/access_codes/delete.md b/docs/api/access_codes/delete.md index 06d90f905..dcd73cadf 100644 --- a/docs/api/access_codes/delete.md +++ b/docs/api/access_codes/delete.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/get.md b/docs/api/access_codes/get.md index 37cf2d3dc..72fc47993 100644 --- a/docs/api/access_codes/get.md +++ b/docs/api/access_codes/get.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String diff --git a/docs/api/access_codes/list.md b/docs/api/access_codes/list.md index 4f7496991..e7d1b0774 100644 --- a/docs/api/access_codes/list.md +++ b/docs/api/access_codes/list.md @@ -31,7 +31,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_ids Array of UUIDs diff --git a/docs/api/access_codes/pull_backup_access_code.md b/docs/api/access_codes/pull_backup_access_code.md index 20462566a..5b6ed9c8a 100644 --- a/docs/api/access_codes/pull_backup_access_code.md +++ b/docs/api/access_codes/pull_backup_access_code.md @@ -37,7 +37,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/simulate/README.md b/docs/api/access_codes/simulate/README.md index b1ecfb38a..07e502ef9 100644 --- a/docs/api/access_codes/simulate/README.md +++ b/docs/api/access_codes/simulate/README.md @@ -5,7 +5,7 @@ ## Endpoints - + diff --git a/docs/api/access_codes/simulate/create_unmanaged_access_code.md b/docs/api/access_codes/simulate/create_unmanaged_access_code.md index e10010282..dd74fc147 100644 --- a/docs/api/access_codes/simulate/create_unmanaged_access_code.md +++ b/docs/api/access_codes/simulate/create_unmanaged_access_code.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/access_codes/simulate/create_unmanaged_access_code
- +
ParameterDescription
ParameterDescription
code String (Required) diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 86a578872..80e9057ae 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -43,7 +43,7 @@ Prior to using Seam to manage your devices, you may have used another lock manag ## Properties - +
PropertyDescription
PropertyDescription
access_code_id UUID Unique identifier for the access code. @@ -141,7 +141,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Errors - + @@ -304,7 +304,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Warnings
ErrorDescription
ErrorDescription
smartthings_failed_to_set_access_code Failed to set code on SmartThings device.
- + @@ -359,7 +359,7 @@ Warnings associated with the [access code](https://docs.seam.co/latest/capabilit ## Endpoints
WarningDescription
WarningDescription
smartthings_failed_to_set_access_code Failed to set code on SmartThings device.
- + diff --git a/docs/api/access_codes/unmanaged/convert_to_managed.md b/docs/api/access_codes/unmanaged/convert_to_managed.md index ab42dce45..96c18885e 100644 --- a/docs/api/access_codes/unmanaged/convert_to_managed.md +++ b/docs/api/access_codes/unmanaged/convert_to_managed.md @@ -33,7 +33,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/access_codes/unmanaged/convert_to_managed
- +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/unmanaged/delete.md b/docs/api/access_codes/unmanaged/delete.md index 368a48c47..691eed8cf 100644 --- a/docs/api/access_codes/unmanaged/delete.md +++ b/docs/api/access_codes/unmanaged/delete.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/unmanaged/get.md b/docs/api/access_codes/unmanaged/get.md index 93edd3e9e..23b3822ed 100644 --- a/docs/api/access_codes/unmanaged/get.md +++ b/docs/api/access_codes/unmanaged/get.md @@ -31,7 +31,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String diff --git a/docs/api/access_codes/unmanaged/list.md b/docs/api/access_codes/unmanaged/list.md index 60c405db7..9321f41b4 100644 --- a/docs/api/access_codes/unmanaged/list.md +++ b/docs/api/access_codes/unmanaged/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/access_codes/unmanaged/update.md b/docs/api/access_codes/unmanaged/update.md index 0d1dd25f5..2c3348625 100644 --- a/docs/api/access_codes/unmanaged/update.md +++ b/docs/api/access_codes/unmanaged/update.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index b50a351dd..016adf03e 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -31,7 +31,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_code_id String (Required) diff --git a/docs/api/access_codes/update_multiple.md b/docs/api/access_codes/update_multiple.md index d87b94a66..9c5119d95 100644 --- a/docs/api/access_codes/update_multiple.md +++ b/docs/api/access_codes/update_multiple.md @@ -33,7 +33,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
common_code_key String (Required) diff --git a/docs/api/acs/access_groups/README.md b/docs/api/acs/access_groups/README.md index fbc2110d9..faf422f94 100644 --- a/docs/api/acs/access_groups/README.md +++ b/docs/api/acs/access_groups/README.md @@ -41,7 +41,7 @@ To learn whether your access control system supports access groups, see the corr ## Properties - +
PropertyDescription
PropertyDescription
access_group_type Enum {% hint style="warning" %} @@ -178,7 +178,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events - +
EventDescription
EventDescription
acs_access_group.deleted An ACS access group was deleted. @@ -238,7 +238,7 @@ An ACS access group was deleted. ## Endpoints - + diff --git a/docs/api/acs/access_groups/add_user.md b/docs/api/acs/access_groups/add_user.md index 253dc5a08..f44fd7bf4 100644 --- a/docs/api/acs/access_groups/add_user.md +++ b/docs/api/acs/access_groups/add_user.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/acs/access_groups/add_user
- +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/access_groups/get.md b/docs/api/acs/access_groups/get.md index f042b7c58..115aba9c6 100644 --- a/docs/api/acs/access_groups/get.md +++ b/docs/api/acs/access_groups/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/access_groups/list.md b/docs/api/acs/access_groups/list.md index d627eb17c..f78246110 100644 --- a/docs/api/acs/access_groups/list.md +++ b/docs/api/acs/access_groups/list.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String diff --git a/docs/api/acs/access_groups/list_accessible_entrances.md b/docs/api/acs/access_groups/list_accessible_entrances.md index c2a66153c..550198f9b 100644 --- a/docs/api/acs/access_groups/list_accessible_entrances.md +++ b/docs/api/acs/access_groups/list_accessible_entrances.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/access_groups/list_users.md b/docs/api/acs/access_groups/list_users.md index 77abb2ac2..936cbca80 100644 --- a/docs/api/acs/access_groups/list_users.md +++ b/docs/api/acs/access_groups/list_users.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/access_groups/remove_user.md b/docs/api/acs/access_groups/remove_user.md index a56efa846..fa15fcad2 100644 --- a/docs/api/acs/access_groups/remove_user.md +++ b/docs/api/acs/access_groups/remove_user.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 538a47302..e300bad36 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -55,7 +55,7 @@ For each `acs_credential`, you define the access method. You can also specify ad ## Properties - +
PropertyDescription
PropertyDescription
access_method Enum Access method for the [credential](../../../capability-guides/access-systems/managing-credentials.md). Supported values: `code`, `card`, `mobile_key`. @@ -345,7 +345,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Warnings - + @@ -375,7 +375,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events
WarningDescription
WarningDescription
waiting_to_be_issued Indicates that the [credential](../../../capability-guides/access-systems/managing-credentials.md) is waiting to be issued.
- +
EventDescription
EventDescription
acs_credential.deleted An [ACS credential](../../../capability-guides/access-systems/managing-credentials.md) was deleted. @@ -597,7 +597,7 @@ An [ACS credential](../../../capability-guides/access-systems/managing-credentia ## Endpoints - + diff --git a/docs/api/acs/credentials/assign.md b/docs/api/acs/credentials/assign.md index 472ff36b4..104963607 100644 --- a/docs/api/acs/credentials/assign.md +++ b/docs/api/acs/credentials/assign.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/acs/credentials/assign
- +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/create.md b/docs/api/acs/credentials/create.md index 1a7a6cff3..8275d07e9 100644 --- a/docs/api/acs/credentials/create.md +++ b/docs/api/acs/credentials/create.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
access_method String (Required) diff --git a/docs/api/acs/credentials/delete.md b/docs/api/acs/credentials/delete.md index 3dc6bd48f..e8b324126 100644 --- a/docs/api/acs/credentials/delete.md +++ b/docs/api/acs/credentials/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/get.md b/docs/api/acs/credentials/get.md index 8fa1ba9af..181d9c30c 100644 --- a/docs/api/acs/credentials/get.md +++ b/docs/api/acs/credentials/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/list.md b/docs/api/acs/credentials/list.md index 938a71299..e4d7d641a 100644 --- a/docs/api/acs/credentials/list.md +++ b/docs/api/acs/credentials/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String diff --git a/docs/api/acs/credentials/list_accessible_entrances.md b/docs/api/acs/credentials/list_accessible_entrances.md index d3af3f3a9..fbbf50748 100644 --- a/docs/api/acs/credentials/list_accessible_entrances.md +++ b/docs/api/acs/credentials/list_accessible_entrances.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/unassign.md b/docs/api/acs/credentials/unassign.md index 7217b74f3..b7e7bf2d2 100644 --- a/docs/api/acs/credentials/unassign.md +++ b/docs/api/acs/credentials/unassign.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/credentials/update.md b/docs/api/acs/credentials/update.md index e9c31958f..0a336745f 100644 --- a/docs/api/acs/credentials/update.md +++ b/docs/api/acs/credentials/update.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/encoders/README.md b/docs/api/acs/encoders/README.md index 84c852cf1..03f22c35c 100644 --- a/docs/api/acs/encoders/README.md +++ b/docs/api/acs/encoders/README.md @@ -44,7 +44,7 @@ To verify if your access control system requires a card encoder, see the corresp ## Properties - +
PropertyDescription
PropertyDescription
acs_encoder_id UUID ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. @@ -115,7 +115,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events - +
EventDescription
EventDescription
acs_encoder.added An [ACS encoder](../../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md) was added. @@ -233,7 +233,7 @@ An [ACS encoder](../../../capability-guides/access-systems/working-with-card-enc ## Endpoints - + diff --git a/docs/api/acs/encoders/encode_credential.md b/docs/api/acs/encoders/encode_credential.md index bbb96e5cd..63cd59960 100644 --- a/docs/api/acs/encoders/encode_credential.md +++ b/docs/api/acs/encoders/encode_credential.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/acs/encoders/encode_credential
- +
ParameterDescription
ParameterDescription
acs_credential_id String (Required) diff --git a/docs/api/acs/encoders/list.md b/docs/api/acs/encoders/list.md index 7dc5af9dd..4f1effda7 100644 --- a/docs/api/acs/encoders/list.md +++ b/docs/api/acs/encoders/list.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_ids Array of UUIDs diff --git a/docs/api/acs/encoders/scan_credential.md b/docs/api/acs/encoders/scan_credential.md index c813942d7..325ebef6b 100644 --- a/docs/api/acs/encoders/scan_credential.md +++ b/docs/api/acs/encoders/scan_credential.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/encoders/simulate/README.md b/docs/api/acs/encoders/simulate/README.md index fa6a42b58..4df937f80 100644 --- a/docs/api/acs/encoders/simulate/README.md +++ b/docs/api/acs/encoders/simulate/README.md @@ -5,7 +5,7 @@ ## Endpoints - + diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md index badc2f657..30001a343 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_fail.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/acs/encoders/simulate/next_credential_encode_will_fail
- +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md index d2a8ca85c..6ff10987c 100644 --- a/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_encode_will_succeed.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md index f103a532e..9d855ba60 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_fail.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md index 9c92209b5..7e59f22dc 100644 --- a/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md +++ b/docs/api/acs/encoders/simulate/next_credential_scan_will_succeed.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_encoder_id String (Required) diff --git a/docs/api/acs/entrances/README.md b/docs/api/acs/entrances/README.md index a3c06f399..1847765df 100644 --- a/docs/api/acs/entrances/README.md +++ b/docs/api/acs/entrances/README.md @@ -38,7 +38,7 @@ In an access control system, an entrance is a secured door, gate, zone, or other ## Properties - +
PropertyDescription
PropertyDescription
acs_entrance_id UUID ID of the [entrance](../../../capability-guides/access-systems/retrieving-entrance-details.md). @@ -305,7 +305,7 @@ Visionline-specific metadata associated with the [entrance](../../../capability- ## Events - +
EventDescription
EventDescription
acs_entrance.added An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added. @@ -419,7 +419,7 @@ An [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entra ## Endpoints - + diff --git a/docs/api/acs/entrances/get.md b/docs/api/acs/entrances/get.md index a01e2961d..e9df09a57 100644 --- a/docs/api/acs/entrances/get.md +++ b/docs/api/acs/entrances/get.md @@ -27,7 +27,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/acs/entrances/get
- + diff --git a/docs/api/acs/entrances/grant_access.md b/docs/api/acs/entrances/grant_access.md index 12fc67a1c..a87247caf 100644 --- a/docs/api/acs/entrances/grant_access.md +++ b/docs/api/acs/entrances/grant_access.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
acs_entrance_id String (Required)
- + diff --git a/docs/api/acs/entrances/list.md b/docs/api/acs/entrances/list.md index e3d27f1f2..406b23565 100644 --- a/docs/api/acs/entrances/list.md +++ b/docs/api/acs/entrances/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
acs_entrance_id String (Required)
- + diff --git a/docs/api/acs/entrances/list_credentials_with_access.md b/docs/api/acs/entrances/list_credentials_with_access.md index 8b5037c3f..d722225c9 100644 --- a/docs/api/acs/entrances/list_credentials_with_access.md +++ b/docs/api/acs/entrances/list_credentials_with_access.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
acs_credential_id String
- + diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 27a0ce155..7080d861a 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -53,7 +53,7 @@ For details about the resources associated with an access control system, see th ## Properties
ParameterDescription
ParameterDescription
acs_entrance_id String (Required)
- +
PropertyDescription
PropertyDescription
acs_access_group_count Number @@ -299,7 +299,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Errors - +
ErrorDescription
ErrorDescription
seam_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. @@ -338,7 +338,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Warnings - + @@ -352,7 +352,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events
WarningDescription
WarningDescription
salto_ks_subscription_limit_almost_reached Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site to rectify the issue.
- +
EventDescription
EventDescription
acs_system.connected An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) was connected. @@ -508,7 +508,7 @@ An [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) wa ## Endpoints - + diff --git a/docs/api/acs/systems/get.md b/docs/api/acs/systems/get.md index 902ce2849..0755aa5b4 100644 --- a/docs/api/acs/systems/get.md +++ b/docs/api/acs/systems/get.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/acs/systems/get
- +
ParameterDescription
ParameterDescription
acs_system_id String (Required) diff --git a/docs/api/acs/systems/list.md b/docs/api/acs/systems/list.md index d7facc23c..59d1eaa70 100644 --- a/docs/api/acs/systems/list.md +++ b/docs/api/acs/systems/list.md @@ -31,7 +31,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
connected_account_id String diff --git a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md index ba16fad26..3ab345ffb 100644 --- a/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md +++ b/docs/api/acs/systems/list_compatible_credential_manager_acs_systems.md @@ -30,7 +30,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String (Required) diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 53928b000..e91ec4722 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -50,7 +50,7 @@ For details about how to configure `acs_user`s in your access control system, se ## Properties - +
PropertyDescription
PropertyDescription
access_schedule Object `starts_at` and `ends_at` timestamps for the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access. @@ -231,7 +231,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Errors - + @@ -257,7 +257,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Warnings
ErrorDescription
ErrorDescription
deleted_externally Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) outside of Seam.
- + @@ -275,7 +275,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events
WarningDescription
WarningDescription
being_deleted Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) is being deleted from the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). This is a temporary state, and the ACS user will be deleted shortly.
- +
EventDescription
EventDescription
acs_user.deleted An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) was deleted. @@ -335,7 +335,7 @@ An [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user- ## Endpoints - + diff --git a/docs/api/acs/users/add_to_access_group.md b/docs/api/acs/users/add_to_access_group.md index 6bd53e20d..029a0aff4 100644 --- a/docs/api/acs/users/add_to_access_group.md +++ b/docs/api/acs/users/add_to_access_group.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/acs/users/add_to_access_group
- +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/users/create.md b/docs/api/acs/users/create.md index 6ae0e3210..ce0f1599a 100644 --- a/docs/api/acs/users/create.md +++ b/docs/api/acs/users/create.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String (Required) diff --git a/docs/api/acs/users/delete.md b/docs/api/acs/users/delete.md index 3a58b08e4..12dcb04a6 100644 --- a/docs/api/acs/users/delete.md +++ b/docs/api/acs/users/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/get.md b/docs/api/acs/users/get.md index 168e995ff..5f47b7d94 100644 --- a/docs/api/acs/users/get.md +++ b/docs/api/acs/users/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/list.md b/docs/api/acs/users/list.md index 7ffab9a08..c3ec145ac 100644 --- a/docs/api/acs/users/list.md +++ b/docs/api/acs/users/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_system_id String diff --git a/docs/api/acs/users/list_accessible_entrances.md b/docs/api/acs/users/list_accessible_entrances.md index 1085550e2..c31f3d097 100644 --- a/docs/api/acs/users/list_accessible_entrances.md +++ b/docs/api/acs/users/list_accessible_entrances.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/remove_from_access_group.md b/docs/api/acs/users/remove_from_access_group.md index 0877af81d..0d46d115c 100644 --- a/docs/api/acs/users/remove_from_access_group.md +++ b/docs/api/acs/users/remove_from_access_group.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_access_group_id String (Required) diff --git a/docs/api/acs/users/revoke_access_to_all_entrances.md b/docs/api/acs/users/revoke_access_to_all_entrances.md index 7a7a87584..06616ac05 100644 --- a/docs/api/acs/users/revoke_access_to_all_entrances.md +++ b/docs/api/acs/users/revoke_access_to_all_entrances.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/suspend.md b/docs/api/acs/users/suspend.md index db3b0ebb2..4448fa0e5 100644 --- a/docs/api/acs/users/suspend.md +++ b/docs/api/acs/users/suspend.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/unsuspend.md b/docs/api/acs/users/unsuspend.md index 49ce8b27e..d1c218e0b 100644 --- a/docs/api/acs/users/unsuspend.md +++ b/docs/api/acs/users/unsuspend.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/acs/users/update.md b/docs/api/acs/users/update.md index 60174191a..2698ab88a 100644 --- a/docs/api/acs/users/update.md +++ b/docs/api/acs/users/update.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 760a70f76..7692358da 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -35,7 +35,7 @@ Represents an app user's mobile phone. ## Properties - +
PropertyDescription
PropertyDescription
created_at Datetime Date and time at which the `phone` was created. @@ -192,7 +192,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th ## Events - +
EventDescription
EventDescription
phone.deactivated A phone device was deactivated. @@ -242,7 +242,7 @@ A phone device was deactivated. ## Endpoints - + diff --git a/docs/api/phones/deactivate.md b/docs/api/phones/deactivate.md index 58ff6bb4c..2d50a95d3 100644 --- a/docs/api/phones/deactivate.md +++ b/docs/api/phones/deactivate.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/phones/deactivate
- +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/phones/get.md b/docs/api/phones/get.md index 174f750ac..328bc1042 100644 --- a/docs/api/phones/get.md +++ b/docs/api/phones/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/phones/list.md b/docs/api/phones/list.md index 4b28ea9e6..cf767bf36 100644 --- a/docs/api/phones/list.md +++ b/docs/api/phones/list.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_credential_id String diff --git a/docs/api/phones/simulate/README.md b/docs/api/phones/simulate/README.md index baf661f24..890a45075 100644 --- a/docs/api/phones/simulate/README.md +++ b/docs/api/phones/simulate/README.md @@ -5,7 +5,7 @@ ## Endpoints - + diff --git a/docs/api/phones/simulate/create_sandbox_phone.md b/docs/api/phones/simulate/create_sandbox_phone.md index fe1332534..f384d4cb2 100644 --- a/docs/api/phones/simulate/create_sandbox_phone.md +++ b/docs/api/phones/simulate/create_sandbox_phone.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/phones/simulate/create_sandbox_phone
- +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/thermostats/README.md b/docs/api/thermostats/README.md index d5c45785f..1e2814bc5 100644 --- a/docs/api/thermostats/README.md +++ b/docs/api/thermostats/README.md @@ -5,7 +5,7 @@ ## Endpoints - + diff --git a/docs/api/thermostats/activate_climate_preset.md b/docs/api/thermostats/activate_climate_preset.md index b20600cca..67edb3f37 100644 --- a/docs/api/thermostats/activate_climate_preset.md +++ b/docs/api/thermostats/activate_climate_preset.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/thermostats/activate_climate_preset
- +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/cool.md b/docs/api/thermostats/cool.md index feb9f5318..8a2618ed4 100644 --- a/docs/api/thermostats/cool.md +++ b/docs/api/thermostats/cool.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/create_climate_preset.md b/docs/api/thermostats/create_climate_preset.md index 752962cd0..6c37f59ca 100644 --- a/docs/api/thermostats/create_climate_preset.md +++ b/docs/api/thermostats/create_climate_preset.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/delete_climate_preset.md b/docs/api/thermostats/delete_climate_preset.md index 41933f0f7..8fcb98cd1 100644 --- a/docs/api/thermostats/delete_climate_preset.md +++ b/docs/api/thermostats/delete_climate_preset.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/heat.md b/docs/api/thermostats/heat.md index 01ff40d19..8ed88552b 100644 --- a/docs/api/thermostats/heat.md +++ b/docs/api/thermostats/heat.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/heat_cool.md b/docs/api/thermostats/heat_cool.md index d13dd306c..baf80d57b 100644 --- a/docs/api/thermostats/heat_cool.md +++ b/docs/api/thermostats/heat_cool.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/list.md b/docs/api/thermostats/list.md index aae1b4b32..1e1b90af6 100644 --- a/docs/api/thermostats/list.md +++ b/docs/api/thermostats/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
connect_webview_id String diff --git a/docs/api/thermostats/off.md b/docs/api/thermostats/off.md index 783f3c719..1615f8e76 100644 --- a/docs/api/thermostats/off.md +++ b/docs/api/thermostats/off.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/schedules/README.md b/docs/api/thermostats/schedules/README.md index fce39eaf6..240108195 100644 --- a/docs/api/thermostats/schedules/README.md +++ b/docs/api/thermostats/schedules/README.md @@ -34,7 +34,7 @@ Represents a [thermostat schedule](../../../capability-guides/thermostats/creati ## Properties - +
PropertyDescription
PropertyDescription
climate_preset_key String Key of the [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) to use for the [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md). @@ -121,7 +121,7 @@ ID of the [thermostat schedule](../../../capability-guides/thermostats/creating- ## Endpoints - + diff --git a/docs/api/thermostats/schedules/create.md b/docs/api/thermostats/schedules/create.md index bd81da432..f026d1c41 100644 --- a/docs/api/thermostats/schedules/create.md +++ b/docs/api/thermostats/schedules/create.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/thermostats/schedules/create
- +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/schedules/delete.md b/docs/api/thermostats/schedules/delete.md index a7e676966..23b727c8f 100644 --- a/docs/api/thermostats/schedules/delete.md +++ b/docs/api/thermostats/schedules/delete.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
thermostat_schedule_id String (Required) diff --git a/docs/api/thermostats/schedules/get.md b/docs/api/thermostats/schedules/get.md index daf3bf59a..5259e81ba 100644 --- a/docs/api/thermostats/schedules/get.md +++ b/docs/api/thermostats/schedules/get.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
thermostat_schedule_id String (Required) diff --git a/docs/api/thermostats/schedules/list.md b/docs/api/thermostats/schedules/list.md index 9e3e96d6a..8240342ef 100644 --- a/docs/api/thermostats/schedules/list.md +++ b/docs/api/thermostats/schedules/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/schedules/update.md b/docs/api/thermostats/schedules/update.md index d7ef1207e..3f640f9a8 100644 --- a/docs/api/thermostats/schedules/update.md +++ b/docs/api/thermostats/schedules/update.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
thermostat_schedule_id String (Required) diff --git a/docs/api/thermostats/set_fallback_climate_preset.md b/docs/api/thermostats/set_fallback_climate_preset.md index 3c4ae9b64..410f600f0 100644 --- a/docs/api/thermostats/set_fallback_climate_preset.md +++ b/docs/api/thermostats/set_fallback_climate_preset.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/thermostats/set_fan_mode.md b/docs/api/thermostats/set_fan_mode.md index 59ac3ad08..bd78f303c 100644 --- a/docs/api/thermostats/set_fan_mode.md +++ b/docs/api/thermostats/set_fan_mode.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - + diff --git a/docs/api/thermostats/set_hvac_mode.md b/docs/api/thermostats/set_hvac_mode.md index 22cb55e53..a34ca05e8 100644 --- a/docs/api/thermostats/set_hvac_mode.md +++ b/docs/api/thermostats/set_hvac_mode.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
device_id String (Required)
- +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/set_temperature_threshold.md b/docs/api/thermostats/set_temperature_threshold.md index 364587902..31120c6b1 100644 --- a/docs/api/thermostats/set_temperature_threshold.md +++ b/docs/api/thermostats/set_temperature_threshold.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/simulate/README.md b/docs/api/thermostats/simulate/README.md index c619f81de..aac910f76 100644 --- a/docs/api/thermostats/simulate/README.md +++ b/docs/api/thermostats/simulate/README.md @@ -5,7 +5,7 @@ ## Endpoints - + diff --git a/docs/api/thermostats/simulate/hvac_mode_adjusted.md b/docs/api/thermostats/simulate/hvac_mode_adjusted.md index 520d9802e..b083c1a60 100644 --- a/docs/api/thermostats/simulate/hvac_mode_adjusted.md +++ b/docs/api/thermostats/simulate/hvac_mode_adjusted.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/thermostats/simulate/hvac_mode_adjusted
- +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/simulate/temperature_reached.md b/docs/api/thermostats/simulate/temperature_reached.md index 4de38d2a4..06a82dff0 100644 --- a/docs/api/thermostats/simulate/temperature_reached.md +++ b/docs/api/thermostats/simulate/temperature_reached.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/thermostats/update_climate_preset.md b/docs/api/thermostats/update_climate_preset.md index eeaa89db1..ae7df3fd8 100644 --- a/docs/api/thermostats/update_climate_preset.md +++ b/docs/api/thermostats/update_climate_preset.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
climate_preset_key String (Required) diff --git a/docs/api/user_identities/README.md b/docs/api/user_identities/README.md index 5bbcc9890..9b891a767 100644 --- a/docs/api/user_identities/README.md +++ b/docs/api/user_identities/README.md @@ -33,7 +33,7 @@ Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobil ## Properties - +
PropertyDescription
PropertyDescription
created_at Datetime Date and time at which the user identity was created. @@ -92,7 +92,7 @@ ID of the [workspace](../../core-concepts/workspaces/README.md) that contains th ## Endpoints - + diff --git a/docs/api/user_identities/add_acs_user.md b/docs/api/user_identities/add_acs_user.md index d371c8b61..81742a474 100644 --- a/docs/api/user_identities/add_acs_user.md +++ b/docs/api/user_identities/add_acs_user.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/user_identities/add_acs_user
- +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/user_identities/create.md b/docs/api/user_identities/create.md index 18f029e0c..b725a98ef 100644 --- a/docs/api/user_identities/create.md +++ b/docs/api/user_identities/create.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
email_address String diff --git a/docs/api/user_identities/delete.md b/docs/api/user_identities/delete.md index 944a8d525..6de316ede 100644 --- a/docs/api/user_identities/delete.md +++ b/docs/api/user_identities/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/enrollment_automations/README.md b/docs/api/user_identities/enrollment_automations/README.md index a58e6f0f9..449887a78 100644 --- a/docs/api/user_identities/enrollment_automations/README.md +++ b/docs/api/user_identities/enrollment_automations/README.md @@ -30,7 +30,7 @@ Represents an [enrollment automation](https://docs.seam.co/latest/capability-gui ## Properties - +
PropertyDescription
PropertyDescription
created_at Datetime Date and time at which the enrollment automation was created. @@ -71,7 +71,7 @@ ID of the [workspace](../../../core-concepts/workspaces/README.md) that contains ## Events - +
EventDescription
EventDescription
enrollment_automation.deleted An [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) was deleted. @@ -121,7 +121,7 @@ An [enrollment automation](../../../capability-guides/mobile-access/issuing-mobi ## Endpoints - + diff --git a/docs/api/user_identities/enrollment_automations/delete.md b/docs/api/user_identities/enrollment_automations/delete.md index 7a8899b78..19e236a4a 100644 --- a/docs/api/user_identities/enrollment_automations/delete.md +++ b/docs/api/user_identities/enrollment_automations/delete.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
EndpointDescription
EndpointDescription
/user_identities/enrollment_automations/delete
- +
ParameterDescription
ParameterDescription
enrollment_automation_id String (Required) diff --git a/docs/api/user_identities/enrollment_automations/get.md b/docs/api/user_identities/enrollment_automations/get.md index 40a86f623..38c583fe2 100644 --- a/docs/api/user_identities/enrollment_automations/get.md +++ b/docs/api/user_identities/enrollment_automations/get.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
enrollment_automation_id String (Required) diff --git a/docs/api/user_identities/enrollment_automations/launch.md b/docs/api/user_identities/enrollment_automations/launch.md index b58de4309..961d7ef5c 100644 --- a/docs/api/user_identities/enrollment_automations/launch.md +++ b/docs/api/user_identities/enrollment_automations/launch.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
credential_manager_acs_system_id String (Required) diff --git a/docs/api/user_identities/enrollment_automations/list.md b/docs/api/user_identities/enrollment_automations/list.md index 28c36537a..132a4f563 100644 --- a/docs/api/user_identities/enrollment_automations/list.md +++ b/docs/api/user_identities/enrollment_automations/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/get.md b/docs/api/user_identities/get.md index 5584e2aee..cae80e087 100644 --- a/docs/api/user_identities/get.md +++ b/docs/api/user_identities/get.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String diff --git a/docs/api/user_identities/grant_access_to_device.md b/docs/api/user_identities/grant_access_to_device.md index abad225ec..0a53051a5 100644 --- a/docs/api/user_identities/grant_access_to_device.md +++ b/docs/api/user_identities/grant_access_to_device.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/user_identities/list.md b/docs/api/user_identities/list.md index c0a10daa2..ee3736123 100644 --- a/docs/api/user_identities/list.md +++ b/docs/api/user_identities/list.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - + diff --git a/docs/api/user_identities/list_accessible_devices.md b/docs/api/user_identities/list_accessible_devices.md index fd41584cc..7f562a5ee 100644 --- a/docs/api/user_identities/list_accessible_devices.md +++ b/docs/api/user_identities/list_accessible_devices.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters
ParameterDescription
ParameterDescription
credential_manager_acs_system_id String
- +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/list_acs_systems.md b/docs/api/user_identities/list_acs_systems.md index c6be35b9c..7c290dc0e 100644 --- a/docs/api/user_identities/list_acs_systems.md +++ b/docs/api/user_identities/list_acs_systems.md @@ -29,7 +29,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/list_acs_users.md b/docs/api/user_identities/list_acs_users.md index c556b3e4b..43399633d 100644 --- a/docs/api/user_identities/list_acs_users.md +++ b/docs/api/user_identities/list_acs_users.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required) diff --git a/docs/api/user_identities/remove_acs_user.md b/docs/api/user_identities/remove_acs_user.md index f30ee3371..63c36143e 100644 --- a/docs/api/user_identities/remove_acs_user.md +++ b/docs/api/user_identities/remove_acs_user.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
acs_user_id String (Required) diff --git a/docs/api/user_identities/revoke_access_to_device.md b/docs/api/user_identities/revoke_access_to_device.md index da4cfa04a..6dc47b0fe 100644 --- a/docs/api/user_identities/revoke_access_to_device.md +++ b/docs/api/user_identities/revoke_access_to_device.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
device_id String (Required) diff --git a/docs/api/user_identities/update.md b/docs/api/user_identities/update.md index 71b24f7a4..61b0566b6 100644 --- a/docs/api/user_identities/update.md +++ b/docs/api/user_identities/update.md @@ -28,7 +28,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati ## Request Parameters - +
ParameterDescription
ParameterDescription
user_identity_id String (Required)