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/213] 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 49d72cad..6a180bf4 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/213] 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 4767e017..3b0a758e 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/213] 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 6a180bf4..16e7e114 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/213] 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 3b0a758e..8aaecca6 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/213] 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 5274b67d..7a9c877c 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/213] 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 afbc61aa..09867517 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 564bcd03..236193c9 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 c1e2997f..7f49da5a 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 adf03373..903e4e93 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 026a4352..ce0feedd 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 240f7503..b5359816 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 248661f4..4a04b38c 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 3028245c..350b97e4 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 e361df76..0e26ab5a 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 66d5e32c..fca49b1b 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 48b777e4..794091e4 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 55ddf5a8..51f7e82e 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 1ef7a3dd..602814b4 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 f27a8723..89068332 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/213] 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 86205b41..8897755d 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/213] 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 09867517..b03ebdda 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 236193c9..18756514 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 7f49da5a..90948c79 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 4ff61ba9..36a2096f 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 cbe3e050..91078e1d 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 ce0feedd..447d4352 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 b5359816..55c80b1b 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 4a04b38c..3685eb87 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 350b97e4..fc7b8b5b 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 5b931e56..3581cf67 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 182fc93c..e5eeb887 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 44c9ad73..e94c92df 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 6003f60c..e45bed8d 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 b5b82471..b5d29835 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 794091e4..d368f688 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 bdf5e7d3..cbc03d51 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 64185341..0619e31b 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 602814b4..0655fc02 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 89068332..0b1a2b65 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/213] 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 8897755d..eebb7080 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/213] 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 b03ebdda..175433c8 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 18756514..e762fdba 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 90948c79..ea4a0607 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 36a2096f..a08e6241 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 91078e1d..2ea0ff24 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 447d4352..847fac9f 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 55c80b1b..e6c256b4 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 3685eb87..f42e0e4c 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 fc7b8b5b..1980a486 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 3581cf67..f389bd98 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 e5eeb887..c1188396 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 e94c92df..e572ed4a 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 e45bed8d..6ccc97c7 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 b5d29835..8499e412 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 d368f688..f48dbb86 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 cbc03d51..9c801e3a 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 0619e31b..b60e9003 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 0655fc02..6453bfe0 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 0b1a2b65..a7ed6110 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/213] 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 eebb7080..ee55e650 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/213] 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 175433c8..fd2400a9 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 e762fdba..554994b6 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 ea4a0607..53ce7862 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 a08e6241..36a2096f 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 2ea0ff24..91078e1d 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 847fac9f..1662bd41 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 e6c256b4..37d7ff77 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 f42e0e4c..f337d8f3 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 1980a486..40cfc1e8 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 f389bd98..3581cf67 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 c1188396..e5eeb887 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 e572ed4a..e94c92df 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 6ccc97c7..e45bed8d 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 8499e412..b5d29835 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 f48dbb86..8eb56019 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 9c801e3a..cbc03d51 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 b60e9003..0619e31b 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 6453bfe0..07800df0 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 a7ed6110..7f4938ee 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/213] 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 ee55e650..e4768fa7 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/213] 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 fd2400a9..b03ebdda 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 554994b6..18756514 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 53ce7862..90948c79 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 36a2096f..a626b06c 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 91078e1d..8ebba014 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 1662bd41..447d4352 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 37d7ff77..55c80b1b 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 f337d8f3..3685eb87 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 40cfc1e8..fc7b8b5b 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 3581cf67..350ad3ca 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 e5eeb887..77d36b7a 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 e94c92df..4b8658a2 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 e45bed8d..fb0ec58b 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 b5d29835..0e187e16 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 8eb56019..d368f688 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 cbc03d51..50ca2863 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 0619e31b..a08ccb18 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 07800df0..0655fc02 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 7f4938ee..0b1a2b65 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/213] 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 77bd23cd..c09f27b8 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/213] 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 6137a24e..20a37cbd 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/213] 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 a6312457..3a0f0272 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 5697d778..b3faa7fa 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 460f5323..a43216b0 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/213] 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 1e41aec6..695fd501 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/213] 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 983d0541..ec8c530c 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 e33a8cb1..a2322f7c 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 103b790b..4864901b 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 265ab76d..6eaa6c4d 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 c366a94a..ddad886c 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 6902f839..2eca1648 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 e1cae31f..834f543b 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 af1e25bf..01a2b443 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 9a0fee13..16de6807 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 649794ce..bb121731 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 2f656b11..e2ad59fb 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 3dddcd87..5db94f20 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 187a30eb..264c237d 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 549c4a2b..c6721e70 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 b4bbbbdf..734bd888 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 acf540d2..54fcee25 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 6cd85a7b..053d62a3 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 a4c54c15..e1fa0bba 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 61766cfe..32b1ab1f 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 64204002..c5a3e276 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 220fea9d..93fdd17f 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 20a37cbd..2641bb68 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 fcae60e5..dce805a1 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 997149da..f02cebce 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 b23c5a49..d5939d52 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 7a580880..90412f2b 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 3e7988c6..841c5bf2 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 e2f624dd..07baad2b 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 dccb7c8a..19d4df4e 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 2f654e1d..8400c458 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 9794da83..905835b4 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 069c4b3c..862b657e 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 57012378..d862f909 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 bb118964..f77d3f63 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 e2939248..6d8a9b3e 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 f0adedbe..40f4daa3 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 0242bd84..e447ba0a 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 834ad88a..6e15e404 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 ca4fc457..fa2febb2 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 1534426d..be6d39e5 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 3ee8d746..f61fdaae 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 3c72f533..773774b8 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 2cbfe3e0..248ac1b0 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 8f42e663..f07e2ccc 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 05e2f4bb..92cd1cef 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 ca66a4ec..0ff0003f 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 777f9bc9..8c5d6022 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 af928ae4..90421eee 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 817473e5..4326f564 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 2bdc55ac..0c0720b3 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 2e1962b9..54cbe59d 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 b53917f3..67530c3e 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 5dc34090..a23e5b10 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 8ed1a89c..49009f4f 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 a76dbf45..001cd912 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 b5121cc7..b6312078 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 7044c7aa..e23c138b 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 e84acbef..65f9c77f 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 27b7403e..b16202e1 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 d585f309..de3f8bdc 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 9ddac01d..348533b7 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 bf09b47b..9d9de2ef 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/213] 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 695fd501..0cef66c3 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/213] 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 ec8c530c..2c7bf69b 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 a2322f7c..e206f704 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 4864901b..70efeda9 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 6eaa6c4d..46e0fb96 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 ddad886c..d099bf15 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 2eca1648..161a6283 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 834f543b..53f6ed34 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 01a2b443..db9ddf2e 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 16de6807..17dc00af 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 bb121731..d98f72ca 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 e2ad59fb..3f9791c4 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 5db94f20..a77cf978 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 264c237d..e7fa89f1 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 c6721e70..2d8502e7 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 734bd888..3d5c4d90 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 54fcee25..5d3eec62 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 053d62a3..6f96ce7f 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 e1fa0bba..63a4959c 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 32b1ab1f..aade874d 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 c5a3e276..6db41acc 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 93fdd17f..e1b640b5 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 2641bb68..5213f5e4 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 dce805a1..ae6f7853 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 f02cebce..48b33f7b 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 d5939d52..f0a22d04 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 90412f2b..b66a08f2 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 841c5bf2..e49074db 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 07baad2b..8ca3d0f2 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 19d4df4e..2b0b499e 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 8400c458..95854487 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 905835b4..cbd50743 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 862b657e..f89b97c8 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 d862f909..05dadf8a 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 f77d3f63..4fec0628 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 6d8a9b3e..b1b660f8 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 40f4daa3..f1b56dd9 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 e447ba0a..143fb084 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 6e15e404..77b3445f 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 fa2febb2..7f753200 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 be6d39e5..b75581bc 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 f61fdaae..ef5e66b3 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 773774b8..0889ea14 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 248ac1b0..24c644eb 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 f07e2ccc..dfa1bafc 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 92cd1cef..85f530cf 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 0ff0003f..e9425a28 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 8c5d6022..186da7b2 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 90421eee..3edf37f0 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 4326f564..188c9bb5 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 0c0720b3..6a4fee0d 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 54cbe59d..36b0ce73 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 67530c3e..a5fa0ec7 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 a23e5b10..554e8e5c 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 49009f4f..1d85c81f 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 001cd912..8cd5b9bf 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 b6312078..a1a81522 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 e23c138b..a9489683 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 65f9c77f..9ac82b8e 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 b16202e1..9e3de822 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 de3f8bdc..3cc8ed5c 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 348533b7..a51c702a 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 9d9de2ef..a1deac4c 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/213] 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 0cef66c3..da03adb5 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/213] 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 da03adb5..4b6bee91 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/213] 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 2c7bf69b..1cb598c0 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 e206f704..895b3944 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 70efeda9..8d77f25a 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 46e0fb96..3f16648f 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 d099bf15..fcc04c21 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 161a6283..6d62b108 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 53f6ed34..86e4d290 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 db9ddf2e..24f92bcb 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 17dc00af..30abfe8b 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 d98f72ca..8bde9999 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 3f9791c4..c560e2c1 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 a77cf978..db591cb5 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 e7fa89f1..ad72bdee 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 2d8502e7..fdeefde3 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 5a6a6b23..0cb53296 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 5705eee1..65b013ed 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 b84d478c..89afb83e 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 5f919c36..1fc31bb2 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 dd3a7fbe..8243a680 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 8a333350..b73df5e5 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 92f05df5..ca507296 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 3d5c4d90..395eb711 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 8ea04aa6..931f1401 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 5d3eec62..8d621ea4 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 6f96ce7f..6dc4a8e1 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 63a4959c..6d230071 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 aade874d..77276f01 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 6db41acc..a918d9b6 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 e1b640b5..22ba0d05 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 5213f5e4..912003ee 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 ae6f7853..0605b8f8 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 48b33f7b..0a3661c3 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 f0a22d04..64e97c1a 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 c5c4ad63..7d977b4b 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 b66a08f2..2987c3a9 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 8a535716..03f020b5 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 e49074db..79cda84b 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 8ca3d0f2..7f8bf93e 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 2b0b499e..354c2478 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 00de709b..ed125039 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 1c06ba47..48e06039 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 d0e79e40..bfab017d 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 a1e393a6..ddff632a 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 95854487..f8da1445 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 cbd50743..f7a1997a 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 f89b97c8..3186ba86 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 05dadf8a..76b3092c 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 4fec0628..9fa86fb7 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 b1b660f8..1e289348 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 f1b56dd9..b6fa1bd6 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 143fb084..ab5ef8d1 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 77b3445f..a58997c7 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 7f753200..4b8337d2 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 b75581bc..32b0c1b1 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 ef5e66b3..3919e321 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 0889ea14..d981dc51 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 24c644eb..b2d3ae44 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 dfa1bafc..b7fdd547 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 85f530cf..56a42882 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 e9425a28..e6e12240 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 490f7e8a..5d17e66b 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 467b35d5..0176847d 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 186da7b2..a40dc897 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 3edf37f0..266811c1 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 188c9bb5..e459f32d 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 6a4fee0d..73e69e69 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 36b0ce73..3b249f38 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 a5fa0ec7..84378be8 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 554e8e5c..df9d748b 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 1d85c81f..9d4a8a9d 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 8cd5b9bf..d20d09b4 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 a1a81522..5b490508 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 a9489683..7420e040 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 9ac82b8e..b5f2255e 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 9e3de822..5e1fb5fd 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 3cc8ed5c..a8fd5788 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 a51c702a..e9afa145 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 a1deac4c..3b3d016e 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 d5deb5c9..619573a9 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/213] 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 4b6bee91..2d5f0db9 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/213] 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 1cb598c0..40f1a25d 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 895b3944..f33f02a9 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 8d77f25a..506319b0 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 3f16648f..57f821e9 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 fcc04c21..d9b2db52 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 6d62b108..6b8d2a7e 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 86e4d290..1bcc6e68 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 24f92bcb..0d08bcfe 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 30abfe8b..00fc9422 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 8bde9999..d74c7a7e 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 c560e2c1..dee120b2 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 db591cb5..ef6602c8 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 ad72bdee..762bc6b2 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 fdeefde3..19d51e5c 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 395eb711..d05f0b15 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 8d621ea4..214fc6a2 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 6dc4a8e1..054919f2 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 6d230071..d450d72f 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 77276f01..8db99956 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 a918d9b6..bb716ce5 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 22ba0d05..9bcb241b 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 912003ee..30a63715 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 0605b8f8..9917670c 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 0a3661c3..12ab83e3 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 64e97c1a..5e6693d6 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 2987c3a9..364a8604 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 79cda84b..e9725138 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 7f8bf93e..7e0adb64 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 354c2478..0bee5cc5 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 f8da1445..5c8997a4 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 f7a1997a..8c2eecb3 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 3186ba86..b36396fb 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 76b3092c..df31db85 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 9fa86fb7..b11967e9 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 1e289348..b78365c3 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 b6fa1bd6..cf333630 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 ab5ef8d1..25108600 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 a58997c7..40cdd6e4 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 4b8337d2..52fa5614 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 32b0c1b1..1cb2eff7 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 3919e321..8bc2bd35 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 d981dc51..71697435 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 b2d3ae44..78030779 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 b7fdd547..c5fc81c8 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 56a42882..0e102e92 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 e6e12240..0590a0ba 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 a40dc897..b00c2bf5 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 266811c1..299d79f0 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 e459f32d..8d95a69a 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 73e69e69..5cd1d2ae 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 3b249f38..0fa34d65 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 84378be8..e1ca50c8 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 df9d748b..694ceec9 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 9d4a8a9d..24f3a00c 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 d20d09b4..6a167fe0 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 5b490508..a9d9be01 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 7420e040..f6c16069 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 b5f2255e..25ab353e 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 5e1fb5fd..ab7e0207 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 a8fd5788..aedc1309 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 e9afa145..e395588e 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 3b3d016e..0ef025d8 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/213] 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 40f1a25d..983d0541 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 f33f02a9..e33a8cb1 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 506319b0..103b790b 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 57f821e9..265ab76d 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 d9b2db52..c366a94a 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 6b8d2a7e..6902f839 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 1bcc6e68..e1cae31f 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 0d08bcfe..af1e25bf 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 00fc9422..9a0fee13 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 d74c7a7e..649794ce 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 dee120b2..2f656b11 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 ef6602c8..3dddcd87 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 762bc6b2..187a30eb 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 19d51e5c..549c4a2b 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 0cb53296..5a6a6b23 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 65b013ed..5705eee1 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 89afb83e..b84d478c 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 1fc31bb2..5f919c36 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 8243a680..dd3a7fbe 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 b73df5e5..8a333350 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 ca507296..92f05df5 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 d05f0b15..b4bbbbdf 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 931f1401..8ea04aa6 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 214fc6a2..acf540d2 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 054919f2..6cd85a7b 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 d450d72f..a4c54c15 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 8db99956..61766cfe 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 bb716ce5..64204002 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 9bcb241b..220fea9d 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 30a63715..01ba1da8 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 9917670c..fcae60e5 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 12ab83e3..997149da 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 5e6693d6..b23c5a49 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 7d977b4b..c5c4ad63 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 364a8604..7a580880 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 03f020b5..8a535716 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 e9725138..3e7988c6 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 7e0adb64..e2f624dd 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 0bee5cc5..dccb7c8a 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 ed125039..00de709b 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 48e06039..1c06ba47 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 bfab017d..d0e79e40 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 ddff632a..a1e393a6 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 5c8997a4..2f654e1d 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 8c2eecb3..9794da83 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 b36396fb..069c4b3c 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 df31db85..57012378 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 b11967e9..bb118964 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 b78365c3..e2939248 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 cf333630..f0adedbe 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 25108600..0242bd84 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 40cdd6e4..834ad88a 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 52fa5614..ca4fc457 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 1cb2eff7..1534426d 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 8bc2bd35..3ee8d746 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 71697435..3c72f533 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 78030779..2cbfe3e0 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 c5fc81c8..8f42e663 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 0e102e92..05e2f4bb 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 0590a0ba..ca66a4ec 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 5d17e66b..490f7e8a 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 0176847d..467b35d5 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 b00c2bf5..777f9bc9 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 299d79f0..af928ae4 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 8d95a69a..817473e5 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 5cd1d2ae..2bdc55ac 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 0fa34d65..2e1962b9 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 e1ca50c8..b53917f3 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 694ceec9..5dc34090 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 24f3a00c..8ed1a89c 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 6a167fe0..a76dbf45 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 a9d9be01..b5121cc7 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 f6c16069..7044c7aa 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 25ab353e..e84acbef 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 ab7e0207..27b7403e 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 aedc1309..d585f309 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 e395588e..9ddac01d 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 0ef025d8..bf09b47b 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 619573a9..d5deb5c9 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/213] 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 73ef267e..5302b5f8 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/213] 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 983d0541..cb3a6ea8 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 e33a8cb1..2d145f3f 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 103b790b..ac95b40b 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 265ab76d..22b221a4 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 c366a94a..e783e3e1 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 6902f839..4f3cbd63 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 e1cae31f..4c8d2965 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 af1e25bf..5af2ab77 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 9a0fee13..4b88ad5e 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 649794ce..7ebf1d49 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 2f656b11..989d3912 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 3dddcd87..3356f122 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 187a30eb..4be02735 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 549c4a2b..75b3370d 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 b4bbbbdf..8780c559 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 acf540d2..9e869698 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 6cd85a7b..f8d4dc4e 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 a4c54c15..c0eb0551 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 61766cfe..05a22b0e 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 64204002..9338af5c 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 220fea9d..c1da3c7f 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 01ba1da8..f7028e63 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 fcae60e5..a4a6e753 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 997149da..08df27f8 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 b23c5a49..630c4557 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 7a580880..7e1b25f1 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 3e7988c6..bdb5eec7 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 e2f624dd..eed957e5 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 dccb7c8a..a9a5d70a 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 2f654e1d..0286eaca 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 9794da83..fd3f585c 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 069c4b3c..68f7aea6 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 57012378..1e11bfed 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 bb118964..99d237be 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 e2939248..7dd3535c 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 f0adedbe..97e1d86e 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 0242bd84..cdcf5f27 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 834ad88a..b3a65ad4 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 ca4fc457..caba8dce 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 1534426d..ea58299f 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 3ee8d746..eb7144bf 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 3c72f533..2e3ed380 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 2cbfe3e0..7d005b9e 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 8f42e663..f168bf8d 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 05e2f4bb..4284c60a 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 ca66a4ec..739e33b1 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 777f9bc9..3c19b84d 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 af928ae4..bd5301b5 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 817473e5..51ea9a19 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 2bdc55ac..87696af3 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 2e1962b9..775789e1 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 b53917f3..6d5c1bd1 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 5dc34090..2f8592bb 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 8ed1a89c..a8714b3d 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 a76dbf45..886a1925 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 b5121cc7..2e247147 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 7044c7aa..1c778e2c 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 e84acbef..a2a0cde8 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 27b7403e..04df2591 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 d585f309..1c0d08db 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 9ddac01d..e5583c1a 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 bf09b47b..8613ef68 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/213] 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 1d65fc9a..5feafed6 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/213] 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 5feafed6..b0385100 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/213] 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 cb3a6ea8..64b7cf53 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 2d145f3f..61eafdcc 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 ac95b40b..8e5d846b 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 22b221a4..7c8e0ea1 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 e783e3e1..be8fbb3f 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 4f3cbd63..20a35956 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 4c8d2965..cff78cef 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 5af2ab77..e8f14d46 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 4b88ad5e..21871a69 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 7ebf1d49..cf4fcb86 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 989d3912..e2648b4c 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 3356f122..040f8bc7 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 4be02735..8f47b436 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 75b3370d..32c3ba59 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 5a6a6b23..27b5cda0 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 5705eee1..cc1cdc89 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 b84d478c..95f13b6b 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 5f919c36..74ab1232 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 dd3a7fbe..47533215 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 8a333350..94c742b1 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 92f05df5..89ed40f7 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 8780c559..3af47f2f 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 8ea04aa6..dd1c409a 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 9e869698..55d7b289 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 f8d4dc4e..dbe668d2 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 c0eb0551..7312d172 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 05a22b0e..f9e1ae55 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 9338af5c..aac19e20 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 c1da3c7f..fa3bfe62 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 f7028e63..bd8dafe6 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 a4a6e753..613c0cb4 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 08df27f8..992a2a82 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 630c4557..0c6795b0 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 c5c4ad63..83b601fb 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 7e1b25f1..ea02c3db 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 8a535716..0792a2f9 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 bdb5eec7..82dd5a41 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 eed957e5..610f93d2 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 a9a5d70a..e6feb117 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 00de709b..ca23f097 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 1c06ba47..ea296301 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 d0e79e40..4c8f0ba2 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 a1e393a6..69fb8abb 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 0286eaca..a2fcb370 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 fd3f585c..0ff1295c 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 68f7aea6..919726df 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 1e11bfed..6fbc71b8 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 99d237be..1c54b334 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 7dd3535c..5700f752 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 97e1d86e..33763901 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 cdcf5f27..ab72399e 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 b3a65ad4..01bb6825 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 caba8dce..6ab820dd 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 ea58299f..8f57ca67 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 eb7144bf..fa858f60 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 2e3ed380..85659172 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 7d005b9e..fd61a735 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 f168bf8d..9a38e83c 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 4284c60a..2da2a5f8 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 739e33b1..5528dd9e 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 490f7e8a..40cdbec0 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 467b35d5..0a8e4f42 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 3c19b84d..25d0a289 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 bd5301b5..b297e03b 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 51ea9a19..0e4072c7 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 87696af3..ae0a623a 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 775789e1..20f26b19 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 6d5c1bd1..04482654 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 2f8592bb..d1a3e342 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 a8714b3d..0d01afed 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 886a1925..1e8d19f9 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 2e247147..32e8a585 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 1c778e2c..345e7edf 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 a2a0cde8..ba49e346 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 04df2591..c8c2d224 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 1c0d08db..029a3bfd 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 e5583c1a..372bdd30 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 8613ef68..0b3266fb 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 d5deb5c9..06e73451 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/213] 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 b0385100..8b3ef2d1 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/213] 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 64b7cf53..d280444f 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 61eafdcc..2cc9f602 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 8e5d846b..e4b00a26 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 7c8e0ea1..e7614ea6 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 be8fbb3f..b75ca142 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 20a35956..26990634 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 cff78cef..80ce5480 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 e8f14d46..f7ee73c9 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 21871a69..893f332d 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 cf4fcb86..a03363f2 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 e2648b4c..5e4d7fd5 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 040f8bc7..78f717d8 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 8f47b436..2836e6c0 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 32c3ba59..a0317d2f 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 27b5cda0..ed011b84 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 cc1cdc89..7d79694f 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 95f13b6b..a8f52343 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 74ab1232..f754ff66 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 47533215..ff43764b 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 94c742b1..28489b42 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 89ed40f7..3e2eb3bc 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 3af47f2f..9c06b62f 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 dd1c409a..86f7acef 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 55d7b289..0c7d4515 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 dbe668d2..faab439d 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 7312d172..d5bb5f40 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 f9e1ae55..801c08d5 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 aac19e20..054e53f4 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 fa3bfe62..0740c2a6 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 bd8dafe6..5adddb82 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 613c0cb4..a1fbaf15 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 992a2a82..6fb9a910 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 0c6795b0..c83996f1 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 83b601fb..e67a8abe 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 ea02c3db..007c9bec 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 0792a2f9..583a2532 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 82dd5a41..c8418281 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 610f93d2..00064209 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 e6feb117..4e2866bc 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 ca23f097..f160a5fd 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 ea296301..8d1166c1 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 4c8f0ba2..e85c3aba 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 69fb8abb..c6ef24d6 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 a2fcb370..4a76e9bf 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 0ff1295c..834cec24 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 919726df..0d93d589 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 6fbc71b8..13dd99c4 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 1c54b334..0ee93ebd 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 5700f752..acf0ee0f 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 33763901..ed07f77c 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 ab72399e..07e778ab 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 01bb6825..2749a96e 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 6ab820dd..6b64d3d2 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 8f57ca67..102f9e1e 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 fa858f60..dddd3faf 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 85659172..2b7c2af5 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 fd61a735..362676b3 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 9a38e83c..5a88879c 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 2da2a5f8..82dbc09d 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 5528dd9e..b7b4d24a 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 40cdbec0..11b27a62 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 0a8e4f42..66a10e44 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 25d0a289..3e56936f 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 b297e03b..52ed3a60 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 0e4072c7..07eda4a0 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 ae0a623a..2f56d236 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 20f26b19..e914ebc3 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 04482654..ee922cf7 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 d1a3e342..8ca8fb9d 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 0d01afed..7e8901f8 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 1e8d19f9..e5af4532 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 32e8a585..c7fea2e7 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 345e7edf..68bd99c0 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 ba49e346..2b9f6c65 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 c8c2d224..ed32673e 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 029a3bfd..fc84f52b 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 372bdd30..66327046 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 0b3266fb..0d859045 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 06e73451..742e986f 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/213] 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 b6da756f..0ebf2e09 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/213] 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 4b9238aa..94caa45c 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/213] 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 937adb7e..840dcc6c 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 00000000..34a356bf --- /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/213] 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 6b56272d..e0b72de2 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/213] 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 94caa45c..59ffc89a 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/213] 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 b6244626..78c99bd4 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/213] 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 8b3ef2d1..114b48fb 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/213] 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 d280444f..2805c6a6 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 2cc9f602..73fe16bf 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 e4b00a26..01e436a1 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 e7614ea6..bbd65b0d 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 b75ca142..f151a3ac 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 26990634..d417a68c 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 80ce5480..fc98593d 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 f7ee73c9..1c39f142 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 893f332d..9d00c4d6 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 a03363f2..1e44ed30 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 5e4d7fd5..1a4e1971 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 78f717d8..45809e06 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 2836e6c0..283af829 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 a0317d2f..02e3e0ad 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 ed011b84..613b48bb 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 7d79694f..4802c7db 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 a8f52343..3406a556 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 f754ff66..3ad65d74 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 ff43764b..9843a330 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 28489b42..45a7dd81 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 3e2eb3bc..da97c97b 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 9c06b62f..4c96237a 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 86f7acef..33b24376 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 0c7d4515..3503d3f8 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 faab439d..7508d01f 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 d5bb5f40..4f1dfa2e 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 801c08d5..97a2230c 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 054e53f4..460818a8 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 0740c2a6..3751d076 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 5adddb82..99595aed 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 a1fbaf15..01963fad 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 6fb9a910..79acfe5c 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 c83996f1..d6505814 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 e67a8abe..246d70a5 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 007c9bec..119aba34 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 583a2532..fff46237 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 c8418281..1e68cbf7 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 00064209..4b18eb83 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 4e2866bc..0cbbdae6 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 f160a5fd..a1312416 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 8d1166c1..d609d8c6 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 e85c3aba..f7bcc697 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 c6ef24d6..1686ede5 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 4a76e9bf..a387eca7 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 834cec24..b8148a39 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 0d93d589..4f20ffba 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 13dd99c4..dd5f15a7 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 0ee93ebd..3995967e 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 acf0ee0f..3f8f59de 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 ed07f77c..e96d7a98 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 07e778ab..83049a22 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 2749a96e..2ae7c7eb 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 6b64d3d2..24913deb 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 102f9e1e..d447f1fb 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 dddd3faf..23648c32 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 2b7c2af5..2f170b59 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 362676b3..e5c879c7 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 5a88879c..ba966610 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 82dbc09d..4433ae30 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 b7b4d24a..6ef3cc76 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 11b27a62..85c39761 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 66a10e44..27a3e90f 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 3e56936f..0e37698a 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 52ed3a60..4bfc5101 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 07eda4a0..27be89a3 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 2f56d236..cffd2486 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 e914ebc3..bf4463b8 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 ee922cf7..3b93f089 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 8ca8fb9d..14042b57 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 7e8901f8..0fbd5c84 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 e5af4532..c84ae5e2 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 c7fea2e7..3f158dcd 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 68bd99c0..d7b06f57 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 2b9f6c65..37a235e8 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 ed32673e..8e93e510 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 fc84f52b..49b3bcce 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 66327046..fb35b5b9 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 0d859045..731f6f2a 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 742e986f..2d9bc7c8 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/213] 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 e0b72de2..2a1e054b 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/213] 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 59ffc89a..94caa45c 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/213] 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 78c99bd4..b6244626 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/213] 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 34a356bf..7025eafb 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/213] 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 94caa45c..59ffc89a 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/213] 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 2a1e054b..e0b72de2 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/213] 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 b6244626..78c99bd4 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/213] 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 30f63b76..3454a578 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/213] 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 7025eafb..76d5a7a2 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 13a4b941..1ef12037 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 b1954885..8deaac94 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 6fa06bd0..fe8eb958 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 613b48bb..1be4bf40 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 3406a556..120e8454 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 fa477d1e..2116671f 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 f7349e94..f2b05947 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 58d18d48..c519dd38 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 31c155a0..7fec267f 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 a387eca7..f7b0ac96 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 b8148a39..d42f9280 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 3995967e..a6f6e4b8 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 3f8f59de..3b63ba2a 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 83049a22..c441c4ed 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 338fdc51..ecd8c47b 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 ba966610..2e62d19d 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 4433ae30..d35a700b 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 0655fc02..fbdadc91 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 36127ebf..9e3b30fd 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/213] 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 3454a578..6ec8ce22 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/213] 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 76d5a7a2..eea46577 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 1ef12037..94313bcb 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 8deaac94..54faeaf8 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 fe8eb958..8886dd0a 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 1be4bf40..eaa99ed2 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 120e8454..5aa061fb 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 2116671f..c6007855 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 f2b05947..61f359f4 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 c519dd38..e0b1926b 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 7fec267f..b9cdd597 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 f7b0ac96..eec91354 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 d42f9280..0a6e669d 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 a6f6e4b8..f9abc770 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 3b63ba2a..7d837670 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 c441c4ed..a8b048a1 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 ecd8c47b..77e40cdf 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 2e62d19d..259e669c 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 d35a700b..b7badbc7 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 fbdadc91..a28afc51 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 9e3b30fd..72aa9d2e 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/213] 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 6ec8ce22..6c3824fd 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/213] 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 6c3824fd..d1d4f6f5 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/213] 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 eea46577..82bf5847 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 94313bcb..0d294fe2 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 54faeaf8..d5877483 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 8886dd0a..5d709373 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 eaa99ed2..c63a614f 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 5aa061fb..266f640b 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 c6007855..198a881d 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 61f359f4..ff24179d 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 e0b1926b..a993b0ba 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 b9cdd597..39ca1453 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 eec91354..79dd0acf 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 0a6e669d..db43a72a 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 f9abc770..b9e52c49 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 7d837670..7c10bfc3 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 a8b048a1..b485fd04 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 77e40cdf..4a31b3c8 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 259e669c..3186c911 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 b7badbc7..1b33b6a9 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 a28afc51..14e52dc5 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 72aa9d2e..09e9f8be 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/213] 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 d1d4f6f5..d63cf16d 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/213] 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 82bf5847..72a062ee 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 0d294fe2..090d9a8c 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 d5877483..895880e1 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 5d709373..13443a4d 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 c63a614f..bf9fc4ee 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 266f640b..b45ab073 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 198a881d..b1c4a743 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 ff24179d..667b5a26 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 a993b0ba..66db31a1 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 39ca1453..6dce5854 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 79dd0acf..238112a7 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 db43a72a..c7c23e9c 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 b9e52c49..ddc7ed11 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 7c10bfc3..74e34e0b 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 b485fd04..9eb7f25c 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 4a31b3c8..73cb5376 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 3186c911..7a8b4ba4 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 1b33b6a9..47eca14f 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 14e52dc5..9f3a6b6e 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 09e9f8be..a285ebaa 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/213] 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 d63cf16d..b2a85fb4 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/213] 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 72a062ee..7d99377c 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 090d9a8c..64c16074 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 895880e1..cc34468c 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 13443a4d..31838b4e 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 bf9fc4ee..10735bf3 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 b45ab073..60d0f39f 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 b1c4a743..b5c1f6d5 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 667b5a26..877caa6f 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 66db31a1..c7142612 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 6dce5854..9a02b0a1 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 238112a7..5071a7bd 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 c7c23e9c..d8a0dcda 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 ddc7ed11..83f86712 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 74e34e0b..477d4227 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 9eb7f25c..ff2c5471 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 73cb5376..09f3cd0c 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 7a8b4ba4..fd1f54f5 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 47eca14f..7aa6e5e4 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 9f3a6b6e..616e94d0 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 a285ebaa..bdce4d04 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/213] 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 b2a85fb4..626e0a4f 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/213] 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 7d99377c..a8747f5d 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 64c16074..d9cf4c00 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 cc34468c..85c5bc9a 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 10735bf3..d8d2dfaa 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 60d0f39f..9a8f8693 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 877caa6f..300b9829 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 c7142612..3708b283 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 9a02b0a1..eff28499 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 5071a7bd..287d603f 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 d8a0dcda..9213f0c9 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 83f86712..4c67e0ba 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 477d4227..c217bf92 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 ff2c5471..2579b590 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 fd1f54f5..c11d9c17 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 7aa6e5e4..07bd998c 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/213] 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 626e0a4f..e111737e 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/213] 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 a8747f5d..64ebd523 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 d9cf4c00..17957638 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 85c5bc9a..25191070 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 31838b4e..b872216f 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 d8d2dfaa..de4fc117 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 9a8f8693..6279bb4c 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 b5c1f6d5..2a8d18e6 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 300b9829..262f7027 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 3708b283..172a87ad 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 eff28499..5b3838e5 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 287d603f..1f790053 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 9213f0c9..09f1e508 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 4c67e0ba..4bf88428 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 c217bf92..df095680 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 2579b590..425ee1b5 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 09f3cd0c..1ec6f31f 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 c11d9c17..8d07eb3c 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 07bd998c..906c65ac 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 616e94d0..0af69a43 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 bdce4d04..1d19d4a6 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/213] 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 7db38f98..6f1830f4 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/213] 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 64ebd523..9d3443e9 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 17957638..18622cfe 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 25191070..9c0a95be 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 b872216f..7c0ab28b 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 2a8d18e6..b4582b50 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 262f7027..07bd9252 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 172a87ad..76363c7a 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 5b3838e5..c51465fb 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 1ec6f31f..3b91fd5a 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 1d19d4a6..a6fddf7c 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/213] 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 4b59f007..7e985636 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/213] 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 92689d8b..b254d940 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/213] 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 6f1830f4..eb61cb83 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/213] 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 07866a38..aa3ab81a 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/213] 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 9c0a95be..fc356ae2 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 b4582b50..88fa9d5f 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 c51465fb..4ec5f614 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/213] 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 e111737e..e0adbb77 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/213] 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 eb61cb83..fe95305b 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/213] 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 b254d940..c9f0e447 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/213] 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 fe95305b..d0b792b1 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/213] 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 9d3443e9..40188cd8 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 18622cfe..14809d1a 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 fc356ae2..8757efe5 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 7c0ab28b..7b47fd1a 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 de4fc117..1d6e94f7 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 6279bb4c..75064e51 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 88fa9d5f..07f4cba9 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 07bd9252..1ca2d4c9 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 76363c7a..5673fe37 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 4ec5f614..1f9b3c63 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 1f790053..ce1a466b 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 09f1e508..ac14fa6c 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 4bf88428..af646f7a 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 df095680..054eba73 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 425ee1b5..7be57f83 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 3b91fd5a..37470849 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 8d07eb3c..5a9e43c0 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 906c65ac..5d208873 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 0af69a43..63204399 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 a6fddf7c..31e39601 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/213] 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 d0b792b1..174e0f61 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/213] 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 7e985636..c33659d3 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/213] 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 40188cd8..13c38432 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 14809d1a..38bab56c 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 8757efe5..5e022672 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 7b47fd1a..daca51fd 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 07f4cba9..35aa200e 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 1ca2d4c9..3f24361a 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 5673fe37..2263d087 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 1f9b3c63..dcfc37b1 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 37470849..e806d3a3 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 31e39601..bee34022 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/213] 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 e0adbb77..3bbbe185 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/213] 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 13c38432..e5f9f27c 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 38bab56c..1d55cfa6 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 5e022672..1edb2988 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 1d6e94f7..706371cc 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 75064e51..f537d9c9 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 35aa200e..75a3d518 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 3f24361a..0f6fbc3b 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 2263d087..bcc854d4 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 dcfc37b1..f5285ca5 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 ce1a466b..ceee6f5f 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 ac14fa6c..c513204f 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 af646f7a..9240b7a4 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 054eba73..73cdd0c4 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 7be57f83..34e54364 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 5a9e43c0..0e6e60c7 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 5d208873..b6618359 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/213] 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 f9aebf9b..e6634422 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/213] 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 e5f9f27c..705d16cf 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 1d55cfa6..a0fcf0a5 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 1edb2988..020e2600 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 daca51fd..561e5c9c 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 903e4e93..07f9962c 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 75a3d518..218c0310 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 0f6fbc3b..02914b0d 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 bcc854d4..d9cd8fc6 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 f5285ca5..ad479234 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 0e26ab5a..a30fed7e 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 fca49b1b..ee64d862 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 e806d3a3..b5e6c1bc 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 51f7e82e..768c0f02 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 63204399..bc8520aa 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 bee34022..286fcf4b 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/213] 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 c9f0e447..4a537daf 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/213] 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 c33659d3..3f0eb04f 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/213] 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 aa3ab81a..e056c82c 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/213] 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 174e0f61..c80b64d7 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/213] 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 705d16cf..b8472d13 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 a0fcf0a5..a6d76bb9 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 020e2600..030ba4fc 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 561e5c9c..3c308706 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 218c0310..43917f4c 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 02914b0d..27f66884 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 d9cd8fc6..c196f207 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 ad479234..6be3c5f0 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 b5e6c1bc..117f224d 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 286fcf4b..c194da9b 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/213] 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 e6634422..5191bd33 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/213] 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 3bbbe185..445acc79 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/213] 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 c80b64d7..174e0f61 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/213] 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 e056c82c..7c392d42 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/213] 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 3f0eb04f..c33659d3 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/213] 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 4a537daf..c9f0e447 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/213] 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 b8472d13..705d16cf 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 a6d76bb9..ab7a78ee 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 030ba4fc..666df780 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 3c308706..3b981c22 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 07f9962c..83917ca8 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 43917f4c..d2daf32f 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 27f66884..4257bbb4 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 c196f207..0394e94d 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 6be3c5f0..fe2c2034 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 a30fed7e..78973f68 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 ee64d862..4c70a788 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 117f224d..89f54058 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 768c0f02..b8081887 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 bc8520aa..ed7a516d 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 c194da9b..1ebda48b 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/213] 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 445acc79..1713967a 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/213] 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 ab7a78ee..1eb1a45b 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 666df780..15a3e0ee 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 3b981c22..e015419e 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 d2daf32f..288fc36c 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 4257bbb4..39f7fddc 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 0394e94d..cf4c37a4 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 fe2c2034..3f581f8e 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 89f54058..8d055c4f 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/213] 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 1713967a..47c0596b 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/213] 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 47c0596b..8672632a 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/213] 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 705d16cf..d46b76c5 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 1eb1a45b..68ff3ed5 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 15a3e0ee..56f6073b 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 e015419e..d260a46e 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 706371cc..1e451991 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 f537d9c9..c072306d 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 288fc36c..568f596e 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 39f7fddc..6d8ddba9 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 cf4c37a4..d4270a21 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 3f581f8e..fab668a8 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 ceee6f5f..766efbc2 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 c513204f..9714724f 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 9240b7a4..53d61b15 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 73cdd0c4..38369cc1 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 34e54364..f232c9ee 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 8d055c4f..7017669b 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 0e6e60c7..50d13442 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 b6618359..cb0edbf8 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/213] 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 5191bd33..c254e58e 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/213] 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 d46b76c5..2c65b83f 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 68ff3ed5..a90a8ddc 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 56f6073b..b2b29c00 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 d260a46e..0d33935b 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 568f596e..3e801f7c 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 6d8ddba9..b5d13979 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 d4270a21..0337309b 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 fab668a8..e397afee 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 1ebda48b..3c063e66 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/213] 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 c254e58e..95de0569 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/213] 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 2c65b83f..f32e777d 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 a90a8ddc..1ae42932 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 b2b29c00..3627ab6e 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 0d33935b..a023fab4 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 83917ca8..3025b964 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 3e801f7c..9163cd40 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 b5d13979..b593ec10 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 0337309b..47628b3a 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 e397afee..149be239 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 78973f68..64cb3a1c 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 4c70a788..2d089bbe 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 7017669b..1a917626 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 b8081887..37f52ca4 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 ed7a516d..b394b311 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 3c063e66..2ca9b2e1 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/213] 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 95de0569..201a4483 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/213] 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 201a4483..fae06ef1 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/213] 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 f32e777d..03bf3016 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 1ae42932..aebae40d 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 3627ab6e..79284e6f 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 a023fab4..78dfa7ee 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 3025b964..dd72c780 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 9163cd40..ecb4c02a 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 b593ec10..1ecb83a0 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 47628b3a..d503f7f8 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 149be239..a6ab3f93 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 64cb3a1c..a35db54d 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 2d089bbe..94a7da66 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 1a917626..44f48982 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 37f52ca4..83bc7ed0 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 b394b311..ac78b5e1 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 2ca9b2e1..3369e99a 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/213] 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 8672632a..5c90a211 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/213] 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 03bf3016..745c03c2 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 aebae40d..b301bfad 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 79284e6f..0a067e22 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 78dfa7ee..6e11e5c6 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 1e451991..1092107a 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 c072306d..906e60cb 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 ecb4c02a..6a7d52e3 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 1ecb83a0..ed64f381 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 d503f7f8..fe55c6ab 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 a6ab3f93..f28f1a37 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 766efbc2..46966311 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 9714724f..68be39a3 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 53d61b15..baed8e05 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 38369cc1..70b1ca9d 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 f232c9ee..970e6b0d 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 44f48982..7ca952ed 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 50d13442..18361595 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 cb0edbf8..fede2d54 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 ac78b5e1..2ebf52b0 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 3369e99a..456eb306 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/213] 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 fae06ef1..5caf4ba1 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/213] 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 745c03c2..59d1ca7c 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 b301bfad..9651f953 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 0a067e22..41d10b47 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 6e11e5c6..a5d1d48b 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 6a7d52e3..76a84dbd 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 ed64f381..f9d8ee99 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 fe55c6ab..48ab99dc 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 f28f1a37..b02c24f6 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 456eb306..0417600a 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/213] 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 5caf4ba1..17b55f94 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/213] 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 59d1ca7c..a44fb792 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 9651f953..f2cbef02 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 41d10b47..a70ef34e 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 a5d1d48b..fe990c24 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 dd72c780..041564aa 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 76a84dbd..5273e198 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 f9d8ee99..ab63fe1f 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 48ab99dc..ed252918 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 b02c24f6..37c9d298 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 a35db54d..4f2e3d8b 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 94a7da66..d32978ee 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 7ca952ed..f6bd29d3 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 83bc7ed0..87837884 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 2ebf52b0..10661348 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 0417600a..1368d6aa 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/213] 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 5c90a211..1df56cb1 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/213] 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 a44fb792..efff6519 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 f2cbef02..d5a4f8a9 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 a70ef34e..85a7e980 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 fe990c24..340c8aa9 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 1092107a..94f1c314 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 906e60cb..e458f4da 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 5273e198..e0ed7c13 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 ab63fe1f..4ca8afde 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 ed252918..278c7be6 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 37c9d298..e218d5bd 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 46966311..5cc820a7 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 68be39a3..924cb22c 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 baed8e05..adc78f22 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 70b1ca9d..93a06440 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 970e6b0d..5f9551b3 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 f6bd29d3..0d69508b 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 18361595..eb624553 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 fede2d54..f4ffbb0c 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 10661348..06b95b7a 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 1368d6aa..cae5b230 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/213] 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 17b55f94..d90e3ae9 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/213] 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 efff6519..aed29ea9 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 d5a4f8a9..cd13a5ef 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 85a7e980..c4e76b22 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 340c8aa9..eda889bc 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 e0ed7c13..3ce9e24c 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 4ca8afde..cb8ee428 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 278c7be6..56c4cbd3 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 e218d5bd..45bea0bb 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 cae5b230..a32cade2 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/213] 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 d3249a69..e2254f78 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/213] 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 aed29ea9..7624bfc5 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 c4e76b22..3c3c9de5 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 cb8ee428..ffc582ca 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 56c4cbd3..18d757a1 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/213] 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 1df56cb1..8981ea03 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/213] 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 cd13a5ef..030e88a6 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 3c3c9de5..bbc23f21 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 eda889bc..ad48292b 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 3ce9e24c..c16e0d5e 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 45bea0bb..8a050f9e 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 0d69508b..50b05657 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/213] 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 8981ea03..739db4dd 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/213] 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 030e88a6..a560caec 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 bbc23f21..fe87f820 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 ad48292b..da5f3b60 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 c16e0d5e..59324f77 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 8a050f9e..c33b9a4b 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 50b05657..7849aa3c 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/213] 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 23df0a34..f1b91f3c 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 36f82ac5..53de2921 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/213] 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 3ec2d7e1..7e5295b0 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 452147c2..400f4440 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 f1b91f3c..3d71edc5 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 00000000..b5df183d --- /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 53de2921..defdc40f 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/213] 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 7e5295b0..0468b283 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/213] 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 75faae13..dc98e3a6 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 af1e25bf..c2666512 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 5705eee1..b827a37e 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 6cd85a7b..645e2a73 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 6137a24e..377ce55e 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 f0adedbe..64581fa2 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/213] 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 defdc40f..523a82c5 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 d3249a69..71c0b75c 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/213] 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 71c0b75c..799e80a5 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/213] 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 c2666512..067bc8d2 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 b827a37e..fa027033 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 645e2a73..7e8107d4 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 377ce55e..2b7d017b 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 64581fa2..0c7a772f 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/213] 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 6f432d75..b0095f73 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 b5df183d..b055f368 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 07866a38..d5b650ff 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 4b59f007..16d7c4c4 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/213] 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 3d71edc5..70d7556b 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/213] 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 8a333350..4946e882 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 b4bbbbdf..9380e50c 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 8ea04aa6..5847cfc2 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 acf540d2..083fb93b 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 7e8107d4..bfa17406 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 2b7d017b..0459ac6c 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 b23c5a49..d0465e7d 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 dccb7c8a..c4a2ef58 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 0c7a772f..abcd7414 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 5ceb9216..8e4f44cc 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 f1e05acf..9dc658f9 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 a76dbf45..9530bc55 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 7044c7aa..1cd65237 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 d5deb5c9..fb408530 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/213] 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 e5aa0454..c1029de3 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 f9fb4a3b..dea604ca 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 6366129c..cf513acb 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 306e003c..a95de75b 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 53776fed..ea1783d6 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 26352db4..e3d10f32 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 9e7b00e6..4685f4fb 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 5b9bbc1d..d4e5ed6e 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 8605939d..60c7c516 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 d3cf834a..ed3b3520 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 27b92fdc..ba238a3f 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 8c1fafb0..14c494f1 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 d272a3a2..6ebafb25 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 5b1ce667..afae2ac5 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/213] 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 c9f0e447..a6503456 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/213] 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 7624bfc5..b376233c 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 a560caec..77a8b918 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 fe87f820..a1b0f6ad 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 da5f3b60..97d56291 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 59324f77..6ba69825 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 ffc582ca..c437aee9 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 18d757a1..783c7be2 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 c33b9a4b..82957056 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 7849aa3c..b077aa80 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 a32cade2..16030d73 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/213] 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 a6503456..7b4fc98e 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/213] 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 b376233c..606f4c1d 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 77a8b918..98100322 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 a1b0f6ad..e1541884 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 97d56291..8c744092 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 6ba69825..b862c7c3 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 c437aee9..da9756f6 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 783c7be2..ee4a9252 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 82957056..91d6606a 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 b077aa80..c4fb759e 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 16030d73..c945ba56 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/213] 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 739db4dd..f45b194a 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/213] 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 606f4c1d..dc8ef000 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 98100322..2d732598 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 e1541884..1401f114 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 8c744092..d77477b5 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 94f1c314..1be5ee6e 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 e458f4da..c4f6e25e 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 b862c7c3..54392a09 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 da9756f6..6cc015d5 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 ee4a9252..249885e9 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 91d6606a..ba2a14d5 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 5cc820a7..59cbabdf 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 924cb22c..1788a19f 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 adc78f22..e4b95be4 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 93a06440..f37295dc 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 5f9551b3..19155b36 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 c4fb759e..828bd471 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 ed3b3520..a9c66fdb 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 ba238a3f..2329dae7 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 06b95b7a..a5dbbb53 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 c945ba56..5c610759 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/213] 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 f45b194a..5f1c9763 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/213] 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 5f1c9763..c3358393 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/213] 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 dc8ef000..34b4ad93 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 2d732598..3dc21555 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 1401f114..aa839df1 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 d77477b5..14f109cf 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 1be5ee6e..8dce24fc 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 c4f6e25e..72263217 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 54392a09..17026d49 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 6cc015d5..092f0b9e 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 249885e9..87b0c819 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 ba2a14d5..c8a86769 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 59cbabdf..dd142509 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 1788a19f..df0afe77 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 e4b95be4..453e8667 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 f37295dc..fef1b401 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 19155b36..06ecfb5b 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 828bd471..bac5f59f 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 a9c66fdb..f7fefbd8 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 2329dae7..7fe7f49d 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 a5dbbb53..9a695479 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 5c610759..6f5e3ada 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/213] 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 e5038196..4f6f525d 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/213] 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 2805c6a6..e87fd49c 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 73fe16bf..5edb74b4 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 01e436a1..0ff9aebe 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 bbd65b0d..44eb6854 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 f151a3ac..d2564609 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 d417a68c..04d9d592 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 fc98593d..f3fbf910 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 dbef4724..9d20109c 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 9d00c4d6..e45e5c12 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 1e44ed30..2b1fc243 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 1a4e1971..2ad07861 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 45809e06..1d343e4f 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 283af829..d4bff6dc 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 02e3e0ad..9731b822 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 8dce24fc..8b4408da 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 f9aa94e6..5315ecbb 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 72263217..fcc08c30 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 3ad65d74..fb49c4f9 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 9843a330..df315bba 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 c1029de3..a34e2b79 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 da97c97b..d645702e 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 dea604ca..1f940397 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 cf513acb..5f6c8642 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 a95de75b..a339cfd4 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 ea1783d6..8289b97e 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 4f1dfa2e..83e35c82 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 dfd79b79..90978409 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 460818a8..a1b059dc 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 3751d076..2d35374b 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 e3d10f32..c1e962aa 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 01963fad..cd34638f 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 79acfe5c..c9efdf0d 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 4685f4fb..cbb4eb78 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 246d70a5..a27ac1b6 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 119aba34..076f5c9e 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 fff46237..781a42fe 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 1e68cbf7..2b2916cb 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 4b18eb83..41f20e16 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 d4e5ed6e..e242e9b5 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 a1312416..7a9b7190 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 d609d8c6..ae63bab3 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 f7bcc697..ee7f6228 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 1686ede5..7ae1bdfa 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 dd142509..253a69fb 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 df0afe77..635d2037 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 4f20ffba..ecf5f0ae 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 dd5f15a7..658cd0f4 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 453e8667..e107254f 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 fef1b401..f70f1038 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 60c7c516..66507603 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 06ecfb5b..351f7d61 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 2ae7c7eb..eb04366f 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 24913deb..9f790578 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 d447f1fb..733ee11a 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 23648c32..ed7bf659 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 2f170b59..fec4f46a 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 e5c879c7..de6dc175 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 f7fefbd8..23c1cdad 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 7fe7f49d..676eae62 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 6ef3cc76..de36009f 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 85c39761..e0fe6559 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 27a3e90f..e8986e43 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 0e37698a..dffa4913 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 4bfc5101..aec01221 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 27be89a3..067b121b 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 cffd2486..7146a852 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 bf4463b8..2dbd35b8 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 3b93f089..8a8badbd 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 14042b57..d6fc9bd9 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 0fbd5c84..22236e80 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 14c494f1..411a144e 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 3f158dcd..98fd6eb1 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 6ebafb25..0582e377 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 37a235e8..30cb8d4f 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 8e93e510..09f0d351 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 49b3bcce..641a94e9 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 fb35b5b9..3608519c 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 731f6f2a..d1cbf4f1 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 afae2ac5..1190756f 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/213] 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 4f6f525d..57066b3b 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/213] 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 e87fd49c..c38877bd 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 5edb74b4..bb5b26a3 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 0ff9aebe..7742d29e 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 44eb6854..7af061bf 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 d2564609..6557c248 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 04d9d592..e93b5f62 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 f3fbf910..1093dceb 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 9d20109c..a3da7018 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 e45e5c12..b45fc59f 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 2b1fc243..e3d7cbfc 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 2ad07861..0dfb706a 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 1d343e4f..1e07dc0b 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 d4bff6dc..2eb52875 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 9731b822..bc5568ed 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 8b4408da..2cbc7462 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 5315ecbb..89250ee2 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 fcc08c30..ed33e632 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 fb49c4f9..8e0c593a 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 df315bba..54ca990e 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 a34e2b79..3c60f669 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 d645702e..4fb60778 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 1f940397..f4c59866 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 5f6c8642..6d6d64d6 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 a339cfd4..4f301e5b 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 8289b97e..9f114fc0 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 83e35c82..3075bfac 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 90978409..2cc8fa89 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 a1b059dc..ddb49e74 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 2d35374b..845acd0a 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 c1e962aa..d183d545 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 cd34638f..6ab9e02f 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 c9efdf0d..e0840b28 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 cbb4eb78..c38bb414 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 a27ac1b6..5133b835 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 076f5c9e..9aa0586d 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 781a42fe..50e5d84a 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 2b2916cb..ea0acfd6 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 41f20e16..54d80529 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 e242e9b5..8e549250 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 7a9b7190..21a34280 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 ae63bab3..534cd165 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 ee7f6228..f2b20045 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 7ae1bdfa..7cc9ce1a 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 253a69fb..b5756efc 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 635d2037..db4d828e 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 ecf5f0ae..35acb964 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 658cd0f4..0ed380cd 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 e107254f..72f8da48 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 f70f1038..638ca12a 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 66507603..9a886050 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 351f7d61..4f707dcf 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 eb04366f..198ba8b1 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 9f790578..64d9d659 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 733ee11a..bee713b4 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 ed7bf659..d2de655b 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 fec4f46a..bada31c7 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 de6dc175..2fa76584 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 23c1cdad..aa17cfa7 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 676eae62..21a6f8c0 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 de36009f..4aabd121 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 e0fe6559..2c8bc795 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 e8986e43..e936a3bb 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 dffa4913..cf721420 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 aec01221..aaa92633 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 067b121b..7902f2fd 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 7146a852..af29b2fa 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 2dbd35b8..23c3389c 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 8a8badbd..1ae0264d 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 d6fc9bd9..282a3f94 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 22236e80..fd1c9cd2 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 411a144e..f3a29198 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 98fd6eb1..aa479250 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 0582e377..141dac8c 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 30cb8d4f..5d74ea31 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 09f0d351..98bc6d8c 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 641a94e9..fbb1e1f5 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 3608519c..859d3f70 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 d1cbf4f1..3b8b9e8b 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 1190756f..210282b1 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/213] 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 57066b3b..2a6ddafa 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/213] 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 c38877bd..e7e4cfc4 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 bb5b26a3..ab407e0b 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 7742d29e..54e37c76 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 7af061bf..1d6f6b35 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 6557c248..ff68112e 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 e93b5f62..631ca076 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 1093dceb..462c5b39 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 a3da7018..27ac8ee2 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 b45fc59f..ad4becd1 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 e3d7cbfc..fd72f40d 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 0dfb706a..af1f1b63 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 1e07dc0b..000055b5 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 2eb52875..7097b79d 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 bc5568ed..38faed8f 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 2cbc7462..f390a750 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 89250ee2..ea6dde14 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 ed33e632..83c73c6b 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 8e0c593a..557ef5b3 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 54ca990e..b407d7c6 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 3c60f669..16c3ace5 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 4fb60778..a7157602 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 f4c59866..6c917826 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 6d6d64d6..4b456fe9 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 4f301e5b..fe3c83bd 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 9f114fc0..fbb964a8 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 3075bfac..83ac96fc 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 2cc8fa89..9d022fad 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 ddb49e74..a0d36eb2 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 845acd0a..a0acab3e 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 d183d545..f0ad91aa 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 6ab9e02f..59fcbfee 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 e0840b28..3adc8bf0 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 c38bb414..57f5b55e 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 5133b835..570a7166 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 9aa0586d..f91ea5ac 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 50e5d84a..8d306705 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 ea0acfd6..37562d54 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 54d80529..ac43a2f5 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 8e549250..f621a9ca 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 21a34280..30c0914e 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 534cd165..434d9425 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 f2b20045..463e5b2f 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 7cc9ce1a..14cb8497 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 b5756efc..8abdf8c6 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 db4d828e..d4510c2e 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 35acb964..63d9e0e5 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 0ed380cd..4bb5f207 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 72f8da48..140b86d1 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 638ca12a..5eb53686 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 9a886050..c196e52e 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 4f707dcf..4cbb9fb3 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 198ba8b1..c99fc476 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 64d9d659..b2437344 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 bee713b4..284131cc 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 d2de655b..65cf92ab 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 bada31c7..1ce3e838 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 2fa76584..e051a6f7 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 aa17cfa7..c89a1607 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 21a6f8c0..96f47f7a 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 4aabd121..f900da53 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 2c8bc795..5e685218 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 e936a3bb..59ecb000 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 cf721420..a6b7938f 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 aaa92633..2ba453bd 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 7902f2fd..dd3719ff 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 af29b2fa..dd225bd6 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 23c3389c..45dc3823 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 1ae0264d..32ec0c0d 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 282a3f94..41bcc953 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 fd1c9cd2..593c78ab 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 f3a29198..2326f654 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 aa479250..260ac980 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 141dac8c..85ccf1d5 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 5d74ea31..57ece224 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 98bc6d8c..b8d0662d 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 fbb1e1f5..efa6267c 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 859d3f70..366183ed 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 3b8b9e8b..c2e4856d 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 210282b1..6528ed35 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/213] 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 2a6ddafa..c0b9a113 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/213] 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 e7e4cfc4..b2327c7f 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 ab407e0b..0721d711 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 54e37c76..4596bff7 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 1d6f6b35..df914fef 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 ff68112e..8d4b6f6a 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 631ca076..fbe80463 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 462c5b39..5f41ad2e 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 27ac8ee2..62fdab80 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 ad4becd1..a68064d4 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 fd72f40d..f5b6734f 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 af1f1b63..fdfe052e 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 000055b5..2d591f54 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 7097b79d..7b090716 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 38faed8f..e29b3040 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 f390a750..526818e3 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 ea6dde14..70cbbb3f 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 83c73c6b..695c161d 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 557ef5b3..533d4fd7 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 b407d7c6..ee4ab35f 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 16c3ace5..a4b8a877 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 a7157602..ae6f1b23 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 6c917826..f93fabc2 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 4b456fe9..16000019 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 fe3c83bd..8c1d4b02 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 fbb964a8..cde547fb 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 83ac96fc..72c029a7 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 9d022fad..eb80b527 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 a0d36eb2..354ca397 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 a0acab3e..e274271c 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 f0ad91aa..24023f25 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 59fcbfee..e9b637d0 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 3adc8bf0..4f33d703 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 57f5b55e..cfcc512f 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 570a7166..752b0d82 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 f91ea5ac..d168db59 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 8d306705..335e91e1 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 37562d54..3547ac71 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 ac43a2f5..dc9b3edc 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 f621a9ca..f8942898 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 30c0914e..7d413e61 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 434d9425..5d264802 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 463e5b2f..ef58b3fa 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 14cb8497..4db1388f 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 8abdf8c6..fd31e97a 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 d4510c2e..49a29ac5 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 63d9e0e5..1f347717 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 4bb5f207..5002f199 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 140b86d1..af16b8a1 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 5eb53686..e7bc9114 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 c196e52e..53752487 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 4cbb9fb3..df212222 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 c99fc476..bd0380b6 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 b2437344..fe763a56 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 284131cc..469a0d3d 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 65cf92ab..e89a238f 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 1ce3e838..cf779150 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 e051a6f7..e801bee7 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 c89a1607..7347d593 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 96f47f7a..e92ae573 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 f900da53..626f9daf 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 5e685218..08ca9093 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 59ecb000..a6f74220 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 a6b7938f..24127680 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 2ba453bd..d45b1e2a 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 dd3719ff..1a831413 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 dd225bd6..3e14616a 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 45dc3823..00914099 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 32ec0c0d..8804a15a 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 41bcc953..e25cbfd0 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 593c78ab..1f3b8ab6 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 2326f654..651ea3a3 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 260ac980..8c8c4dac 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 85ccf1d5..6aa64014 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 57ece224..ee56e258 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 b8d0662d..dd71f94c 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 efa6267c..83bc898e 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 366183ed..b255c290 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 c2e4856d..f8e1b1c0 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 6528ed35..7eacdb3f 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/213] 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 d90e3ae9..efecacf7 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/213] 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 34b4ad93..c9738efc 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 3dc21555..4cc8a9f1 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 aa839df1..8b87364c 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 14f109cf..7a646c66 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 041564aa..988f7da0 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 17026d49..72b7ed72 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 092f0b9e..7a3ad54e 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 87b0c819..a94abc26 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 c8a86769..275d1229 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 4f2e3d8b..f025bda7 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 d32978ee..c7a28f5d 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 bac5f59f..d56cac0e 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 87837884..b785755d 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 9a695479..d83a3df5 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 6f5e3ada..03620204 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/213] 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 c0b9a113..196892a1 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/213] 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 b2327c7f..ecba211a 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 0721d711..30b2bf58 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 4596bff7..9a625a9f 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 df914fef..f875f1bd 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 8d4b6f6a..8fc75421 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 fbe80463..cd96b838 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 5f41ad2e..7b522138 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 62fdab80..c17a32e3 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 a68064d4..2b0cb06c 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 f5b6734f..b9fff711 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 fdfe052e..c59c3913 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 2d591f54..072961a5 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 7b090716..9dbce54c 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 e29b3040..0ab11cab 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 526818e3..a3179b0c 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 70cbbb3f..32bd8ef3 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 695c161d..1749077e 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 533d4fd7..31b85682 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 ee4ab35f..a5e70cdb 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 a4b8a877..aa0441db 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 ae6f1b23..02960bb5 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 f93fabc2..d26d4dc8 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 16000019..28c7c68c 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 8c1d4b02..6f8b4a73 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 cde547fb..1a126c41 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 72c029a7..2a3882e5 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 eb80b527..a067f8bd 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 354ca397..0aac91fa 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 e274271c..365f14ee 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 24023f25..abc389d3 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 e9b637d0..43c50fbe 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 4f33d703..ea7bf455 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 cfcc512f..30b54aca 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 752b0d82..4a624eeb 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 d168db59..f1e83f6d 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 335e91e1..444b5854 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 3547ac71..dd35f1a2 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 dc9b3edc..b3290b37 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 f8942898..873b561b 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 7d413e61..7ea9d854 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 5d264802..f3b2a331 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 ef58b3fa..85bf086a 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 4db1388f..1f3375fa 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 fd31e97a..7f2a3450 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 49a29ac5..74ac3cb2 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 1f347717..d9545d2b 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 5002f199..8b31afb0 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 af16b8a1..ba80670f 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 e7bc9114..0cf08b9d 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 53752487..fa6acaf3 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 df212222..3a9bb357 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 bd0380b6..7b0dfc17 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 fe763a56..7e847f5b 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 469a0d3d..f4f2a437 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 e89a238f..870d0ac4 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 cf779150..98a235d5 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 e801bee7..4a04d32f 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 7347d593..ca77c070 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 e92ae573..b46b9f4e 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 626f9daf..96962a06 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 08ca9093..38d85a7c 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 a6f74220..237983c1 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 24127680..766577ef 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 d45b1e2a..95284961 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 1a831413..c18b3bd3 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 3e14616a..976f4f8c 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 00914099..1710a9e6 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 8804a15a..c4123280 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 e25cbfd0..52f2d184 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 1f3b8ab6..17feae81 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 651ea3a3..b423b093 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 8c8c4dac..23de7683 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 6aa64014..61f072a5 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 ee56e258..7adba860 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 dd71f94c..201ea314 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 83bc898e..9ce62b02 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 b255c290..3308a58b 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 f8e1b1c0..73dd6384 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 7eacdb3f..548f9451 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/213] 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 196892a1..9c55b877 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/213] 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 ecba211a..26a195fd 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 30b2bf58..6f6bdc78 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 9a625a9f..d8db1342 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 f875f1bd..99613e7a 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 8fc75421..498029b1 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 cd96b838..75db26a1 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 7b522138..3a80ad9e 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 c17a32e3..d1290f90 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 2b0cb06c..081f0177 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 b9fff711..ee8d9582 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 c59c3913..0308b3b9 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 072961a5..38e69838 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 9dbce54c..84518367 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 0ab11cab..549604a6 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 a3179b0c..417675b3 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 32bd8ef3..ed569121 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 1749077e..c91b86cd 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 31b85682..81efba20 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 a5e70cdb..0c6eb1b8 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 aa0441db..8466f6ee 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 02960bb5..6830887c 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 d26d4dc8..874a7fea 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 28c7c68c..66d4b612 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 6f8b4a73..d75b3293 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 1a126c41..a7095e97 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 2a3882e5..9d18acb3 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 a067f8bd..cc316dea 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 0aac91fa..6f478926 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 365f14ee..e087adae 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 abc389d3..b3febd2e 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 43c50fbe..0c92f671 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 ea7bf455..b5c5433f 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 30b54aca..78e0edc8 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 4a624eeb..0ba1e50d 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 f1e83f6d..30726d7a 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 444b5854..1370e8af 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 dd35f1a2..5a7e28bd 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 b3290b37..0c5209bd 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 873b561b..63001c68 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 7ea9d854..30c7fb17 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 f3b2a331..5be3d535 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 85bf086a..4cd04424 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 1f3375fa..39bee1ae 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 7f2a3450..d55ad47f 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 74ac3cb2..831faa86 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 d9545d2b..47d49bb5 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 8b31afb0..cdb26259 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 ba80670f..39291d8c 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 0cf08b9d..23c73c3e 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 fa6acaf3..129816a2 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 3a9bb357..80f08eb4 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 7b0dfc17..7aa131a5 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 7e847f5b..8ad81ba2 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 f4f2a437..4fadafc7 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 870d0ac4..0150993e 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 98a235d5..60c6a4a2 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 4a04d32f..7ac9b2f3 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 ca77c070..e01edc2f 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 b46b9f4e..c3b541f7 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 96962a06..f3044ed7 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 38d85a7c..39498e50 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 237983c1..07f4d9bb 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 766577ef..2eedc0a8 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 95284961..f908b79b 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 c18b3bd3..242fbd20 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 976f4f8c..f29a663c 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 1710a9e6..c3ba9ecf 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 c4123280..0f9f8cb5 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 52f2d184..706b0313 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 17feae81..3c28436d 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 b423b093..2a29c70a 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 23de7683..78170f3b 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 61f072a5..ff5f1104 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 7adba860..1a9da430 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 201ea314..dba4264e 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 9ce62b02..a7b6ef1c 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 3308a58b..30263415 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 73dd6384..89c98a54 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 548f9451..e6488b30 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/213] 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 9c55b877..ab3fa4b0 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/213] 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 26a195fd..615cb10a 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 6f6bdc78..67e5c6a8 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 d8db1342..8e6859ad 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 99613e7a..165c7241 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 498029b1..c3dd64f5 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 75db26a1..bc77ff06 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 3a80ad9e..6aded158 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 d1290f90..bff84e4f 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 081f0177..3ff42d69 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 ee8d9582..1b368171 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 0308b3b9..217295ed 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 38e69838..193f6f5b 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 84518367..123bd216 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 549604a6..3b0e8bd6 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 417675b3..0ca52fe0 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 ed569121..8bd34926 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 c91b86cd..11f91aee 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 81efba20..981f95cf 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 0c6eb1b8..df5d6931 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 8466f6ee..98555a9c 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 6830887c..bf027a07 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 874a7fea..0576adb6 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 66d4b612..db43b46f 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 d75b3293..b6bafbb0 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 a7095e97..be0fd364 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 9d18acb3..6775f332 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 cc316dea..48249675 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 6f478926..212e6210 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 e087adae..4e1820d4 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 b3febd2e..1213257a 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 0c92f671..1b44f648 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 b5c5433f..b8d2cd4c 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 78e0edc8..23b2b278 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 0ba1e50d..fd1d6c16 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 30726d7a..90983ea3 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 1370e8af..01e27160 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 5a7e28bd..69a35f48 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 0c5209bd..0ef0a454 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 63001c68..2a943131 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 30c7fb17..88d6035b 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 5be3d535..1ec16f59 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 4cd04424..d538e509 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 39bee1ae..297c5536 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 d55ad47f..3a382e75 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 831faa86..3f1b6b2d 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 47d49bb5..81d31533 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 cdb26259..0e26f911 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 39291d8c..190a04d1 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 23c73c3e..5231230d 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 129816a2..e6150115 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 80f08eb4..2be13068 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 7aa131a5..8b09b15e 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 8ad81ba2..68c7834c 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 4fadafc7..20233477 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 0150993e..2c5213c6 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 60c6a4a2..225ac5a5 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 7ac9b2f3..141d1628 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 e01edc2f..65d7f297 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 c3b541f7..ac223f9c 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 f3044ed7..ffd5c5d3 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 39498e50..4ed8a8cb 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 07f4d9bb..b818e280 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 2eedc0a8..b18208f9 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 f908b79b..fcfa5755 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 242fbd20..ec9a4cf4 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 f29a663c..16a32645 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 c3ba9ecf..6194e4d6 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 0f9f8cb5..bf0f7a41 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 706b0313..b42e89a1 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 3c28436d..4f05f610 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 2a29c70a..8d9457a5 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 78170f3b..690c2430 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 ff5f1104..3df3cc1a 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 1a9da430..b1437509 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 dba4264e..0be4e1c5 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 a7b6ef1c..a7f0e351 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 30263415..fd3f70c6 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 89c98a54..1097fdd0 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 e6488b30..49433b7b 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/213] 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 523a82c5..4f9d41e1 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/213] 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 ab3fa4b0..a51907c7 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/213] 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 615cb10a..5b93554e 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 67e5c6a8..a551e0b0 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 8e6859ad..d9c7fcfe 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 165c7241..cb025e0b 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 c3dd64f5..21955748 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 bc77ff06..394ddd77 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 6aded158..3e1f33e9 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 bff84e4f..ce5686a5 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 3ff42d69..2976e3a9 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 1b368171..fc84f904 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 217295ed..30e3abe4 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 193f6f5b..1b8d677b 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 123bd216..4810b554 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 3b0e8bd6..116065f6 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 0ca52fe0..fec7a86b 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 8bd34926..9f9a1983 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 11f91aee..dfb6fdc4 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 981f95cf..f0701ea0 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 df5d6931..098b9c44 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 98555a9c..559e9568 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 bf027a07..66d5659f 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 0576adb6..41d1d8f0 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 db43b46f..c43328de 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 b6bafbb0..2e84dd5b 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 be0fd364..a759fc5c 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 6775f332..bb5428e2 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 48249675..9f3be5b8 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 212e6210..e1cff430 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 4e1820d4..afbbda6e 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 1213257a..e16c75af 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 1b44f648..a1fdd8ba 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 b8d2cd4c..6b5073dd 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 23b2b278..a26c1ec7 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 fd1d6c16..9fcbb4fd 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 90983ea3..42dcf226 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 01e27160..93553e08 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 69a35f48..57abc224 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 0ef0a454..18a95cf0 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 2a943131..9bebf492 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 88d6035b..8900fe16 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 1ec16f59..e5babbb8 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 d538e509..d3d57537 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 297c5536..edd3ed1f 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 3a382e75..87d3f0e7 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 3f1b6b2d..ee50cd1f 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 81d31533..21d37996 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 0e26f911..80d00d44 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 190a04d1..26b7e6ea 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 5231230d..da72f0ac 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 e6150115..2ec9aa99 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 2be13068..06a4a802 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 8b09b15e..f26018b7 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 68c7834c..d80b1ad3 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 20233477..1dec74ba 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 2c5213c6..18d86376 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 225ac5a5..30d6799c 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 141d1628..78dc2896 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 65d7f297..2db43a0f 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 ac223f9c..c6d4f4b4 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 ffd5c5d3..2a7ee204 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 4ed8a8cb..4b56dced 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 b818e280..4c72ebc3 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 b18208f9..104a964d 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 fcfa5755..80636702 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 ec9a4cf4..1b68a059 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 16a32645..fd56ee87 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 6194e4d6..0c4fa193 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 bf0f7a41..929a6535 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 b42e89a1..3f60cd5a 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 4f05f610..79c379f2 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 8d9457a5..5a51bbf7 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 690c2430..4a99431c 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 3df3cc1a..5614765e 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 b1437509..6b5135d4 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 0be4e1c5..04615530 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 a7f0e351..46b6d3b1 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 fd3f70c6..bea5891d 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 1097fdd0..053518d9 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 49433b7b..3e022cc3 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/213] 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 a51907c7..3a3f28ed 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/213] 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 5b93554e..577a1e88 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 a551e0b0..78b017b2 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 d9c7fcfe..db94a037 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 cb025e0b..68e7fcee 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 21955748..9b2816cb 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 394ddd77..3a22eed4 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 3e1f33e9..1a0eab42 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 ce5686a5..7446b1de 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 2976e3a9..2baf7fb9 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 fc84f904..2437b0e5 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 30e3abe4..d4546fe8 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 1b8d677b..662f6d28 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 4810b554..ff8b0568 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 116065f6..2a73638b 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 fec7a86b..c775c133 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 9f9a1983..02842269 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 dfb6fdc4..63b4a54b 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 f0701ea0..f8a289db 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 098b9c44..fb95d2dc 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 559e9568..51d8e1ae 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 66d5659f..e7f9364a 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 41d1d8f0..99e1c3f8 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 c43328de..44c35364 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 2e84dd5b..fae12a73 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 a759fc5c..b851d465 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 bb5428e2..7f2136ff 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 9f3be5b8..01f82c33 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 e1cff430..ac97d383 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 afbbda6e..eb6ba68a 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 e16c75af..531c4828 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 a1fdd8ba..43ad5906 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 6b5073dd..2151374b 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 a26c1ec7..e9ec1f9e 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 9fcbb4fd..73a6256c 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 42dcf226..0250f17e 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 93553e08..02bf0d5e 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 57abc224..6ed01580 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 18a95cf0..d1ca42b4 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 9bebf492..12ad9431 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 8900fe16..81c81266 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 e5babbb8..9b9fabed 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 d3d57537..927d6d2e 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 edd3ed1f..6f64a0c3 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 87d3f0e7..157c580a 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 ee50cd1f..222cae76 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 21d37996..8fef8345 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 80d00d44..e336f1f3 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 26b7e6ea..3e75e6fd 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 da72f0ac..ddf7ca4d 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 2ec9aa99..b36c0b69 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 06a4a802..0a576b6e 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 f26018b7..4d78c3bb 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 d80b1ad3..217e5ffb 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 1dec74ba..253d48c9 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 18d86376..d9f789d9 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 30d6799c..4bcc7c2d 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 78dc2896..86435efb 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 2db43a0f..ff1fc255 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 c6d4f4b4..96e60695 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 2a7ee204..496f16b8 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 4b56dced..4cc3dfea 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 4c72ebc3..6646fca9 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 104a964d..77932b21 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 80636702..06bc18b3 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 1b68a059..9b607e33 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 fd56ee87..a6c82e06 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 0c4fa193..3e3c0c08 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 929a6535..dbc54638 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 3f60cd5a..af04584d 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 79c379f2..26a1092a 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 5a51bbf7..5725ddb3 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 4a99431c..bf4dbe8d 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 5614765e..2da9b407 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 6b5135d4..b55eb7cb 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 04615530..0246f4ce 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 46b6d3b1..b018ca4c 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 bea5891d..829d457f 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 053518d9..76a01f3a 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 3e022cc3..44824558 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/213] 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 3a3f28ed..32db5e77 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/213] 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 577a1e88..072c612c 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 78b017b2..0e81a1a9 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 db94a037..398c96ee 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 68e7fcee..8d3260e3 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 9b2816cb..d4d8721f 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 3a22eed4..2e8c21ab 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 1a0eab42..c8596060 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 7446b1de..bb559cbc 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 2baf7fb9..3dc5e4af 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 2437b0e5..356719d3 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 d4546fe8..91c7ad47 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 662f6d28..b96867d7 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 ff8b0568..0a972cbd 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 2a73638b..777a0fba 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 c775c133..e622fa6c 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 02842269..03d2c8ec 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 63b4a54b..c3313243 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 f8a289db..12d161fc 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 fb95d2dc..afcbc5ed 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 51d8e1ae..63c6e5b2 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 e7f9364a..6968fd89 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 99e1c3f8..574b61d4 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 44c35364..af7db87a 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 fae12a73..6088ccec 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 b851d465..8f349e18 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 7f2136ff..5656f20d 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 01f82c33..40e644b0 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 ac97d383..9d662908 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 eb6ba68a..71682df2 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 531c4828..408731fd 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 43ad5906..94ea1ad5 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 2151374b..5487db85 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 e9ec1f9e..f055fe06 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 73a6256c..9c178ab8 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 0250f17e..bcfaf0b5 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 02bf0d5e..98736469 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 6ed01580..1358224c 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 d1ca42b4..abe4218c 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 12ad9431..45cfa702 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 81c81266..e995c05d 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 9b9fabed..90dfb504 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 927d6d2e..5e5cad19 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 6f64a0c3..37ca38ef 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 157c580a..d858a3d0 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 222cae76..939631b9 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 8fef8345..32ca4e7b 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 e336f1f3..e54f762d 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 3e75e6fd..dc88b06a 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 ddf7ca4d..9d17ea21 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 b36c0b69..752ae6a9 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 0a576b6e..1cab1bb4 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 4d78c3bb..35dcf49d 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 217e5ffb..0b8d01dc 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 253d48c9..c1b349e7 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 d9f789d9..55e1b259 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 4bcc7c2d..fa9c2daf 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 86435efb..2d28827b 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 ff1fc255..06dbf156 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 96e60695..160ed06f 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 496f16b8..7ce21e3a 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 4cc3dfea..f751cffa 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 6646fca9..d025e277 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 77932b21..67cf6220 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 06bc18b3..d228070f 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 9b607e33..8ab890dc 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 a6c82e06..e393907d 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 3e3c0c08..b8a70cbb 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 dbc54638..e0ffb2cf 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 af04584d..f66b5caf 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 26a1092a..2d649b65 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 5725ddb3..200d8490 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 bf4dbe8d..76dda86a 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 2da9b407..ed5275ad 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 b55eb7cb..14d8c520 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 0246f4ce..2be3ab3b 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 b018ca4c..ccf08a2e 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 829d457f..e0193661 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 76a01f3a..57c64fb4 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 44824558..d4c4ae0e 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/213] 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 32db5e77..b77aabcb 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/213] 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 072c612c..b1da231e 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 0e81a1a9..5088e0be 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 398c96ee..03db7347 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 8d3260e3..7c96a613 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 d4d8721f..b828c3ff 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 2e8c21ab..dd587ec0 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 c8596060..c84be2ab 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 bb559cbc..12390ac8 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 3dc5e4af..5d7b511d 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 356719d3..b06bc6db 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 91c7ad47..44c2a1b9 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 b96867d7..e8da9105 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 0a972cbd..7bf3aa3f 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 777a0fba..48e8fce2 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 03d2c8ec..791005e9 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 574b61d4..e8049fe0 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 6088ccec..171028c7 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 8f349e18..915c84fd 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 5656f20d..0ec9b88f 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 40e644b0..63f0bac0 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 9d662908..b9e7f084 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 71682df2..b9958f1b 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 94ea1ad5..1bdd595f 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 5487db85..7021de14 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 f055fe06..542612c2 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 9c178ab8..269c052e 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 bcfaf0b5..e9cb574a 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 1358224c..961f9c9a 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 abe4218c..88f7d9f7 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 45cfa702..02731bb8 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 5e5cad19..61becf94 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 d858a3d0..79b3de12 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 939631b9..20a80d7f 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 32ca4e7b..e7a5cdcf 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 e54f762d..03b41580 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 dc88b06a..42309826 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 9d17ea21..95558f73 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 752ae6a9..3d83e579 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 1cab1bb4..2b747308 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 35dcf49d..8b254e6e 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 0b8d01dc..1e214825 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 c1b349e7..4bfb5baf 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 55e1b259..7b1e4c7b 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 fa9c2daf..ead3f202 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 2d28827b..7650e9f3 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 06dbf156..3432f47c 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 160ed06f..5a5296af 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 7ce21e3a..08c081e5 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 67cf6220..913509d1 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 d228070f..0fb60b43 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 8ab890dc..8a5dd62e 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 e393907d..f201c15b 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 b8a70cbb..97fa90d6 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 e0ffb2cf..f8a63e33 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 f66b5caf..9ba663a5 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 2d649b65..21d7dd4b 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 200d8490..0e65eb40 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 76dda86a..880f602e 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 ed5275ad..05c21380 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 14d8c520..bd9d3022 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 2be3ab3b..435ebf8b 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 ccf08a2e..97d502d5 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 e0193661..aa8c58f9 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 57c64fb4..1dbf7976 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/213] 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 b77aabcb..9b891191 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/213] 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 5088e0be..5518e664 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 03db7347..bfe0274b 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 7c96a613..a22064f5 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 b828c3ff..d486bb7e 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 12390ac8..161d0d5f 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 b06bc6db..68770fa7 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 44c2a1b9..204ea40b 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 e8da9105..475fa9ef 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 791005e9..91c3187e 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 e8049fe0..f9e666d5 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 171028c7..26bff913 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 915c84fd..62c6882b 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 0ec9b88f..db49d68f 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 63f0bac0..ca618d1e 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 b9e7f084..3d52bcd3 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 408731fd..880c9b46 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 7021de14..b7ec075f 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 542612c2..200c41fe 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 269c052e..487d0231 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 90dfb504..dabd3ead 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 61becf94..81d369a8 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 37ca38ef..cdf68387 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 3d83e579..6db44df8 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 8b254e6e..0ef55dad 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 4bfb5baf..d784e782 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 7b1e4c7b..3d47875e 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 8a5dd62e..b875e277 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 f8a63e33..cde0efbd 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 9ba663a5..6493a500 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 21d7dd4b..69313dbf 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 0e65eb40..f740efe5 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 05c21380..18cd7462 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 bd9d3022..06a04c71 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 435ebf8b..11a7ae72 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 97d502d5..5754e883 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/213] 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 9b891191..3d73b132 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/213] 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 5518e664..36678abb 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 bfe0274b..220f75c8 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 a22064f5..549303bd 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 d486bb7e..fe6398ed 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 161d0d5f..a06fbc8c 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 68770fa7..c2171771 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 204ea40b..71d8b610 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 475fa9ef..8d0d3706 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 91c3187e..be519b8b 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 f9e666d5..a937ee43 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 26bff913..2ef83b7a 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 62c6882b..835f196a 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 db49d68f..83a07ab3 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 ca618d1e..48ae389b 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 3d52bcd3..977271c1 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 880c9b46..88a6d4af 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 b7ec075f..e207159a 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 200c41fe..a11af391 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 487d0231..fd578910 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 dabd3ead..0fe9e3be 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 81d369a8..f9c4914f 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 cdf68387..612e545d 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 6db44df8..55802b0a 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 0ef55dad..c7fba379 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 d784e782..3e839e02 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 3d47875e..f1ad6ff2 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 b875e277..1c3c0fd1 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 cde0efbd..ee39f18f 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 6493a500..6f4e9fc0 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 69313dbf..02572883 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 f740efe5..4719bc46 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 18cd7462..3c49d5e6 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 06a04c71..1b58d713 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 11a7ae72..7a41f3e5 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 5754e883..bc66aa66 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/213] 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 00000000..05d1a512 --- /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/213] 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/213] 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 3d73b132..f6086a09 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/213] 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 e622fa6c..1900d8d8 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 c3313243..9e37a93f 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 79b3de12..d0342862 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 20a80d7f..c0dac551 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 42309826..b9bcc377 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 95558f73..c5d591d8 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 2b747308..3a80a2a3 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 3432f47c..77e8d850 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 5a5296af..82054d84 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/213] 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 f6086a09..e8fcf41b 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/213] 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 36678abb..d2f7b8d5 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 220f75c8..c244d9c1 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 549303bd..b3046915 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 fe6398ed..c20d1aa1 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 a06fbc8c..461fd348 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 c2171771..142f0c6c 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 71d8b610..ced0189c 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 8d0d3706..3c6e5bbb 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 1900d8d8..e622fa6c 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 be519b8b..bcb9eeb6 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 9e37a93f..c3313243 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 a937ee43..18395581 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 2ef83b7a..7f8db4f9 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 835f196a..c8da138e 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 83a07ab3..2244e87c 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 48ae389b..b21b2bf7 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 977271c1..f25426f5 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 88a6d4af..bb7fba2e 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 e207159a..97a49e4a 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 a11af391..a7dde3de 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 fd578910..c899909d 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 0fe9e3be..9c6ef95d 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 f9c4914f..ab272bc5 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 612e545d..29e7de01 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 d0342862..79b3de12 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 c0dac551..20a80d7f 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 b9bcc377..42309826 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 c5d591d8..95558f73 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 55802b0a..8b386fab 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 3a80a2a3..2b747308 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 c7fba379..6b46bed8 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 3e839e02..7919abe1 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 f1ad6ff2..5910f447 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 77e8d850..3432f47c 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 82054d84..5a5296af 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 1c3c0fd1..2f985269 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 ee39f18f..0fb9120b 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 6f4e9fc0..ba789057 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 02572883..c53165fe 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 4719bc46..d8f7a8ed 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 3c49d5e6..0bfd9b68 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 1b58d713..de71f977 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 7a41f3e5..55e9909c 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 bc66aa66..cf358ca3 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/213] 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 e8fcf41b..d60f3eb4 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/213] 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 d2f7b8d5..c0aabf9e 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 c244d9c1..4742fc29 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 b3046915..cf3379d3 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 c20d1aa1..de79090a 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 461fd348..17976422 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 142f0c6c..d334d815 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 ced0189c..786304b1 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 3c6e5bbb..e3fc186b 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 e622fa6c..3c220396 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 bcb9eeb6..2280c2cc 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 c3313243..8b063785 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 18395581..08bf2b4a 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 7f8db4f9..d0f49154 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 c8da138e..676cbf0c 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 2244e87c..b2e0c68b 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 b21b2bf7..31d2bb98 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 f25426f5..75d279dc 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 bb7fba2e..799da702 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 97a49e4a..dfec388a 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 a7dde3de..5baa6688 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 c899909d..19593bfd 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 9c6ef95d..7adc0c62 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 ab272bc5..a36e60ce 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 29e7de01..95763c24 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 79b3de12..db615175 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 20a80d7f..469fe91f 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 42309826..2fe1ea06 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 95558f73..ac25ab6b 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 8b386fab..429999f9 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 2b747308..cc163ae6 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 6b46bed8..eaf249be 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 7919abe1..4765be11 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 5910f447..70205962 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 3432f47c..b9b883d7 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 5a5296af..ac77e713 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 2f985269..09505928 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 0fb9120b..4ceed80b 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 ba789057..2a014615 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 c53165fe..308da9a3 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 d8f7a8ed..618542c1 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 0bfd9b68..cb503357 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 de71f977..dafdd263 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 55e9909c..b472a679 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 cf358ca3..ee10dadd 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/213] 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 d60f3eb4..b96bd981 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/213] 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 c0aabf9e..b3ab8046 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 4742fc29..1210df47 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 cf3379d3..29dd2fd5 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 de79090a..eee336a8 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 17976422..b216d3b9 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 d334d815..451b7e8f 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 786304b1..c827eb36 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 e3fc186b..4ec9aba3 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 3c220396..40bf195d 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 2280c2cc..fb3ee74f 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 8b063785..2135edfd 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 08bf2b4a..17c846eb 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 d0f49154..dec4f82d 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 676cbf0c..fd6d8a7f 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 b2e0c68b..97d44f27 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 31d2bb98..4bbe447a 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 75d279dc..5a441f3b 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 799da702..dac61d3f 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 dfec388a..f86a5e1e 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 5baa6688..f612e7d7 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 19593bfd..059943aa 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 7adc0c62..1401302a 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 a36e60ce..028de3f4 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 95763c24..9588d53b 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 db615175..ec35d365 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 469fe91f..daee3213 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 2fe1ea06..fa1a71ee 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 ac25ab6b..160878c1 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 429999f9..f4d2c2ed 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 cc163ae6..b076e900 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 eaf249be..07a6bf76 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 4765be11..6f257b13 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 70205962..5d2cab17 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 b9b883d7..397b7211 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 ac77e713..4490780d 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 09505928..1b39ad0b 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 4ceed80b..bae4ee8b 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 2a014615..f9a03775 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 308da9a3..7ceb091b 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 618542c1..029956af 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 cb503357..1b563607 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 dafdd263..e1d85dfc 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 b472a679..df7000f7 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 ee10dadd..ef32c204 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/213] 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 16e7e114..a17c6349 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/213] 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 78c99bd4..f7f0c9bc 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/213] 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 e0b72de2..6c7ddb1d 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/213] 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 59ffc89a..07dbb79f 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/213] 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 9c9fc7d9..cbaacc1f 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 00000000..7f4e746e --- /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/213] Update package.json --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index c4bb7937..29274306 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/213] 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 cbaacc1f..e2549c3c 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 c9738efc..cb4c2104 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 00000000..e669299e --- /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 00000000..4ae53a44 --- /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 00000000..e28b26d5 --- /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 00000000..e47a43f3 --- /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 00000000..f8b1666b --- /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 00000000..39a0898f --- /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 7f4e746e..b41bd2cf 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 00000000..81022b33 --- /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 00000000..c077faa7 --- /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 00000000..1b323196 --- /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 8b87364c..33e7787c 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 7a3ad54e..3b4d1384 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 5a441f3b..da145f73 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 f612e7d7..3d682f21 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 f4d2c2ed..69a10c9b 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 7908cdbc..20cdfa61 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/213] 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 07dbb79f..f27f7831 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/213] 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 e2549c3c..cdc7453d 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 00000000..da920c8e --- /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 00000000..986a9902 --- /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 00000000..e8883731 --- /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 00000000..459f0320 --- /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 00000000..26d89e75 --- /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 00000000..929cc5e7 --- /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/213] 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 b96bd981..96d9a9c3 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/213] 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 efecacf7..b9012d4e 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/213] 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 cb4c2104..f93ff24b 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 e669299e..7f046fd6 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 4ae53a44..3a755ffe 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 e28b26d5..56c56540 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 e47a43f3..b0494da7 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 f8b1666b..36d2e1ec 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 39a0898f..2572bc19 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 b41bd2cf..02bd1d35 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 81022b33..09baab9f 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 da920c8e..b2abd244 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 986a9902..31539d8f 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 e8883731..ec3831bc 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 459f0320..2f928002 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 26d89e75..bc5468e9 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 929cc5e7..d38dbe54 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 c077faa7..8b8d180a 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 1b323196..780ffb12 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 4cc8a9f1..a27e8d9e 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 b1da231e..11032ebe 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 b3ab8046..001f7cca 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 1210df47..6f0a7b0b 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 29dd2fd5..e009539e 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 eee336a8..db96671f 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 dd587ec0..52147bfb 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 33e7787c..c4e4fda4 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 c84be2ab..7c5fc33a 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 b216d3b9..26cfbd10 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 5d7b511d..ce83a8a9 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 451b7e8f..95303099 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 c827eb36..f7d65809 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 4ec9aba3..8db8b9f7 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 7bf3aa3f..54a4ce82 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 48e8fce2..cd788451 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 7a646c66..55d44e7d 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 40bf195d..84e4203c 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 fb3ee74f..e1ca8784 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 2135edfd..6b605685 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 988f7da0..91ad7fa2 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 12d161fc..18890afb 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 afcbc5ed..ffc0e0c2 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 63c6e5b2..39744681 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 6968fd89..a2c1b37d 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 72b7ed72..8fa6ae54 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 17c846eb..48fe3132 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 af7db87a..f8a80107 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 dec4f82d..4497c499 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 fd6d8a7f..e504d3f9 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 3b4d1384..315b06bc 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 97d44f27..95a29243 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 4bbe447a..6b61b8ad 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 da145f73..b83d3e20 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 a94abc26..2100c9ca 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 b9958f1b..b5b79ab7 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 dac61d3f..48195339 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 1bdd595f..88298d79 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 f86a5e1e..120975ea 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 3d682f21..87dd3803 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 059943aa..331ed6f0 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 e9cb574a..5dd8cb40 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 98736469..72e45d0a 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 961f9c9a..4d3a0b1b 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 88f7d9f7..0aae7e49 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 02731bb8..fc86716f 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 275d1229..ecd8fcad 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 e995c05d..a7056241 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 1401302a..91af6658 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 028de3f4..7d0d910c 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 f025bda7..f4020549 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 9588d53b..37311101 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 c7a28f5d..ed509331 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 ec35d365..4e88b8d7 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 daee3213..4ea32110 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 e7a5cdcf..478ba4cd 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 03b41580..ac0bd055 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 fa1a71ee..5ef09c8b 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 160878c1..ead85e94 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 69a10c9b..85d1965a 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 b076e900..9f9a965c 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 d56cac0e..93268b94 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 07a6bf76..68df8dcd 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 1e214825..246ff49d 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 6f257b13..87a8feac 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 5d2cab17..f40cba24 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 ead3f202..e3346e4f 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 7650e9f3..71e7be44 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 397b7211..c93a0f8e 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 4490780d..7168d105 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 08c081e5..6bdf1995 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 b785755d..b05e76fe 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 f751cffa..f5ac112d 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 d025e277..8b85f7ae 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 913509d1..8c932862 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 d83a3df5..07581d70 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 0fb60b43..c7d00df7 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 1b39ad0b..c6c2e587 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 f201c15b..7e785366 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 03620204..24c7d68f 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 97fa90d6..8dbc6e67 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 bae4ee8b..b5baf439 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 f9a03775..2e02b314 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 7ceb091b..ad31295c 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 029956af..bca89650 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 880f602e..f5f8692d 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 1b563607..c132c6d1 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 e1d85dfc..61553ab7 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 df7000f7..f17c19c9 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 ef32c204..987fd3c1 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 aa8c58f9..7fa26db2 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 1dbf7976..5a68d654 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 d4c4ae0e..5608497f 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/213] 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 c3358393..5d829d42 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/213] 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 f93ff24b..7ee0fe7f 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 b2abd244..b225bb5b 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 a27e8d9e..3254596c 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 c4e4fda4..5dd241a5 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 55d44e7d..eaac7cff 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 8fa6ae54..b40939df 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 315b06bc..ab058755 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 2100c9ca..9da26a0f 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 ecd8fcad..7d3d2031 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 93268b94..c9138a0d 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 07581d70..80877707 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 24c7d68f..088cc75a 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/213] 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 96d9a9c3..e452d335 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/213] 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 5d829d42..43e4b63d 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/213] 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 7ee0fe7f..9bfc9a9a 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 7f046fd6..75c96808 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 3a755ffe..b17be2cd 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 56c56540..91a8afa9 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 b0494da7..9f8a8bc4 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 36d2e1ec..63cceafb 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 2572bc19..7e893471 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 09baab9f..cfb38133 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 b225bb5b..5a0b3c00 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 31539d8f..d2cbadc1 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 ec3831bc..76fc64bd 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 2f928002..d7e4340b 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 bc5468e9..24579999 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 d38dbe54..f77ab5ec 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 8b8d180a..c28cbb96 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 780ffb12..2c445aa3 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 3254596c..5577680b 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 11032ebe..bfef2cb8 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 001f7cca..1ee1cd8d 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 6f0a7b0b..a003e034 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 e009539e..4f7fafe9 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 db96671f..f06f3f1a 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 52147bfb..f77f10e0 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 5dd241a5..8e9c4cc2 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 7c5fc33a..dc48f020 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 26cfbd10..3ca683d7 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 ce83a8a9..dcc81597 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 95303099..a3c6713d 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 f7d65809..41a9f3ce 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 8db8b9f7..977ef4c0 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 54a4ce82..286bc966 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 cd788451..02d4a3b4 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 eaac7cff..04e45bbc 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 84e4203c..0e90df8f 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 e1ca8784..cd4f4fee 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 6b605685..5937dce6 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 18890afb..abe2f24f 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 ffc0e0c2..27de9633 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 39744681..dc990dac 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 a2c1b37d..a7730580 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 b40939df..61dab062 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 48fe3132..afd887cc 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 f8a80107..9055e72a 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 4497c499..cacb8641 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 e504d3f9..f6883c87 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 ab058755..bce9c2a0 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 95a29243..bfa5678e 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 6b61b8ad..428cfc36 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 b83d3e20..77370833 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 9da26a0f..8c7c5cc6 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 b5b79ab7..4fa4640a 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 48195339..cbda5546 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 88298d79..4adc345e 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 120975ea..b2b935ce 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 87dd3803..67ed974f 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 331ed6f0..6e10144e 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 5dd8cb40..8d3f7b22 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 72e45d0a..230c79d1 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 4d3a0b1b..647940a7 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 0aae7e49..7d84c1b1 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 fc86716f..61b92786 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 7d3d2031..dddb2f04 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 a7056241..fe1d6378 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 91af6658..4d24484f 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 7d0d910c..9f162ab5 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 37311101..81d34168 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 4e88b8d7..54436d3e 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 4ea32110..83559ff2 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 478ba4cd..22470135 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 ac0bd055..53591113 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 5ef09c8b..de7b5ba2 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 ead85e94..fa95ea14 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 85d1965a..28e58c68 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 9f9a965c..58e1c47a 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 c9138a0d..2a4eecb2 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 68df8dcd..b7b64032 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 246ff49d..bfb5793f 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 87a8feac..68fbd4c1 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 f40cba24..c1e31a04 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 e3346e4f..2735b273 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 71e7be44..4a508164 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 c93a0f8e..fe8803fb 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 7168d105..630be5ed 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 6bdf1995..1ab12b9e 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 f5ac112d..2dbaf329 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 8b85f7ae..83648595 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 8c932862..f953e475 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 80877707..5a0d6606 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 c7d00df7..32814cd9 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 c6c2e587..45fd57f0 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 7e785366..9034d628 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 088cc75a..e5a41978 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 8dbc6e67..d05652ca 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 b5baf439..9cebf0c6 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 2e02b314..fbdf02df 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 ad31295c..c21d728e 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 bca89650..b6f62027 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 f5f8692d..c2ceadaa 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 c132c6d1..4c711587 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 61553ab7..e18661c6 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 f17c19c9..6a920e90 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 987fd3c1..9081b2aa 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 7fa26db2..b4d1f737 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 5a68d654..96fb7471 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 5608497f..b0ea1049 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/213] 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 e452d335..a71d7a2e 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/213] 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 75c96808..99a95810 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 b17be2cd..24ccd57b 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 91a8afa9..42e681db 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 9f8a8bc4..4df116ef 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 63cceafb..08f5d4c6 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 7e893471..d591f8ac 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 cfb38133..2a646207 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 d2cbadc1..6059a284 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 76fc64bd..a00d19d0 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 d7e4340b..937aa754 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 24579999..20555d1e 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 f77ab5ec..e791d3eb 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 c28cbb96..7275f5ba 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 2c445aa3..71661dc5 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 bfef2cb8..f04abb1b 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 1ee1cd8d..0c2634f0 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 a003e034..5caec58f 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 4f7fafe9..4e284a7b 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 f06f3f1a..29346736 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 f77f10e0..0103e1d4 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 dc48f020..8085593d 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 3ca683d7..db755709 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 dcc81597..f28a435e 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 a3c6713d..43d2576e 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 41a9f3ce..e89fbbb2 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 977ef4c0..61ca453d 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 286bc966..ad621d0d 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 02d4a3b4..56a7a199 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 0e90df8f..febe43f7 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 cd4f4fee..367f0dc6 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 5937dce6..550fa1d6 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 abe2f24f..7f7f73bf 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 27de9633..62f02e6c 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 dc990dac..c78edccb 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 a7730580..34e66a5d 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 afd887cc..fd3a2ebd 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 9055e72a..8afb4d73 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 cacb8641..938a4d88 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 f6883c87..f4c76b06 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 bfa5678e..fab3ed3f 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 428cfc36..70d2328a 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 77370833..1e762056 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 4fa4640a..5e8d89d7 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 cbda5546..f822f32c 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 4adc345e..c38ac12b 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 b2b935ce..5df6c7cc 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 67ed974f..363ac974 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 6e10144e..fe10bd88 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 8d3f7b22..05b285d0 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 230c79d1..1177b6da 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 647940a7..1338c53d 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 7d84c1b1..a4405d93 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 61b92786..a2747f54 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 fe1d6378..52061c06 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 4d24484f..10b4e534 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 9f162ab5..f9049e27 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 81d34168..bd31e423 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 54436d3e..6026610f 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 83559ff2..5c45962d 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 22470135..445063a2 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 53591113..7df02082 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 de7b5ba2..4ebe4bf9 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 fa95ea14..b91f936e 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 28e58c68..e3487d52 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 58e1c47a..1b80084f 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 b7b64032..a1d8cf47 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 bfb5793f..c90a71f0 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 68fbd4c1..3bebf138 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 c1e31a04..e6021e16 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 2735b273..f81f8796 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 4a508164..940ea607 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 fe8803fb..ae5c810a 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 630be5ed..0ef153c2 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 1ab12b9e..a3c480d2 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 2dbaf329..b493e370 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 83648595..4fee38b7 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 f953e475..41430ea2 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 32814cd9..2de97510 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 45fd57f0..1d5754cd 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 9034d628..93e37045 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 d05652ca..fb6f6d5d 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 9cebf0c6..8bba7473 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 fbdf02df..1a7c45e3 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 c21d728e..dc3471b8 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 b6f62027..ab67457b 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 c2ceadaa..62cc6480 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 4c711587..25b8218f 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 e18661c6..a695777f 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 6a920e90..e1f8bce3 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 9081b2aa..90f3ee5d 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 b4d1f737..d07b2bdc 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 96fb7471..e0569d76 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 b0ea1049..8957b147 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/213] 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 a71d7a2e..5b01bfeb 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/213] 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 99a95810..0432b6cd 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 24ccd57b..fabe8e6d 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 42e681db..06edcd71 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 4df116ef..8e714f7c 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 08f5d4c6..02fecad2 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 d591f8ac..4589a1b6 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 2a646207..5a3955f7 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 6059a284..8a4c878c 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 a00d19d0..1d4e9fbd 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 937aa754..0ba83dfc 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 20555d1e..52132421 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 e791d3eb..3db1bbc5 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 7275f5ba..97dccd3f 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 71661dc5..29d3e1ae 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 f04abb1b..84f2fe7d 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 0c2634f0..dd978441 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 5caec58f..6594896c 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 4e284a7b..e954b77b 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 29346736..1dcbbeee 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 0103e1d4..7b080a64 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 8085593d..d21666ed 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 db755709..dca48012 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 f28a435e..613ba13e 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 43d2576e..6c005bad 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 e89fbbb2..8e21e411 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 61ca453d..ebd6f3a7 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 ad621d0d..232e6131 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 56a7a199..6cb30930 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 febe43f7..2bdbf254 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 367f0dc6..a893ed9d 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 550fa1d6..14489749 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 7f7f73bf..f716d687 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 62f02e6c..78083d80 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 c78edccb..0e6fe977 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 34e66a5d..85559210 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 fd3a2ebd..a89d035a 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 8afb4d73..9a883b84 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 938a4d88..8ddeeca8 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 f4c76b06..b5e559de 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 fab3ed3f..6d494899 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 70d2328a..abdf608f 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 1e762056..2011f08f 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 5e8d89d7..01ac90f6 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 f822f32c..54cd0c12 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 c38ac12b..21710c68 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 5df6c7cc..6a9674a3 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 363ac974..2d087359 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 fe10bd88..4628c631 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 05b285d0..b1b001a4 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 1177b6da..783638a6 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 1338c53d..90ea6092 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 a4405d93..833d5200 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 a2747f54..2e06e0c0 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 52061c06..a1c740e0 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 10b4e534..3ff4e217 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 f9049e27..4109ea0e 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 bd31e423..44b5453d 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 6026610f..40d62c12 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 5c45962d..d5b71cc2 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 445063a2..e940c9f7 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 7df02082..d3fd8940 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 4ebe4bf9..144c757a 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 b91f936e..6b578fac 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 e3487d52..79dc93a5 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 1b80084f..07c8fb23 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 a1d8cf47..8f3e74be 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 c90a71f0..e4c19fb9 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 3bebf138..5dced04f 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 e6021e16..6c6cfea7 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 f81f8796..7ec5eac5 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 940ea607..c6305367 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 ae5c810a..3bbd2298 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 0ef153c2..55b896d2 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 a3c480d2..58ba1357 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 b493e370..f4ab0f76 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 4fee38b7..179fa7a2 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 41430ea2..4d20bf4e 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 2de97510..0e736e9d 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 1d5754cd..b265d96c 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 93e37045..9e0ee45e 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 fb6f6d5d..a848616f 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 8bba7473..cfa601bc 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 1a7c45e3..1aceeccd 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 dc3471b8..4d433f02 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 ab67457b..906e92ab 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 62cc6480..f34a8324 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 25b8218f..ebc60705 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 a695777f..a2a409a2 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 e1f8bce3..a71ab740 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 90f3ee5d..58cdd93f 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 d07b2bdc..ab167cbd 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 e0569d76..82d2c2be 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 8957b147..aa35d105 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/213] 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 5b01bfeb..924cbe69 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/213] 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 0432b6cd..d07f7465 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 fabe8e6d..7b80ee57 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 06edcd71..beaf3fd4 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 8e714f7c..2c2198d8 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 02fecad2..69cc6b65 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 4589a1b6..7c4f0eda 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 5a3955f7..2745b916 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 8a4c878c..34efe9b9 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 1d4e9fbd..a840dc6c 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 0ba83dfc..d25a4458 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 52132421..c93335e9 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 3db1bbc5..3d8d9050 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 97dccd3f..8c61a1ae 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 29d3e1ae..b1a4ac8c 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 84f2fe7d..acdac2a2 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 dd978441..e1cfff54 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 6594896c..eba22b07 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 e954b77b..f06b3832 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 1dcbbeee..9716442a 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 7b080a64..c317315d 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 d21666ed..0ba2566b 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 dca48012..6d6e3563 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 613ba13e..45a73304 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 6c005bad..1a7ee668 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 8e21e411..4b704a96 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 ebd6f3a7..4b1b5dda 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 232e6131..690d076d 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 6cb30930..144edd1c 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 2bdbf254..86f277ed 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 a893ed9d..919c6bdf 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 14489749..3dac902f 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 f716d687..392a4bf9 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 78083d80..c31c357e 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 0e6fe977..b9b30175 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 85559210..329bc669 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 a89d035a..dd6ba6b5 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 9a883b84..7c3a1c3c 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 8ddeeca8..8205b2b8 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 b5e559de..17c454ee 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 6d494899..b1005de5 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 abdf608f..485db704 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 2011f08f..aa1ede31 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 01ac90f6..09800d0d 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 54cd0c12..cbb220ca 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 21710c68..2b9a35a3 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 6a9674a3..2167f7c0 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 2d087359..a626fd3c 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 4628c631..546652e3 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 b1b001a4..4b9c0bc0 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 783638a6..2f48ff27 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 90ea6092..fbcb1e1e 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 833d5200..f4a5ab2c 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 2e06e0c0..5b7eec9d 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 a1c740e0..a8dc05d8 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 3ff4e217..03861b76 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 4109ea0e..46c91c93 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 44b5453d..aef08afa 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 40d62c12..55c38555 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 d5b71cc2..1f0b23ae 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 e940c9f7..5a7bec7d 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 d3fd8940..91eb1a0a 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 144c757a..ae4c0f75 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 6b578fac..292b622e 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 79dc93a5..ef4a8a89 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 07c8fb23..5e30716c 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 8f3e74be..802678f6 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 e4c19fb9..128bbab6 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 5dced04f..f60e445d 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 6c6cfea7..4c1595f0 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 7ec5eac5..b76eecb7 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 c6305367..fff3431f 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 3bbd2298..f665e2b8 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 55b896d2..c92c9ceb 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 58ba1357..a54c2774 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 f4ab0f76..87d87848 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 179fa7a2..7cb6819d 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 4d20bf4e..27c49cca 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 0e736e9d..1d81f9cf 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 b265d96c..b130e304 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 9e0ee45e..a6b23c64 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 a848616f..59e6524c 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 cfa601bc..eae68776 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 1aceeccd..afe7e589 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 4d433f02..e530aaf1 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 906e92ab..cce95227 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 f34a8324..2f5cb625 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 ebc60705..72d93c4b 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 a2a409a2..4293bb5f 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 a71ab740..fc05115d 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 58cdd93f..42b99a99 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 ab167cbd..3239040a 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 82d2c2be..7f2ef5e5 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 aa35d105..41236bf2 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/213] 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 43e4b63d..5aff03f9 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/213] 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 9bfc9a9a..b1c6af0c 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 5a0b3c00..5780a379 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 5577680b..8a8ca638 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 8e9c4cc2..afa56b7d 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 04e45bbc..5d353b6e 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 61dab062..50dd5b02 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 bce9c2a0..cfdb42ea 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 8c7c5cc6..542975d9 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 dddb2f04..23bfd45a 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 2a4eecb2..13625c62 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 5a0d6606..01979a55 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 e5a41978..07f4cfaa 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/213] 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 924cbe69..2f3d2f4d 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/213] 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 2f3d2f4d..924cbe69 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/213] 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 5aff03f9..43e4b63d 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/213] 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 b1c6af0c..9bfc9a9a 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 5780a379..5a0b3c00 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 8a8ca638..5577680b 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 afa56b7d..8e9c4cc2 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 5d353b6e..04e45bbc 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 50dd5b02..61dab062 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 cfdb42ea..bce9c2a0 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 542975d9..8c7c5cc6 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 23bfd45a..dddb2f04 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 13625c62..2a4eecb2 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 01979a55..5a0d6606 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 07f4cfaa..e5a41978 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/213] 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 924cbe69..9c0e9502 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/213] 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 d07f7465..09590edc 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 7b80ee57..38c3807d 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 beaf3fd4..b7465f2c 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 2c2198d8..878e2dd0 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 69cc6b65..771b4491 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 7c4f0eda..48ff7116 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 2745b916..9dea2b84 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 34efe9b9..0bc7123c 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 a840dc6c..25eb0a93 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 d25a4458..53035d0f 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 c93335e9..439b309e 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 3d8d9050..a7fd10c5 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 8c61a1ae..92c7a07e 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 b1a4ac8c..358f7d78 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 acdac2a2..06960814 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 e1cfff54..efb8009c 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 eba22b07..a2092ee9 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 f06b3832..19fa4e62 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 9716442a..9872c0bd 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 c317315d..6d1f3860 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 0ba2566b..98b34886 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 6d6e3563..c440f996 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 45a73304..c177daf5 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 1a7ee668..99eb175a 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 4b704a96..5d0f8ac2 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 4b1b5dda..3551ec95 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 690d076d..a43b0dc0 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 144edd1c..48cd4022 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 86f277ed..40d544be 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 919c6bdf..71cdaa18 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 3dac902f..101d1744 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 392a4bf9..b14437d2 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 c31c357e..cf65a091 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 b9b30175..308d7023 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 329bc669..f3802da1 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 dd6ba6b5..ac234ca3 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 7c3a1c3c..eac8bc07 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 8205b2b8..d876b005 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 17c454ee..6925b7dd 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 b1005de5..ff3d211c 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 485db704..c63a7e00 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 aa1ede31..8e69f3bb 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 09800d0d..c4fc24a7 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 cbb220ca..e96b8353 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 2b9a35a3..59b00588 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 2167f7c0..2ee20bba 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 a626fd3c..77ee3e65 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 546652e3..acf99678 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 4b9c0bc0..650eb9d9 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 2f48ff27..62085c20 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 fbcb1e1e..8e261764 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 f4a5ab2c..cb3dd3a1 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 5b7eec9d..f5c046d0 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 a8dc05d8..8fc235f8 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 03861b76..41d463f9 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 46c91c93..3a029a3c 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 aef08afa..6d0b53df 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 55c38555..3df1aa21 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 1f0b23ae..561c6da7 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 5a7bec7d..bd0b9d70 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 91eb1a0a..eb486bb0 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 ae4c0f75..c73f8fa8 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 292b622e..05487869 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 ef4a8a89..444972c8 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 5e30716c..b1694690 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 802678f6..dad3ec77 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 128bbab6..46d7b729 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 f60e445d..f2032104 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 4c1595f0..9193dff8 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 b76eecb7..aad85566 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 fff3431f..61bdfc64 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 f665e2b8..81c4b3f7 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 c92c9ceb..6534646d 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 a54c2774..267d7904 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 87d87848..e8c78fb7 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 7cb6819d..b099bb24 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 27c49cca..99108d22 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 1d81f9cf..53b39085 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 b130e304..4caf008f 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 a6b23c64..e2fa9145 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 59e6524c..48027ddf 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 eae68776..918a1ae8 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 afe7e589..dadb77f3 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 e530aaf1..ef1924ec 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 cce95227..0b9ff750 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 2f5cb625..99292e17 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 72d93c4b..3e5861bd 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 4293bb5f..989b5602 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 fc05115d..a5d80fc9 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 42b99a99..f4a52b10 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 3239040a..8d4f0feb 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 7f2ef5e5..933386f0 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 41236bf2..d3075369 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